com.ibm.ecm.configuration

Interface ConfigInterface

All Known Implementing Classes:

GlobalConfig, PropertiesConfig, TenantConfig

public interface ConfigInterface

Since:

ICN 2.0.3.6

Method Summary

Modifier and Type	Method and Description
AccessRoleConfig	getAccessRoleConfig(java.lang.String applicationId, java.lang.String roleId) Get the AccessRoleConfig configuration object.
AdminRoleConfig	getAdminRoleConfig(java.lang.String applicationId, java.lang.String adminRoleId) Get the AdminRoleConfig configuration object.
ApplicationConfig	getApplicationConfig(javax.servlet.http.HttpServletRequest request) Get a application definition out of the request.
ApplicationConfig	getApplicationConfig(javax.servlet.http.HttpServletRequest request, java.lang.String defaultAppName) Get a application definition out of the request.
ApplicationConfig	getApplicationConfig(java.lang.String applicationId) Get the application configuration object.
CacheInterface	getCache()
org.apache.commons.configuration.AbstractConfiguration	getConfiguration() Return the configuration object back.
<T extends ConfigurationObject> T	getConfiguration(java.lang.Class<T> ConfigClass, java.lang.String idPrefix, java.lang.String id, boolean... flags) Check cache first for the configuration.
Config.CONFIGURATION_TYPE	getConfigurationType() Return configuration type back.
ConversionConfig	getConversionConfig(java.lang.String applicationId) Get the ConversionConfig configuration object.
java.lang.String	getDatabaseSchemaName(javax.servlet.ServletContext servletContext) Deprecated.
DataKeyConfig	getDataKeyConfig(java.lang.String keyId) Gets the DataKeyConfig configuration object.
org.apache.commons.configuration.AbstractConfiguration	getDefaultConfiguration() Return default configuration object.
<T extends ConfigurationObject> T	getDefaultConfiguration(java.lang.Class<T> ConfigClass, java.lang.String idPrefix, java.lang.String id, boolean... flags) Check cache first for the configuration.
java.lang.String	getDefaultDesktopName(javax.servlet.http.HttpServletRequest request) Static method to find the current default desktop name
IconConfig	getDefaultIconConfig(java.lang.String iconId) Get the default IconConfig configuration object.
DesktopAccessConfig	getDesktopAccessConfig(java.lang.String applicationId, java.lang.String id) Get the DesktopAccessConfig configuration object.
DesktopAdminAccessConfig	getDesktopAdminAccessConfig(java.lang.String applicationId, java.lang.String id) Get the DesktopAdminAccessConfig configuration object.
DesktopConfig	getDesktopConfig(javax.servlet.http.HttpServletRequest request) Get a desktop definition out of the request.
DesktopConfig	getDesktopConfig(java.lang.String applicationId, java.lang.String desktopId) Get the desktop configuration object.
DesktopFeatureConfig	getDesktopFeatureConfig(java.lang.String applicationId, java.lang.String id) Get the DesktopFeatureConfig configuration object.
DraftDesktopConfig	getDraftDesktopConfig(java.lang.String applicationId, java.lang.String desktopId) For internal use only.
EditServiceCategoryConfig	getEditServiceCategoryConfig(java.lang.String applicationId, java.lang.String id) Get the EditServiceCategoryConfig configuration object.
EdsConfig	getEdsConfig(java.lang.String applicationId) For internal use only.
EdsConfig	getEdsConfig(java.lang.String applicationId, java.lang.String id) For internal use only.
FavoriteConfig	getFavoriteConfig(java.lang.String applicationId, java.lang.String id) Get the FavoriteConfig configuration object.
FavoriteConfig	getFavoriteConfig(java.lang.String applicationId, java.lang.String id, boolean skipCaching) Get the FavoriteConfig configuration object.
FilenetConfig	getFilenetConfig(java.lang.String applicationId) Get the FilenetConfig configuration object.
FilenetConfig	getFilenetConfig(java.lang.String applicationId, java.lang.String id) Get the FilenetConfig configuration object.
FileTypeConfig	getFileTypeConfig(java.lang.String applicationId, java.lang.String fileType) Get the FileTypeConfig configuration object.
IconConfig	getIconConfig(java.lang.String applicationId, java.lang.String iconId) Get the IconConfig configuration object.
IconStatusConfig	getIconStatusConfig(java.lang.String applicationId, java.lang.String iconId) Get the IconStatusConfig configuration object.
IdLabelConfig	getIdLabelConfig(java.lang.String applicationId, java.lang.String id) Get the IdLabelConfig configuration object.
InterfaceTextConfig	getInterfaceTextConfig(java.lang.String applicationId, java.lang.String interfaceTextId) Get the InterfaceTextConfig configuration object.
InterfaceTextLocaleConfig	getInterfaceTextLocaleConfig(java.lang.String applicationId, java.lang.String interfaceTextId) Get the InterfaceTextLocaleConfig configuration object.
java.lang.String	getJDBCVersion() Deprecated.
LocaleConfig	getLocaleConfig(java.lang.String applicationId, java.lang.String id) Get the LocaleConfig configuration object.
MenuConfig	getMenuConfig(java.lang.String applicationId, java.lang.String menuId, boolean... flags) Get the MenuConfig configuration object.
MenuTypeConfig	getMenuTypeConfig(java.lang.String applicationId, java.lang.String menuTypeId, boolean... flags) Get the MenuTypeConfig configuration object.
MobileFeatureConfig	getMobileFeatureConfig(java.lang.String applicationId, java.lang.String id) Get the MobileFeatureConfig configuration object.
java.util.Map<java.lang.String,OAuthTokenConfig>	getOAuthTokenMap(javax.servlet.http.HttpServletRequest request) Get the OAuthTokenMap corresponding to the current desktop session user.
ODLoginConfig	getODLoginConfig(java.lang.String applicationId, java.lang.String repositoryId) Get the ODLoginConfig configuration object.
OfficeCustomCommandConfig	getOfficeCustomCommandConfig(java.lang.String applicationId, java.lang.String id)
OfficeOnlineTokenConfig	getOfficeOnlineTokenConfig(java.lang.String applicationId, java.lang.String userId) Get the OfficeOnlineTokenConfig configuration object.
PluginConfig	getPluginConfig(java.lang.String applicationId, java.lang.String pluginId) Get the PluginConfig configuration object.
PluginUserConfig	getPluginUserConfig(java.lang.String applicationId, java.lang.String userId, java.lang.String pluginId, java.lang.String key) Get the PluginUserConfig configuration object by combined userId, pluginId and key as ID
PropertyMappingConfig	getPropertyMappingConfig(java.lang.String applicationId, java.lang.String id) Get the PropertyMappingConfig configuration object.
RecentContentConfig	getRecentContentConfig(java.lang.String applicationId, java.lang.String id) Get the RecentContentConfig configuration object.
RecentItemConfig	getRecentItemConfig(java.lang.String applicationId, java.lang.String id) Get the RecentItemConfig configuration object.
RecentSearchConfig	getRecentSearchConfig(java.lang.String applicationId, java.lang.String id) Get the RecentSearchConfig configuration object.
RecentSimpleSearchConfig	getRecentSimpleSearchConfig(java.lang.String applicationId, java.lang.String id) Get the RecentSimpleSearchConfig configuration object.
RecentTeamspaceConfig	getRecentTeamspaceConfig(java.lang.String applicationId, java.lang.String id) Get the RecentTeamspaceConfig configuration object.
RedactionReasonConfig	getRedactionReasonConfig(java.lang.String applicationId, java.lang.String redactionReasonId) Get the RedactionReasonConfig configuration object.
RedactionReasonUsageConfig	getRedactionReasonUsageConfig(java.lang.String applicationId, java.lang.String redactionReasonId, java.lang.String dcAppName)
RepositoryConfig	getRepositoryConfig(javax.servlet.http.HttpServletRequest request) Get a repository definition out of the desktop definitions.
RepositoryConfig	getRepositoryConfig(java.lang.String applicationId, java.lang.String repositoryId) Get the RepositoryConfig configuration object.
RepositoryConfig	getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request) Does this desktop has this repository in it.
RepositoryConfig	getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request, java.lang.String repositoryId) Get a repository definition out of the desktop definitions.
ServerConfig	getServerConfig(javax.servlet.http.HttpServletRequest request) Get a server definition out of the repository definitions.
ServerConfig	getServerConfig(java.lang.String applicationId, java.lang.String serverId) Get the ServerConfig configuration object.
byte[]	getSessionKey()
SettingsConfig	getSettingsConfig(javax.servlet.http.HttpServletRequest request) Get the SettingsConfig configuration object.
SettingsConfig	getSettingsConfig(java.lang.String applicationId) Get the SettingsConfig configuration object.
SettingsConfig	getSettingsConfig(java.lang.String applicationId, boolean... flags) Get the SettingsConfig configuration object.
SettingsConfig	getSettingsConfig(java.lang.String applicationId, java.lang.String id) Get the SettingsConfig configuration object.
SettingsConfig	getSettingsConfig(java.lang.String applicationId, java.lang.String id, boolean... flags) Get the SettingsConfig configuration object.
SyncConfig	getSyncConfig(java.lang.String applicationId) Get the SyncConfig configuration object.
SyncItemConfig	getSyncItemConfig(java.lang.String applicationId, java.lang.String id) Get the SyncItemConfig configuration object.
SyncItemConfig	getSyncItemConfig(java.lang.String applicationId, java.lang.String id, boolean skipCaching) Get the SyncItemConfig configuration object.
TenantRegistrationConfig	getTenantRegistrationConfig(java.lang.String tenantId) Get the registration information for a tenant
ThemeConfig	getThemeConfig(java.lang.String applicationId, java.lang.String themeId) Get the ThemeConfig configuration object.
UserActionMacroConfig	getUserActionMacroConfig(java.lang.String applicationId, java.lang.String userAction) Get the UserActionMacroConfig configuration object.
UserConfig	getUserConfig(javax.servlet.http.HttpServletRequest request) Get the UserConfig configuration object for the current desktop session user.
UserConfig	getUserConfig(java.lang.String applicationId, java.lang.String userId) Get the UserConfig configuration object.
UserGroupConfig	getUserGroupConfig(java.lang.String applicationId, java.lang.String id) Get the UserGroupConfig configuration object.
ViewerConfig	getViewerConfig(java.lang.String applicationId, java.lang.String viewerId) Get the ViewerConfig configuration object.
ViewerDefConfig	getViewerDefConfig(java.lang.String applicationId, java.lang.String viewerDefId) Get the ViewerDefConfig configuration object.
ViewerMappingConfig	getViewerMappingConfig(java.lang.String applicationId, java.lang.String viewerMappingId) Get the ViewerMappingConfig configuration object.
ViewOneConfig	getViewOneConfig(java.lang.String applicationId) Get the ViewOneConfig configuration object.
ViewOneConfig	getViewOneConfig(java.lang.String applicationId, java.lang.String id) Get the ViewOneConfig configuration object.
boolean	hasRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request, java.lang.String repositoryId) Does this desktop has this repository in it.
boolean	removeConfigurationFromCache(ConfigurationObject config) Remove configuration object from the DB/Properties.
void	setDefaultHelpURL(SettingsConfig settingsConfig)
void	setSessionKey(byte[] sessionKey)

