com.ibm.ecm.configuration

Class Config

java.lang.Object

com.ibm.ecm.configuration.Config

public class Config
extends java.lang.Object

Provides access methods to the configuration for ICN configuration. Most of methods in this class is public static. If you added a new configuration class to ICN, you need to add a public static method of getXXXXConfig for example getSettingsConfig to this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Config.CONFIGURATION_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_NAME
static boolean	connectToLDAP
static java.lang.String	ENCODING_UTF8
static char	LIST_DELIMITER

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
static AccessRoleConfig	getAccessRoleConfig(java.lang.String applicationId, java.lang.String roleId) Get the AccessRoleConfig configuration object.
static AdminRoleConfig	getAdminRoleConfig(java.lang.String applicationId, java.lang.String id) Get the AdminRoleConfig configuration object.
static ApplicationConfig	getApplicationConfig(javax.servlet.http.HttpServletRequest request) Get a application definition out of the request.
static ApplicationConfig	getApplicationConfig(javax.servlet.http.HttpServletRequest request, java.lang.String defaultAppName) Get a application definition out of the request.
static ApplicationConfig	getApplicationConfig(java.lang.String applicationId) Get the application configuration object.
static org.apache.commons.configuration.AbstractConfiguration	getConfiguration() Return the configuration object back.
static <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.
static Config.CONFIGURATION_TYPE	getConfigurationType() Return configuration type back.
static ConversionConfig	getConversionConfig(java.lang.String applicationId)
static DataKeyConfig	getDataKeyConfig(java.lang.String keyId) Gets the DataKeyConfig configuration object.
static org.apache.commons.configuration.AbstractConfiguration	getDefaultConfiguration() Return default configuration object back.
static <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.
static java.lang.String	getDefaultDesktopName(javax.servlet.http.HttpServletRequest request) Static method to find the current default desktop name
static IconConfig	getDefaultIconConfig(java.lang.String iconId) Get the default IconConfig configuration object.
static DesktopAccessConfig	getDesktopAccessConfig(java.lang.String applicationId, java.lang.String id) Get the DesktopAccessConfig configuration object.
static DesktopAdminAccessConfig	getDesktopAdminAccessConfig(java.lang.String applicationId, java.lang.String id) Get the DesktopAdminAccessConfig configuration object.
static DesktopConfig	getDesktopConfig(javax.servlet.http.HttpServletRequest request) Get a desktop definition out of the request.
static DesktopConfig	getDesktopConfig(java.lang.String applicationId, java.lang.String desktopId) Get the desktop configuration object.
static DesktopFeatureConfig	getDesktopFeatureConfig(java.lang.String applicationId, java.lang.String id) Get the DesktopFeatureConfig configuration object.
static EditServiceCategoryConfig	getEditServiceCategoryConfig(java.lang.String applicationId, java.lang.String id) Get the EditServiceCategoryConfig configuration object.
static EdsConfig	getEdsConfig(java.lang.String applicationId) For internal use only.
static FavoriteConfig	getFavoriteConfig(java.lang.String applicationId, java.lang.String id) Get the FavoriteConfig configuration object.
static FavoriteConfig	getFavoriteConfig(java.lang.String applicationId, java.lang.String id, boolean skipCaching) Get the FavoriteConfig configuration object.
static FilenetConfig	getFilenetConfig(java.lang.String applicationId) Get the FilenetConfig configuration object.
static FilenetConfig	getFilenetConfig(java.lang.String applicationId, java.lang.String id) Get the FilenetConfig configuration object.
static FileTypeConfig	getFileTypeConfig(java.lang.String applicationId, java.lang.String fileType) Get the FileTypeConfig configuration object.
static IconConfig	getIconConfig(java.lang.String applicationId, java.lang.String iconId) Get the IconConfig configuration object.
static IconStatusConfig	getIconStatusConfig(java.lang.String applicationId, java.lang.String iconId) Get the IconStatusConfig configuration object.
static IdLabelConfig	getIdLabelConfig(java.lang.String applicationId, java.lang.String id) Get the IdLabelConfig configuration object.
static InterfaceTextConfig	getInterfaceTextConfig(java.lang.String applicationId, java.lang.String interfaceTextId) Get the InterfaceTextConfig configuration object.
static InterfaceTextLocaleConfig	getInterfaceTextLocaleConfig(java.lang.String applicationId, java.lang.String interfaceTextId) Get the InterfaceTextLocaleConfig configuration object.
static LocaleConfig	getLocaleConfig(java.lang.String applicationId, java.lang.String id) Get the LocaleConfig configuration object.
static MenuConfig	getMenuConfig(java.lang.String applicationId, java.lang.String menuId, boolean... flags) Get the MenuConfig configuration object.
static MenuTypeConfig	getMenuTypeConfig(java.lang.String applicationId, java.lang.String menuTypeId, boolean... flags) Get the MenuTypeConfig configuration object.
static MobileFeatureConfig	getMobileFeatureConfig(java.lang.String applicationId, java.lang.String id) Get the MobileFeatureConfig configuration object.
static java.util.Map<java.lang.String,OAuthTokenConfig>	getOAuthTokenMap(javax.servlet.http.HttpServletRequest request) Get the OAuthTokenMap corresponding to the current desktop session user.
static ODLoginConfig	getODLoginConfig(java.lang.String applicationId, java.lang.String repositoryId) Get the ODLoginConfig configuration object.
static OfficeCustomCommandConfig	getOfficeCustomCommandConfig(java.lang.String applicationId, java.lang.String id)
static OfficeOnlineTokenConfig	getOfficeOnlineTokenConfig(java.lang.String applicationId, java.lang.String userId) Get the OfficeOnlineTokenConfig configuration object.
static PluginConfig	getPluginConfig(java.lang.String applicationId, java.lang.String pluginId) Get the PluginConfig configuration object.
static 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
static PropertyMappingConfig	getPropertyMappingConfig(java.lang.String applicationId, java.lang.String id) Get the PropertyMappingConfig configuration object.
static RecentContentConfig	getRecentContentConfig(java.lang.String applicationId, java.lang.String id) Get the RecentContentConfig configuration object.
static RecentItemConfig	getRecentItemConfig(java.lang.String applicationId, java.lang.String id) Get the RecentItemConfig configuration object.
static RecentSearchConfig	getRecentSearchConfig(java.lang.String applicationId, java.lang.String id) Get the RecentSearchConfig configuration object.
static RecentSimpleSearchConfig	getRecentSimpleSearchConfig(java.lang.String applicationId, java.lang.String id) Get the RecentSimpleSearchConfig configuration object.
static RecentTeamspaceConfig	getRecentTeamspaceConfig(java.lang.String applicationId, java.lang.String id) Get the RecentTeamspaceConfig configuration object.
static RedactionReasonConfig	getRedactionReasonConfig(java.lang.String applicationId, java.lang.String redactionReasonId) Get the RedactionReasonConfig configuration object.
static RedactionReasonUsageConfig	getRedactionReasonUsageConfig(java.lang.String applicationId, java.lang.String redactionReasonId, java.lang.String dcAppName)
static RepositoryConfig	getRepositoryConfig(javax.servlet.http.HttpServletRequest request) Get a repository definition out of the desktop definitions.
static RepositoryConfig	getRepositoryConfig(java.lang.String applicationId, java.lang.String repositoryId) Get the RepositoryConfig configuration object.
static RepositoryConfig	getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request) Does this desktop has this repository in it.
static RepositoryConfig	getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request, java.lang.String repositoryId) Get a repository definition out of the desktop definitions.
static ServerConfig	getServerConfig(javax.servlet.http.HttpServletRequest request) Get a server definition out of the repository definitions.
static ServerConfig	getServerConfig(java.lang.String applicationId, java.lang.String serverId) Get the ServerConfig configuration object.
static byte[]	getSessionKey()
static SettingsConfig	getSettingsConfig(javax.servlet.http.HttpServletRequest request) Get the SettingsConfig configuration object.
static SettingsConfig	getSettingsConfig(java.lang.String applicationId) Get the SettingsConfig configuration object.
static SettingsConfig	getSettingsConfig(java.lang.String applicationId, boolean... flags) Get the SettingsConfig configuration object.
static SettingsConfig	getSettingsConfig(java.lang.String applicationId, java.lang.String id) Get the SettingsConfig configuration object.
static SettingsConfig	getSettingsConfig(java.lang.String applicationId, java.lang.String id, boolean... flags) Get the SettingsConfig configuration object.
static SyncConfig	getSyncConfig(java.lang.String applicationId) Get the SyncConfig configuration object.
static SyncItemConfig	getSyncItemConfig(java.lang.String applicationId, java.lang.String id) Get the SyncItemConfig configuration object.
static SyncItemConfig	getSyncItemConfig(java.lang.String applicationId, java.lang.String id, boolean skipCaching) Get the SyncItemConfig configuration object.
static ThemeConfig	getThemeConfig(java.lang.String applicationId, java.lang.String themeId) Get the ThemeConfig configuration object.
static UserActionMacroConfig	getUserActionMacroConfig(java.lang.String applicationId, java.lang.String userAction) Get the UserActionMacroConfig configuration object.
static UserConfig	getUserConfig(javax.servlet.http.HttpServletRequest request) Get the UserConfig configuration object for the current desktop session user.
static UserConfig	getUserConfig(java.lang.String applicationId, java.lang.String id) Get the UserConfig configuration object.
static UserGroupConfig	getUserGroupConfig(java.lang.String applicationId, java.lang.String id) Get the UserGroupConfig configuration object.
static ViewerConfig	getViewerConfig(java.lang.String applicationId, java.lang.String viewerId) Get the ViewerConfig configuration object.
static ViewerDefConfig	getViewerDefConfig(java.lang.String applicationId, java.lang.String viewerDefId) Get the ViewerDefConfig configuration object.
static ViewerMappingConfig	getViewerMappingConfig(java.lang.String applicationId, java.lang.String viewerMappingId) Get the ViewerMappingConfig configuration object.
static ViewOneConfig	getViewOneConfig(java.lang.String applicationId) Get the ViewOneConfig configuration object.
static ViewOneConfig	getViewOneConfig(java.lang.String applicationId, java.lang.String id) Get the ViewOneConfig configuration object.
static java.lang.String	guidToId(java.lang.String guid) Convert a GUID in the form {aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee} to the form aaaaaaaabbbbccccddddeeeeeeeeeeee, so that it can be used as the key/id of a Configuration object.
static boolean	hasRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request, java.lang.String repositoryId) Does this desktop has this repository in it.
static java.lang.String	idToGuid(java.lang.String id) Convert a GUID in the form aaaaaaaabbbbccccddddeeeeeeeeeeee to the standard delimited form {aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee}.
static void	initialize(java.lang.String enablePropertiesConfig, java.lang.String propertiesFileName) Initialize access to configuration.
static void	initialize(java.lang.String enablePropertiesConfig, java.lang.String propertiesFileName, java.lang.String userDefinedSchema, java.lang.String userDefinedJNDI, java.lang.String ldapServer)
static void	reinitialize(java.lang.String enablePropertiesConfig, java.lang.String propertiesFileName, java.lang.String userDefinedSchema, java.lang.String userDefinedJNDI, java.lang.String ldapServer)
static boolean	removeConfigurationFromCache(ConfigurationObject config) Remove configuration object from the DB/Properties.
static void	setDefaultHelpURL(SettingsConfig settingsConfig)
static void	setSessionKey(byte[] theSessionKey)
static boolean	usingPropertiesFile()

