com.ibm.ecm.configuration

Class GlobalConfig

java.lang.Object

com.ibm.ecm.configuration.GlobalConfig

All Implemented Interfaces:

ConfigInterface

Direct Known Subclasses:

PropertiesConfig, TenantConfig

public class GlobalConfig
extends java.lang.Object
implements ConfigInterface

Since:

3.0.12

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_PROPERTIES_PATH
protected static java.lang.String	DEFAULT_TENANT_PROPERTIES_PATH
protected boolean	skipUserObjectCaching

Method Summary

Modifier and Type	Method and Description
protected void	finishInitialization()
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 configObj) Remove configuration object from the DB/Properties.
void	setDefaultHelpURL(SettingsConfig settingsConfig)
void	setSessionKey(byte[] sessionKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PROPERTIES_PATH

protected static final java.lang.String DEFAULT_PROPERTIES_PATH

See Also:

Constant Field Values

DEFAULT_TENANT_PROPERTIES_PATH

protected static final java.lang.String DEFAULT_TENANT_PROPERTIES_PATH

See Also:

Constant Field Values

skipUserObjectCaching

protected boolean skipUserObjectCaching

Method Detail

finishInitialization

protected void finishInitialization()

getConfigurationType

public Config.CONFIGURATION_TYPE getConfigurationType()

Description copied from interface: ConfigInterface

Return configuration type back.

Specified by:

getConfigurationType in interface ConfigInterface

Returns:

a enum of either properties or database

getDatabaseSchemaName

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

Deprecated.

Description copied from interface: ConfigInterface

Return DB schema name.

Specified by:

getDatabaseSchemaName in interface ConfigInterface

Parameters:

servletContext - - a ServletContext object.

Returns:

DB schema name.

getJDBCVersion

@Deprecated
public java.lang.String getJDBCVersion()

Deprecated.

Description copied from interface: ConfigInterface

Get the JDBC version

Specified by:

getJDBCVersion in interface ConfigInterface

Returns:

JDBC version number from the DB connection object.

getCache

public CacheInterface getCache()

Specified by:

getCache in interface ConfigInterface

Returns:

getSessionKey

public byte[] getSessionKey()

Specified by:

getSessionKey in interface ConfigInterface

Returns:

setSessionKey

public void setSessionKey(byte[] sessionKey)

Specified by:

setSessionKey in interface ConfigInterface

getConfiguration

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

Description copied from interface: ConfigInterface

Return the configuration object back.

Specified by:

getConfiguration in interface ConfigInterface

Returns:

a Apache configuration object.

getConfiguration

public <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

Description copied from interface: ConfigInterface

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

Specified by:

getConfiguration in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Return default configuration object.

Specified by:

getDefaultConfiguration in interface ConfigInterface

Returns:

a Apache configuration object.

getDefaultConfiguration

public <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

Description copied from interface: ConfigInterface

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

Specified by:

getDefaultConfiguration in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the AccessRoleConfig configuration object.

Specified by:

getAccessRoleConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the application configuration object.

Specified by:

getApplicationConfig in interface ConfigInterface

Parameters:

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

Returns:

a application configuration object

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getApplicationConfig

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

Description copied from interface: ConfigInterface

Get a application definition out of the request.

Specified by:

getApplicationConfig in interface ConfigInterface

Parameters:

request - - A HttpServletRequest object.

Returns:

a ApplicationConfig configuration object.

getApplicationConfig

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

Description copied from interface: ConfigInterface

Get a application definition out of the request.

Specified by:

getApplicationConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the default IconConfig configuration object.

Specified by:

getDefaultIconConfig in interface ConfigInterface

Parameters:

iconId - - A string value of id

Returns:

a IconConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDesktopAccessConfig

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

Description copied from interface: ConfigInterface

Get the DesktopAccessConfig configuration object.

Specified by:

getDesktopAccessConfig in interface ConfigInterface

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

getDesktopAdminAccessConfig

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

Description copied from interface: ConfigInterface

Get the DesktopAdminAccessConfig configuration object.

Specified by:

getDesktopAdminAccessConfig in interface ConfigInterface

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

getDesktopConfig

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

Description copied from interface: ConfigInterface

Get a desktop definition out of the request.

Specified by:

getDesktopConfig in interface ConfigInterface

Parameters:

request - - A HttpServletRequest object.

Returns:

a DesktopConfig configuration object.

getDesktopConfig

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

Description copied from interface: ConfigInterface

Get the desktop configuration object.

Specified by:

getDesktopConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

For internal use only.

Specified by:

getDraftDesktopConfig in interface ConfigInterface

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getFavoriteConfig

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

Description copied from interface: ConfigInterface

Get the FavoriteConfig configuration object.

Specified by:

getFavoriteConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the FavoriteConfig configuration object.

Specified by:

getFavoriteConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the FilenetConfig configuration object.

Specified by:

getFilenetConfig in interface ConfigInterface

Parameters:

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

Returns:

a FilenetConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getFilenetConfig

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

Description copied from interface: ConfigInterface

Get the FilenetConfig configuration object.

Specified by:

getFilenetConfig in interface ConfigInterface

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

getConversionConfig

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

Description copied from interface: ConfigInterface

Get the ConversionConfig configuration object.

Specified by:

getConversionConfig in interface ConfigInterface

Parameters:

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

Returns:

a ConversionConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getFileTypeConfig

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

Description copied from interface: ConfigInterface

Get the FileTypeConfig configuration object.

Specified by:

getFileTypeConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Static method to find the current default desktop name

Specified by:

getDefaultDesktopName in interface ConfigInterface

Returns:

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDesktopFeatureConfig

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

Description copied from interface: ConfigInterface

Get the DesktopFeatureConfig configuration object.

Specified by:

getDesktopFeatureConfig in interface ConfigInterface

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

getIconConfig

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

Description copied from interface: ConfigInterface

Get the IconConfig configuration object.

Specified by:

getIconConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the IconStatusConfig configuration object.

Specified by:

getIconStatusConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the IdLabelConfig configuration object.

Specified by:

getIdLabelConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the InterfaceTextConfig configuration object.

Specified by:

getInterfaceTextConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the InterfaceTextLocaleConfig configuration object.

Specified by:

getInterfaceTextLocaleConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the LocaleConfig configuration object.

Specified by:

getLocaleConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the MenuConfig configuration object.

Specified by:

getMenuConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the MenuTypeConfig configuration object.

Specified by:

getMenuTypeConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the MobileFeatureConfig configuration object.

Specified by:

getMobileFeatureConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the OAuthTokenMap corresponding to the current desktop session user.

Specified by:

getOAuthTokenMap in interface ConfigInterface

Returns:

getODLoginConfig

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

Description copied from interface: ConfigInterface

Get the ODLoginConfig configuration object.

Specified by:

getODLoginConfig in interface ConfigInterface

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

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

Specified by:

getOfficeCustomCommandConfig in interface ConfigInterface

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getPluginConfig

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

Description copied from interface: ConfigInterface

Get the PluginConfig configuration object.

Specified by:

getPluginConfig in interface ConfigInterface

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

public 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

Description copied from interface: ConfigInterface

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

Specified by:

getPluginUserConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the EditServiceCategoryConfig configuration object.

Specified by:

getEditServiceCategoryConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the PropertyMappingConfig configuration object.

Specified by:

getPropertyMappingConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the RecentItemConfig configuration object.

Specified by:

getRecentItemConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the RecentContentConfig configuration object.

Specified by:

getRecentContentConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the RecentSearchConfig configuration object.

Specified by:

getRecentSearchConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the RecentSimpleSearchConfig configuration object.

Specified by:

getRecentSimpleSearchConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the RecentTeamspaceConfig configuration object.

Specified by:

getRecentTeamspaceConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get a repository definition out of the desktop definitions.

Specified by:

getRepositoryConfig in interface ConfigInterface

Parameters:

request - - A HttpServletRequest object.

Returns:

a RepositoryConfig configuration object.

getRepositoryConfig

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

Description copied from interface: ConfigInterface

Get the RepositoryConfig configuration object.

Specified by:

getRepositoryConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

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

Specified by:

getRepositoryConfigUsingIdOrServerName in interface ConfigInterface

Parameters:

request - - A HttpServletRequest object.

Returns:

boolean

getRepositoryConfigUsingIdOrServerName

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

Description copied from interface: ConfigInterface

Get a repository definition out of the desktop definitions.

Specified by:

getRepositoryConfigUsingIdOrServerName in interface ConfigInterface

Parameters:

request - - A HttpServletRequest object.

Returns:

a RepositoryConfig configuration object.

getServerConfig

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

Description copied from interface: ConfigInterface

Get a server definition out of the repository definitions.

Specified by:

getServerConfig in interface ConfigInterface

Parameters:

request - - a HttpServletRequest.

Returns:

ServerConfig

getServerConfig

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

Description copied from interface: ConfigInterface

Get the ServerConfig configuration object.

Specified by:

getServerConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the SettingsConfig configuration object.

Specified by:

getSettingsConfig in interface ConfigInterface

Returns:

a SettingConfig configuration object.

Throws:

MissingValueException

org.apache.commons.configuration.ConfigurationException

getSettingsConfig

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

Description copied from interface: ConfigInterface

Get the SettingsConfig configuration object.

Specified by:

getSettingsConfig in interface ConfigInterface

Parameters:

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

Returns:

a SettingsConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSettingsConfig

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

Description copied from interface: ConfigInterface

Get the SettingsConfig configuration object.

Specified by:

getSettingsConfig in interface ConfigInterface

Parameters:

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

Returns:

a SettingsConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSettingsConfig

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

Description copied from interface: ConfigInterface

Get the SettingsConfig configuration object.

Specified by:

getSettingsConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the SettingsConfig configuration object.

Specified by:

getSettingsConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Gets the DataKeyConfig configuration object.

Specified by:

getDataKeyConfig in interface ConfigInterface

Parameters:

keyId - The Id of the key

Returns:

a DataKeyConfig configuration object

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getEdsConfig

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

Description copied from interface: ConfigInterface

For internal use only.

Specified by:

getEdsConfig in interface ConfigInterface

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getEdsConfig

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

Description copied from interface: ConfigInterface

For internal use only.

Specified by:

getEdsConfig in interface ConfigInterface

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSyncConfig

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

Description copied from interface: ConfigInterface

Get the SyncConfig configuration object.

Specified by:

getSyncConfig in interface ConfigInterface

Parameters:

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

Returns:

a SyncConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getSyncItemConfig

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

Description copied from interface: ConfigInterface

Get the SyncItemConfig configuration object.

Specified by:

getSyncItemConfig in interface ConfigInterface

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

getSyncItemConfig

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

Description copied from interface: ConfigInterface

Get the SyncItemConfig configuration object.

Specified by:

getSyncItemConfig in interface ConfigInterface

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

getTenantRegistrationConfig

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

Description copied from interface: ConfigInterface

Get the registration information for a tenant

Specified by:

getTenantRegistrationConfig in interface ConfigInterface

Returns:

a TenantRegistrationConfig object

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getThemeConfig

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

Description copied from interface: ConfigInterface

Get the ThemeConfig configuration object.

Specified by:

getThemeConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the RedactionReasonConfig configuration object.

Specified by:

getRedactionReasonConfig in interface ConfigInterface

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

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

Specified by:

getRedactionReasonUsageConfig in interface ConfigInterface

Returns:

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getAdminRoleConfig

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

Description copied from interface: ConfigInterface

Get the AdminRoleConfig configuration object.

Specified by:

getAdminRoleConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the UserActionMacroConfig configuration object.

Specified by:

getUserActionMacroConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

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

Specified by:

getUserConfig in interface ConfigInterface

Returns:

getUserConfig

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

Description copied from interface: ConfigInterface

Get the UserConfig configuration object.

Specified by:

getUserConfig in interface ConfigInterface

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

getUserGroupConfig

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

Description copied from interface: ConfigInterface

Get the UserGroupConfig configuration object.

Specified by:

getUserGroupConfig in interface ConfigInterface

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

getOfficeOnlineTokenConfig

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

Description copied from interface: ConfigInterface

Get the OfficeOnlineTokenConfig configuration object.

Specified by:

getOfficeOnlineTokenConfig in interface ConfigInterface

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

getViewerConfig

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

Description copied from interface: ConfigInterface

Get the ViewerConfig configuration object.

Specified by:

getViewerConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the ViewerDefConfig configuration object.

Specified by:

getViewerDefConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the ViewerMappingConfig configuration object.

Specified by:

getViewerMappingConfig in interface ConfigInterface

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

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

Description copied from interface: ConfigInterface

Get the ViewOneConfig configuration object.

Specified by:

getViewOneConfig in interface ConfigInterface

Parameters:

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

Returns:

a ViewOneConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getViewOneConfig

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

Description copied from interface: ConfigInterface

Get the ViewOneConfig configuration object.

Specified by:

getViewOneConfig in interface ConfigInterface

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

hasRepositoryConfigUsingIdOrServerName

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

Description copied from interface: ConfigInterface

Does this desktop has this repository in it.

Specified by:

hasRepositoryConfigUsingIdOrServerName in interface ConfigInterface

Parameters:

request - - A HttpServletRequest object.

repositoryId - A string value of repositoryId.

Returns:

boolean

removeConfigurationFromCache

public boolean removeConfigurationFromCache(ConfigurationObject configObj)

Description copied from interface: ConfigInterface

Remove configuration object from the DB/Properties.

Specified by:

removeConfigurationFromCache in interface ConfigInterface

Parameters:

configObj - - A ICN configuration object.

Returns:

setDefaultHelpURL

public void setDefaultHelpURL(SettingsConfig settingsConfig)

Specified by:

setDefaultHelpURL in interface ConfigInterface

Parameters:

settingsConfig - - An ICN SettingsConfig object.