Method Detail

getConfigurationType

Config.CONFIGURATION_TYPE getConfigurationType()

Return configuration type back.

Returns:

a enum of either properties or database

getDatabaseSchemaName

@Deprecated
java.lang.String getDatabaseSchemaName(javax.servlet.ServletContext servletContext)

Deprecated.

Return DB schema name.

Parameters:

servletContext - - a ServletContext object.

Returns:

DB schema name.

getJDBCVersion

@Deprecated
java.lang.String getJDBCVersion()

Deprecated.

Get the JDBC version

Returns:

JDBC version number from the DB connection object.

getCache

CacheInterface getCache()

Returns:

Since:

ICN 2.0.3.5

getSessionKey

byte[] getSessionKey()

Returns:

Since:

ICN 2.0.3.6

setSessionKey

void setSessionKey(byte[] sessionKey)

Parameters:

sessionKey -

Since:

ICN 2.0.3.6

getConfiguration

org.apache.commons.configuration.AbstractConfiguration getConfiguration()

Return the configuration object back.

Returns:

a Apache configuration object.

getConfiguration

<T extends ConfigurationObject> T getConfiguration(java.lang.Class<T> ConfigClass,
                                                   java.lang.String idPrefix,
                                                   java.lang.String id,
                                                   boolean... flags)
                                            throws org.apache.commons.configuration.ConfigurationException,
                                                   MissingValueException