Methods inherited from class java.lang.Object

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

Field Detail

LIST_DELIMITER

public static final char LIST_DELIMITER

See Also:

Constant Field Values

ENCODING_UTF8

public static final java.lang.String ENCODING_UTF8

See Also:

Constant Field Values

APPLICATION_NAME

public static final java.lang.String APPLICATION_NAME

See Also:

Constant Field Values

connectToLDAP

public static boolean connectToLDAP

Constructor Detail

Config

public Config()

Method Detail

initialize

public static void initialize(java.lang.String enablePropertiesConfig,
                              java.lang.String propertiesFileName,
                              java.lang.String userDefinedSchema,
                              java.lang.String userDefinedJNDI,
                              java.lang.String ldapServer)
                       throws java.lang.Exception

Throws:

java.lang.Exception

initialize

public static void initialize(java.lang.String enablePropertiesConfig,
                              java.lang.String propertiesFileName)
                       throws java.lang.Exception

Initialize access to configuration. Based by the incoming parameter configuration can be a properties or DB. If the configuration is in a properties, the Configuration.properties or propertiesFileName file name is used. If it is database, JNDI is used to access the configuration in DB. ICN only support configuration in DB in a production environment. Properties file is used only in a developer environment or demo.

Parameters:

enablePropertiesConfig - - A boolean value that identify IBM Case Management is trying to access its configuration

propertiesFileName - - A string value of file name of the configuration file.

Throws:

java.lang.Exception

reinitialize

public static void reinitialize(java.lang.String enablePropertiesConfig,
                                java.lang.String propertiesFileName,
                                java.lang.String userDefinedSchema,
                                java.lang.String userDefinedJNDI,
                                java.lang.String ldapServer)
                         throws java.lang.Exception

Throws:

java.lang.Exception

usingPropertiesFile

public static boolean usingPropertiesFile()

setDefaultHelpURL

public static void setDefaultHelpURL(SettingsConfig settingsConfig)

getConfigurationType

public static Config.CONFIGURATION_TYPE getConfigurationType()

Return configuration type back.

Returns:

a enum of either properties or database

idToGuid

public static java.lang.String idToGuid(java.lang.String id)
                                 throws java.lang.Exception

Convert a GUID in the form aaaaaaaabbbbccccddddeeeeeeeeeeee to the standard delimited form {aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee}. Also normalize ID's to lowercase alpha characters. This call will accept any string with length == 32 characters, and will assume they are valid guid characters.

Parameters:

id -

Returns:

Throws:

java.lang.Exception

guidToId

public static java.lang.String guidToId(java.lang.String guid)
                                 throws java.lang.Exception

Convert a GUID in the form {aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee} to the form aaaaaaaabbbbccccddddeeeeeeeeeeee, so that it can be used as the key/id of a Configuration object. Also normalize ID's to lowercase alpha characters. This call will accept any string with length == 38 characters, and will assume the 38 characters represent a valid GUID string.