Check cache first for the configuration. If not found create one and store in the cache.

Parameters:

ConfigClass - of configuration object that extends ConfigurationObject (ApplicationConfig, ViewerMappingConfig...)

id - used to retrieve configuration object from cache using key based on class name + "." + id;

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDefaultConfiguration

org.apache.commons.configuration.AbstractConfiguration getDefaultConfiguration()

Return default configuration object.

Returns:

a Apache configuration object.

getDefaultConfiguration

<T extends ConfigurationObject> T getDefaultConfiguration(java.lang.Class<T> ConfigClass,
                                                          java.lang.String idPrefix,
                                                          java.lang.String id,
                                                          boolean... flags)
                                                   throws org.apache.commons.configuration.ConfigurationException,
                                                          MissingValueException

Check cache first for the configuration. If not found create one and store in the cache.

Parameters:

ConfigClass - of configuration object that extends ConfigurationObject (ApplicationConfig, ViewerMappingConfig...)

id - used to retrieve configuration object from cache using key based on class name + "." + id;

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getAccessRoleConfig

AccessRoleConfig getAccessRoleConfig(java.lang.String applicationId,
                                     java.lang.String roleId)
                              throws org.apache.commons.configuration.ConfigurationException,
                                     MissingValueException

Get the AccessRoleConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

roleId - - A string value of id

Returns:

a AccessRoleConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getApplicationConfig

ApplicationConfig getApplicationConfig(java.lang.String applicationId)
                                throws org.apache.commons.configuration.ConfigurationException,
                                       MissingValueException

Get the application configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

Returns:

a application configuration object

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getApplicationConfig

ApplicationConfig getApplicationConfig(javax.servlet.http.HttpServletRequest request)

Get a application definition out of the request.

Parameters:

request - - A HttpServletRequest object.

Returns:

a ApplicationConfig configuration object.

getApplicationConfig

ApplicationConfig getApplicationConfig(javax.servlet.http.HttpServletRequest request,
                                       java.lang.String defaultAppName)

Get a application definition out of the request.

Parameters:

request - - A HttpServletRequest object.

defaultAppName - - The default application name to use if the application name is not found in the request (optional).

Returns:

a ApplicationConfig configuration object.

getDefaultIconConfig

IconConfig getDefaultIconConfig(java.lang.String iconId)
                         throws org.apache.commons.configuration.ConfigurationException,
                                MissingValueException

Get the default IconConfig configuration object.

Parameters:

iconId - - A string value of id

Returns:

a IconConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDesktopAccessConfig

DesktopAccessConfig getDesktopAccessConfig(java.lang.String applicationId,
                                           java.lang.String id)
                                    throws org.apache.commons.configuration.ConfigurationException,
                                           MissingValueException

Get the DesktopAccessConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a DesktopAccessConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.2

getDesktopAdminAccessConfig

DesktopAdminAccessConfig getDesktopAdminAccessConfig(java.lang.String applicationId,
                                                     java.lang.String id)
                                              throws org.apache.commons.configuration.ConfigurationException,
                                                     MissingValueException

Get the DesktopAdminAccessConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a DesktopAdminAccessConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

3.0.3

getDesktopConfig

DesktopConfig getDesktopConfig(javax.servlet.http.HttpServletRequest request)

Get a desktop definition out of the request.

Parameters:

request - - A HttpServletRequest object.

Returns:

a DesktopConfig configuration object.

getDesktopConfig

DesktopConfig getDesktopConfig(java.lang.String applicationId,
                               java.lang.String desktopId)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Get the desktop configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

desktopId - - A string value of desktop id.

Returns:

a desktop configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDraftDesktopConfig

DraftDesktopConfig getDraftDesktopConfig(java.lang.String applicationId,
                                         java.lang.String desktopId)
                                  throws org.apache.commons.configuration.ConfigurationException,
                                         MissingValueException

For internal use only.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getFavoriteConfig

FavoriteConfig getFavoriteConfig(java.lang.String applicationId,
                                 java.lang.String id)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the FavoriteConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a FavoriteConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getFavoriteConfig

FavoriteConfig getFavoriteConfig(java.lang.String applicationId,
                                 java.lang.String id,
                                 boolean skipCaching)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the FavoriteConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a FavoriteConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getFilenetConfig

FilenetConfig getFilenetConfig(java.lang.String applicationId)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Get the FilenetConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

Returns:

a FilenetConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3