Parameters:

guid -

Returns:

Throws:

java.lang.Exception - - if the input string length is not 38 characters.

getApplicationConfig

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

getDesktopConfig

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

getViewOneConfig

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

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

getFilenetConfig

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

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

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

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getDesktopAccessConfig

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

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

getSyncConfig

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

getSettingsConfig

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

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

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

getSettingsConfig

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

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

getEdsConfig

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

getDataKeyConfig

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

getInterfaceTextConfig

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

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

getViewerConfig

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

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

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

getLocaleConfig

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

getIdLabelConfig

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

getUserGroupConfig

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

getDefaultIconConfig

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

getIconConfig

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

getFileTypeConfig

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

getPropertyMappingConfig

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

getEditServiceCategoryConfig

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

getMobileFeatureConfig

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

getDesktopFeatureConfig

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

getOfficeCustomCommandConfig

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

getUserActionMacroConfig

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

getIconStatusConfig

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

getRepositoryConfig

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

getServerConfig

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

getMenuConfig

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

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

getPluginConfig

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

getThemeConfig

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

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

getAdminRoleConfig

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

Get the AdminRoleConfig configuration object.

Parameters:

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

id - - A string value of id

Returns:

an AdminRoleConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getRedactionReasonUsageConfig

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

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getFavoriteConfig

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

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

getSyncItemConfig

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

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

getUserConfig

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

Get the UserConfig configuration object.

Parameters:

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

id - - A string value of id

Returns:

a UserConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getUserConfig

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

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

Parameters:

request -

Returns:

getOfficeOnlineTokenConfig

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

Returns:

a OfficeOnlineTokenConfig configuration object.

Throws:

org.apache.commons.configuration.ConfigurationException

MissingValueException

getOAuthTokenMap

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

getPluginUserConfig

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

getODLoginConfig

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

getRecentSearchConfig

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

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

getRecentItemConfig

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

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

getRecentTeamspaceConfig

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

getAccessRoleConfig

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

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

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

getDesktopConfig

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

getRepositoryConfig

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

getRepositoryConfigUsingIdOrServerName

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

hasRepositoryConfigUsingIdOrServerName

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

getRepositoryConfigUsingIdOrServerName

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

getServerConfig

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

Get a server definition out of the repository definitions.

Parameters:

request - - a HttpServletRequest.

Returns:

ServerConfig

removeConfigurationFromCache

public static boolean removeConfigurationFromCache(ConfigurationObject config)

Remove configuration object from the DB/Properties.

Parameters:

config - - A ICN configuration object.

Returns:

getDefaultConfiguration

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

getConfiguration

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

getConfiguration

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

Return the configuration object back.

Returns:

a Apache configuration object.

getDefaultConfiguration

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

Return default configuration object back.

Returns:

a Apache configuration object.

getDefaultDesktopName

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

getSessionKey

public static byte[] getSessionKey()

Returns:

Since:

ICN 2.0.3.6

setSessionKey

public static void setSessionKey(byte[] theSessionKey)

Parameters:

theSessionKey -

Since:

ICN 2.0.3.6