getFilenetConfig

FilenetConfig getFilenetConfig(java.lang.String applicationId,
                               java.lang.String id)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Get the FilenetConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a FilenetConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3

getConversionConfig

ConversionConfig getConversionConfig(java.lang.String applicationId)
                              throws org.apache.commons.configuration.ConfigurationException,
                                     MissingValueException

Get the ConversionConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

Returns:

a ConversionConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

3.0.5.3

getFileTypeConfig

FileTypeConfig getFileTypeConfig(java.lang.String applicationId,
                                 java.lang.String fileType)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the FileTypeConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

fileType - - A string value of filetype id

Returns:

a FileTypeConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDefaultDesktopName

java.lang.String getDefaultDesktopName(javax.servlet.http.HttpServletRequest request)
                                throws org.apache.commons.configuration.ConfigurationException,
                                       MissingValueException

Static method to find the current default desktop name

Parameters:

request -

Returns:

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDesktopFeatureConfig

DesktopFeatureConfig getDesktopFeatureConfig(java.lang.String applicationId,
                                             java.lang.String id)
                                      throws org.apache.commons.configuration.ConfigurationException,
                                             MissingValueException

Get the DesktopFeatureConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a DesktopFeatureConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3

getIconConfig

IconConfig getIconConfig(java.lang.String applicationId,
                         java.lang.String iconId)
                  throws org.apache.commons.configuration.ConfigurationException,
                         MissingValueException

Get the IconConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

iconId - - A string value of id

Returns:

a IconConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getIconStatusConfig

IconStatusConfig getIconStatusConfig(java.lang.String applicationId,
                                     java.lang.String iconId)
                              throws org.apache.commons.configuration.ConfigurationException,
                                     MissingValueException

Get the IconStatusConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

iconId - - A string value of id

Returns:

a IconStatusConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getIdLabelConfig

IdLabelConfig getIdLabelConfig(java.lang.String applicationId,
                               java.lang.String id)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Get the IdLabelConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a IdLabelConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getInterfaceTextConfig

InterfaceTextConfig getInterfaceTextConfig(java.lang.String applicationId,
                                           java.lang.String interfaceTextId)
                                    throws org.apache.commons.configuration.ConfigurationException,
                                           MissingValueException

Get the InterfaceTextConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

interfaceTextId - - A string value of id

Returns:

a InterfaceTextConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getInterfaceTextLocaleConfig

InterfaceTextLocaleConfig getInterfaceTextLocaleConfig(java.lang.String applicationId,
                                                       java.lang.String interfaceTextId)
                                                throws org.apache.commons.configuration.ConfigurationException,
                                                       MissingValueException

Get the InterfaceTextLocaleConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

interfaceTextId - - A string value of id

Returns:

a InterfaceTextLocaleConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getLocaleConfig

LocaleConfig getLocaleConfig(java.lang.String applicationId,
                             java.lang.String id)
                      throws org.apache.commons.configuration.ConfigurationException,
                             MissingValueException

Get the LocaleConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a LocaleConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getMenuConfig

MenuConfig getMenuConfig(java.lang.String applicationId,
                         java.lang.String menuId,
                         boolean... flags)
                  throws org.apache.commons.configuration.ConfigurationException,
                         MissingValueException

Get the MenuConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

menuId - - A string value of id

flags - - A optional boolean value to control caching or not.

Returns:

a MenuConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getMenuTypeConfig

MenuTypeConfig getMenuTypeConfig(java.lang.String applicationId,
                                 java.lang.String menuTypeId,
                                 boolean... flags)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the MenuTypeConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

menuTypeId - - A string value of id

flags - - A optional boolean value to control caching or not. *

Returns:

a MenuTypeConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getMobileFeatureConfig

MobileFeatureConfig getMobileFeatureConfig(java.lang.String applicationId,
                                           java.lang.String id)
                                    throws org.apache.commons.configuration.ConfigurationException,
                                           MissingValueException

Get the MobileFeatureConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a MobileFeatureConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getOAuthTokenMap

java.util.Map<java.lang.String,OAuthTokenConfig> getOAuthTokenMap(javax.servlet.http.HttpServletRequest request)

Get the OAuthTokenMap corresponding to the current desktop session user.

Parameters:

request -

Returns:

Since:

2.0.3.5

getODLoginConfig

ODLoginConfig getODLoginConfig(java.lang.String applicationId,
                               java.lang.String repositoryId)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Get the ODLoginConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

repositoryId - - A string value of id

Returns:

a ODLoginConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getOfficeCustomCommandConfig

OfficeCustomCommandConfig getOfficeCustomCommandConfig(java.lang.String applicationId,
                                                       java.lang.String id)
                                                throws org.apache.commons.configuration.ConfigurationException,
                                                       MissingValueException

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3

getPluginConfig

PluginConfig getPluginConfig(java.lang.String applicationId,
                             java.lang.String pluginId)
                      throws org.apache.commons.configuration.ConfigurationException,
                             MissingValueException

Get the PluginConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

pluginId - - A string value of id

Returns:

a PluginConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getPluginUserConfig

PluginUserConfig getPluginUserConfig(java.lang.String applicationId,
                                     java.lang.String userId,
                                     java.lang.String pluginId,
                                     java.lang.String key)
                              throws org.apache.commons.configuration.ConfigurationException,
                                     MissingValueException

Get the PluginUserConfig configuration object by combined userId, pluginId and key as ID

Parameters:

applicationId - - A string value of application id, for example "navigator".

userId - - A string value of user id

pluginId - - A string value of plugin id

key - - A string value of key

Returns:

a PluginUserConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getEditServiceCategoryConfig

EditServiceCategoryConfig getEditServiceCategoryConfig(java.lang.String applicationId,
                                                       java.lang.String id)
                                                throws org.apache.commons.configuration.ConfigurationException,
                                                       MissingValueException

Get the EditServiceCategoryConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a EditServiceCategoryConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getPropertyMappingConfig

PropertyMappingConfig getPropertyMappingConfig(java.lang.String applicationId,
                                               java.lang.String id)
                                        throws org.apache.commons.configuration.ConfigurationException,
                                               MissingValueException

Get the PropertyMappingConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a PropertyMappingConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRecentItemConfig

RecentItemConfig getRecentItemConfig(java.lang.String applicationId,
                                     java.lang.String id)
                              throws org.apache.commons.configuration.ConfigurationException,
                                     MissingValueException

Get the RecentItemConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a RecentItemConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRecentContentConfig

RecentContentConfig getRecentContentConfig(java.lang.String applicationId,
                                           java.lang.String id)
                                    throws org.apache.commons.configuration.ConfigurationException,
                                           MissingValueException

Get the RecentContentConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a RecentContentConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRecentSearchConfig

RecentSearchConfig getRecentSearchConfig(java.lang.String applicationId,
                                         java.lang.String id)
                                  throws org.apache.commons.configuration.ConfigurationException,
                                         MissingValueException

Get the RecentSearchConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a RecentSearchConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRecentSimpleSearchConfig

RecentSimpleSearchConfig getRecentSimpleSearchConfig(java.lang.String applicationId,
                                                     java.lang.String id)
                                              throws org.apache.commons.configuration.ConfigurationException,
                                                     MissingValueException

Get the RecentSimpleSearchConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a RecentSimpleSearchConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRecentTeamspaceConfig

RecentTeamspaceConfig getRecentTeamspaceConfig(java.lang.String applicationId,
                                               java.lang.String id)
                                        throws org.apache.commons.configuration.ConfigurationException,
                                               MissingValueException

Get the RecentTeamspaceConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a RecentTeamspaceConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRepositoryConfig

RepositoryConfig getRepositoryConfig(javax.servlet.http.HttpServletRequest request)

Get a repository definition out of the desktop definitions.

Parameters:

request - - A HttpServletRequest object.

Returns:

a RepositoryConfig configuration object.

getRepositoryConfig

RepositoryConfig getRepositoryConfig(java.lang.String applicationId,
                                     java.lang.String repositoryId)
                              throws org.apache.commons.configuration.ConfigurationException,
                                     MissingValueException

Get the RepositoryConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

repositoryId - - A string value of repositoryId

Returns:

a RepositoryConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRepositoryConfigUsingIdOrServerName

RepositoryConfig getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request)

Does this desktop has this repository in it. This method uses ParamConstants.PARM_DESKTOP_NAME in the request.

Parameters:

request - - A HttpServletRequest object.

Returns:

boolean

getRepositoryConfigUsingIdOrServerName

RepositoryConfig getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request,
                                                        java.lang.String repositoryId)

Get a repository definition out of the desktop definitions.

Parameters:

request - - A HttpServletRequest object.

Returns:

a RepositoryConfig configuration object.

getServerConfig

ServerConfig getServerConfig(javax.servlet.http.HttpServletRequest request)

Get a server definition out of the repository definitions.

Parameters:

request - - a HttpServletRequest.

Returns:

ServerConfig

getServerConfig

ServerConfig getServerConfig(java.lang.String applicationId,
                             java.lang.String serverId)
                      throws org.apache.commons.configuration.ConfigurationException,
                             MissingValueException

Get the ServerConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

serverId - - A string value of id

Returns:

a ServerConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSettingsConfig

SettingsConfig getSettingsConfig(javax.servlet.http.HttpServletRequest request)
                          throws MissingValueException,
                                 org.apache.commons.configuration.ConfigurationException

Get the SettingsConfig configuration object.

Parameters:

request -

Returns:

a SettingConfig configuration object.

Throws:

MissingValueException

org.apache.commons.configuration.ConfigurationException

getSettingsConfig

SettingsConfig getSettingsConfig(java.lang.String applicationId)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the SettingsConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

Returns:

a SettingsConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSettingsConfig

SettingsConfig getSettingsConfig(java.lang.String applicationId,
                                 boolean... flags)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the SettingsConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

Returns:

a SettingsConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSettingsConfig

SettingsConfig getSettingsConfig(java.lang.String applicationId,
                                 java.lang.String id)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the SettingsConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a SettingsConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSettingsConfig

SettingsConfig getSettingsConfig(java.lang.String applicationId,
                                 java.lang.String id,
                                 boolean... flags)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the SettingsConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a SettingsConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDataKeyConfig

DataKeyConfig getDataKeyConfig(java.lang.String keyId)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Gets the DataKeyConfig configuration object.

Parameters:

keyId - The Id of the key

Returns:

a DataKeyConfig configuration object

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSyncConfig

SyncConfig getSyncConfig(java.lang.String applicationId)
                  throws org.apache.commons.configuration.ConfigurationException,
                         MissingValueException

Get the SyncConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

Returns:

a SyncConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3

getSyncItemConfig

SyncItemConfig getSyncItemConfig(java.lang.String applicationId,
                                 java.lang.String id)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the SyncItemConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a SyncItemConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3.6

getSyncItemConfig

SyncItemConfig getSyncItemConfig(java.lang.String applicationId,
                                 java.lang.String id,
                                 boolean skipCaching)
                          throws org.apache.commons.configuration.ConfigurationException,
                                 MissingValueException

Get the SyncItemConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a SyncItemConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3.6

getTenantRegistrationConfig

TenantRegistrationConfig getTenantRegistrationConfig(java.lang.String tenantId)
                                              throws org.apache.commons.configuration.ConfigurationException,
                                                     MissingValueException

Get the registration information for a tenant

Parameters:

tenantId -

Returns:

a TenantRegistrationConfig object

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getThemeConfig

ThemeConfig getThemeConfig(java.lang.String applicationId,
                           java.lang.String themeId)
                    throws org.apache.commons.configuration.ConfigurationException,
                           MissingValueException

Get the ThemeConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

themeId - - A string value of id

Returns:

a ThemeConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRedactionReasonConfig

RedactionReasonConfig getRedactionReasonConfig(java.lang.String applicationId,
                                               java.lang.String redactionReasonId)
                                        throws org.apache.commons.configuration.ConfigurationException,
                                               MissingValueException

Get the RedactionReasonConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

redactionReasonId - - A string value of id

Returns:

a RedactionReasonConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRedactionReasonUsageConfig

RedactionReasonUsageConfig getRedactionReasonUsageConfig(java.lang.String applicationId,
                                                         java.lang.String redactionReasonId,
                                                         java.lang.String dcAppName)
                                                  throws org.apache.commons.configuration.ConfigurationException,
                                                         MissingValueException

Parameters:

applicationId -

redactionReasonId -

dcAppName -

Returns:

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getAdminRoleConfig

AdminRoleConfig getAdminRoleConfig(java.lang.String applicationId,
                                   java.lang.String adminRoleId)
                            throws org.apache.commons.configuration.ConfigurationException,
                                   MissingValueException

Get the AdminRoleConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

adminRoleId - - A string value of id

Returns:

a AdminRoleConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getUserActionMacroConfig

UserActionMacroConfig getUserActionMacroConfig(java.lang.String applicationId,
                                               java.lang.String userAction)
                                        throws org.apache.commons.configuration.ConfigurationException,
                                               MissingValueException

Get the UserActionMacroConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

userAction - - A string value of userAction

Returns:

a UserActionMacroConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getUserConfig

UserConfig getUserConfig(javax.servlet.http.HttpServletRequest request)

Get the UserConfig configuration object for the current desktop session user.

Parameters:

request -

Returns:

getUserConfig

UserConfig getUserConfig(java.lang.String applicationId,
                         java.lang.String userId)
                  throws org.apache.commons.configuration.ConfigurationException,
                         MissingValueException

Get the UserConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

userId - - A string value of id

Returns:

a UserConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getOfficeOnlineTokenConfig

OfficeOnlineTokenConfig getOfficeOnlineTokenConfig(java.lang.String applicationId,
                                                   java.lang.String userId)
                                            throws org.apache.commons.configuration.ConfigurationException,
                                                   MissingValueException

Get the OfficeOnlineTokenConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

userId - - A string value of user id

Returns:

a OfficeOnlineTokenConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getUserGroupConfig

UserGroupConfig getUserGroupConfig(java.lang.String applicationId,
                                   java.lang.String id)
                            throws org.apache.commons.configuration.ConfigurationException,
                                   MissingValueException

Get the UserGroupConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a UserGroupConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.2

getViewerConfig

ViewerConfig getViewerConfig(java.lang.String applicationId,
                             java.lang.String viewerId)
                      throws org.apache.commons.configuration.ConfigurationException,
                             MissingValueException

Get the ViewerConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

viewerId - - A string value of id

Returns:

a ViewerConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getViewerDefConfig

ViewerDefConfig getViewerDefConfig(java.lang.String applicationId,
                                   java.lang.String viewerDefId)
                            throws org.apache.commons.configuration.ConfigurationException,
                                   MissingValueException

Get the ViewerDefConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

viewerDefId - - A string value of id

Returns:

a ViewerDefConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getViewerMappingConfig

ViewerMappingConfig getViewerMappingConfig(java.lang.String applicationId,
                                           java.lang.String viewerMappingId)
                                    throws org.apache.commons.configuration.ConfigurationException,
                                           MissingValueException

Get the ViewerMappingConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

viewerMappingId - - A string value of id

Returns:

a ViewerMappingConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getViewOneConfig

ViewOneConfig getViewOneConfig(java.lang.String applicationId)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Get the ViewOneConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

Returns:

a ViewOneConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3

getViewOneConfig

ViewOneConfig getViewOneConfig(java.lang.String applicationId,
                               java.lang.String id)
                        throws org.apache.commons.configuration.ConfigurationException,
                               MissingValueException

Get the ViewOneConfig configuration object.

Parameters:

applicationId - - A string value of application id, for example "navigator".

id - - A string value of id

Returns:

a ViewOneConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

2.0.3

hasRepositoryConfigUsingIdOrServerName

boolean hasRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request,
                                               java.lang.String repositoryId)

Does this desktop has this repository in it.

Parameters:

request - - A HttpServletRequest object.

repositoryId - A string value of repositoryId.

Returns:

boolean

removeConfigurationFromCache

boolean removeConfigurationFromCache(ConfigurationObject config)

Remove configuration object from the DB/Properties.

Parameters:

config - - A ICN configuration object.

Returns:

setDefaultHelpURL

void setDefaultHelpURL(SettingsConfig settingsConfig)

Parameters:

settingsConfig - - An ICN SettingsConfig object.

getEdsConfig

EdsConfig getEdsConfig(java.lang.String applicationId)
                throws org.apache.commons.configuration.ConfigurationException,
                       MissingValueException

For internal use only.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

3.0.14

getEdsConfig

EdsConfig getEdsConfig(java.lang.String applicationId,
                       java.lang.String id)
                throws org.apache.commons.configuration.ConfigurationException,
                       MissingValueException

For internal use only.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

Since:

3.0.14