com.ibm.ecm.configuration

Class Config

  1. java.lang.Object
  2. extended bycom.ibm.ecm.configuration.Config
  1. public class Config
  2. 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

Modifier and Type Class and Description
  1. static class
 Config.CONFIGURATION_TYPE

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
 APPLICATION_NAME
  1. static
  2. java.lang.String
 ENCODING_UTF8
  1. static
  2. char
 LIST_DELIMITER
  1. static
  2. java.util.Map
 myMap

Constructor Summary

Constructor and Description
Config()

Method Summary

Modifier and Type Method and Description
  1. static
  2. ApplicationConfig
 getApplicationConfig(javax.servlet.http.HttpServletRequest request)
Get a application definition out of the request.
  1. static
  2. ApplicationConfig
 getApplicationConfig(java.lang.String applicationId)
Get the application configuration object.
  1. static
  2. org.apache.commons.configuration.AbstractConfiguration
 getConfiguration()
Return the configuration object back.
  1. static
  2. Config.CONFIGURATION_TYPE
 getConfigurationType()
Return configuration type back.
  1. static
  2. java.lang.String
 getDatabaseSchemaName(javax.servlet.ServletContext servletContext)
Return DB schema name.
  1. static
  2. java.lang.String
 getDatabseName()
  1. static
  2. org.apache.commons.configuration.AbstractConfiguration
 getDefaultConfiguration()
Return default configuration object back.
  1. static
  2. java.lang.String
 getDefaultDesktopName(javax.servlet.http.HttpServletRequest request)
Static method to find the current default desktop name
  1. static
  2. IconConfig
 getDefaultIconConfig(java.lang.String iconId)
Get the default IconConfig configuration object.
  1. static
  2. DesktopAccessConfig
 getDesktopAccessConfig(java.lang.String applicationId,java.lang.String id)
Get the DesktopAccessConfig configuration object.
  1. static
  2. DesktopConfig
 getDesktopConfig(javax.servlet.http.HttpServletRequest request)
Get a desktop definition out of the request.
  1. static
  2. DesktopConfig
 getDesktopConfig(java.lang.String applicationId,java.lang.String desktopId)
Get the desktop configuration object.
  1. static
  2. DesktopFeatureConfig
 getDesktopFeatureConfig(java.lang.String applicationId,java.lang.String id)
Get the DesktopFeatureConfig configuration object.
  1. static
  2. FavoriteConfig
 getFavoriteConfig(java.lang.String applicationId,java.lang.String id)
Get the FavoriteConfig configuration object.
  1. static
  2. FavoriteConfig
 getFavoriteConfig(java.lang.String applicationId,java.lang.String id,boolean skipCaching)
Get the FavoriteConfig configuration object.
  1. static
  2. FilenetConfig
 getFilenetConfig(java.lang.String applicationId)
Get the FilenetConfig configuration object.
  1. static
  2. FilenetConfig
 getFilenetConfig(java.lang.String applicationId,java.lang.String id)
Get the FilenetConfig configuration object.
  1. static
  2. FileTypeConfig
 getFileTypeConfig(java.lang.String applicationId,java.lang.String fileType)
Get the FileTypeConfig configuration object.
  1. static
  2. IconConfig
 getIconConfig(java.lang.String applicationId,java.lang.String iconId)
Get the IconConfig configuration object.
  1. static
  2. IconStatusConfig
 getIconStatusConfig(java.lang.String applicationId,java.lang.String iconId)
Get the IconStatusConfig configuration object.
  1. static
  2. IdLabelConfig
 getIdLabelConfig(java.lang.String applicationId,java.lang.String id)
Get the IdLabelConfig configuration object.
  1. static
  2. InterfaceTextConfig
 getInterfaceTextConfig(java.lang.String applicationId,java.lang.String interfaceTextId)
Get the InterfaceTextConfig configuration object.
  1. static
  2. InterfaceTextLocaleConfig
 getInterfaceTextLocaleConfig(java.lang.String applicationId,java.lang.String interfaceTextId)
Get the InterfaceTextLocaleConfig configuration object.
  1. static
  2. java.lang.String
 getJDBCVersion()
Get the JDBC version
  1. static
  2. LocaleConfig
 getLocaleConfig(java.lang.String applicationId,java.lang.String id)
Get the LocaleConfig configuration object.
  1. static
  2. MenuConfig
 getMenuConfig(java.lang.String applicationId,java.lang.String menuId,boolean... flags)
Get the MenuConfig configuration object.
  1. static
  2. MenuTypeConfig
 getMenuTypeConfig(java.lang.String applicationId,java.lang.String menuTypeId,boolean... flags)
Get the MenuTypeConfig configuration object.
  1. static
  2. MobileFeatureConfig
 getMobileFeatureConfig(java.lang.String applicationId,java.lang.String id)
Get the MobileFeatureConfig configuration object.
  1. static
  2. ODLoginConfig
 getODLoginConfig(java.lang.String applicationId,java.lang.String repositoryId)
Get the ODLoginConfig configuration object.
  1. static
  2. OfficeCustomCommandConfig
 getOfficeCustomCommandConfig(java.lang.String applicationId,java.lang.String id)
  1. static
  2. PluginConfig
 getPluginConfig(java.lang.String applicationId,java.lang.String pluginId)
Get the PluginConfig configuration object.
  1. static
  2. 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
  1. static
  2. PropertyMappingConfig
 getPropertyMappingConfig(java.lang.String applicationId,java.lang.String id)
Get the PropertyMappingConfig configuration object.
  1. static
  2. RecentItemConfig
 getRecentItemConfig(java.lang.String applicationId,java.lang.String id)
Get the RecentItemConfig configuration object.
  1. static
  2. RecentSearchConfig
 getRecentSearchConfig(java.lang.String applicationId,java.lang.String id)
Get the RecentSearchConfig configuration object.
  1. static
  2. RecentTeamspaceConfig
 getRecentTeamspaceConfig(java.lang.String applicationId,java.lang.String id)
Get the RecentTeamspaceConfig configuration object.
  1. static
  2. RepositoryConfig
 getRepositoryConfig(javax.servlet.http.HttpServletRequest request)
Get a repository definition out of the desktop definitions.
  1. static
  2. RepositoryConfig
 getRepositoryConfig(java.lang.String applicationId,java.lang.String repositoryId)
Get the RepositoryConfig configuration object.
  1. static
  2. RepositoryConfig
 getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request)
Does this desktop has this repository in it.
  1. static
  2. RepositoryConfig
 getRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request,java.lang.String repositoryId)
Get a repository definition out of the desktop definitions.
  1. static
  2. ServerConfig
 getServerConfig(javax.servlet.http.HttpServletRequest request)
Get a server definition out of the repository definitions.
  1. static
  2. ServerConfig
 getServerConfig(java.lang.String applicationId,java.lang.String serverId)
Get the ServerConfig configuration object.
  1. static
  2. SettingsConfig
 getSettingsConfig(java.lang.String applicationId)
Get the SettingsConfig configuration object.
  1. static
  2. SettingsConfig
 getSettingsConfig(java.lang.String applicationId,java.lang.String id)
Get the SettingsConfig configuration object.
  1. static
  2. SyncConfig
 getSyncConfig(java.lang.String applicationId)
Get the SyncConfig configuration object.
  1. static
  2. ThemeConfig
 getThemeConfig(java.lang.String applicationId,java.lang.String themeId)
Get the ThemeConfig configuration object.
  1. static
  2. UserActionMacroConfig
 getUserActionMacroConfig(java.lang.String applicationId,java.lang.String userAction)
Get the UserActionMacroConfig configuration object.
  1. static
  2. UserConfig
 getUserConfig(java.lang.String applicationId,java.lang.String userId)
Get the UserConfig configuration object.
  1. static
  2. UserGroupConfig
 getUserGroupConfig(java.lang.String applicationId,java.lang.String id)
Get the UserGroupConfig configuration object.
  1. static
  2. ViewerConfig
 getViewerConfig(java.lang.String applicationId,java.lang.String viewerId)
Get the ViewerConfig configuration object.
  1. static
  2. ViewerDefConfig
 getViewerDefConfig(java.lang.String applicationId,java.lang.String viewerDefId)
Get the ViewerDefConfig configuration object.
  1. static
  2. ViewerMappingConfig
 getViewerMappingConfig(java.lang.String applicationId,java.lang.String viewerMappingId)
Get the ViewerMappingConfig configuration object.
  1. static
  2. ViewOneConfig
 getViewOneConfig(java.lang.String applicationId)
Get the ViewOneConfig configuration object.
  1. static
  2. ViewOneConfig
 getViewOneConfig(java.lang.String applicationId,java.lang.String id)
Get the ViewOneConfig configuration object.
  1. static
  2. boolean
 hasRepositoryConfigUsingIdOrServerName(javax.servlet.http.HttpServletRequest request,java.lang.String repositoryId)
Does this desktop has this repository in it.
  1. static
  2. void
 initialize(java.lang.String enablePropertiesConfig,java.lang.String propertiesFileName,java.lang.String userDefinedSchema,java.lang.String userDefinedJNDI)
Initialize access to configuration.
  1. static
  2. void
 reconnectToDB()
Reconnect to DB after DB timeout.
  1. static
  2. boolean
 removeConfigurationFromCache(ConfigurationObject config)
Remove configuration object from the DB/Properties.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LIST_DELIMITER

  1. public static final char LIST_DELIMITER
See Also:
Constant Field Values

ENCODING_UTF8

  1. public static final java.lang.String ENCODING_UTF8
See Also:
Constant Field Values

APPLICATION_NAME

  1. public static final java.lang.String APPLICATION_NAME
See Also:
Constant Field Values

myMap

  1. public static java.util.Map myMap

Constructor Detail

Config

  1. public Config()

Method Detail

initialize

  1. public static void initialize(java.lang.String enablePropertiesConfig,
  2. java.lang.String propertiesFileName,
  3. java.lang.String userDefinedSchema,
  4. java.lang.String userDefinedJNDI)
  5. 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 configuraiton file.
userDefinedSchema - - A string value of DB schema name.
userDefinedJNDI - - A string value of user defined JNDI otherwise default of "java:comp/env/jdbc/CIWEBDS" will be use if this value is null.
Throws:
java.lang.Exception

getConfigurationType

  1. public static Config.CONFIGURATION_TYPE getConfigurationType( )
Return configuration type back.
Returns:
a enum of either properties or database

reconnectToDB

  1. public static void reconnectToDB( )
  2. throws java.lang.Exception
Reconnect to DB after DB timeout.
Throws:
java.lang.Exception

getApplicationConfig

  1. public static ApplicationConfig getApplicationConfig( java.lang.String applicationId)
  2. throws org.apache.commons.configuration.ConfigurationException
  3. 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

  1. public static DesktopConfig getDesktopConfig( java.lang.String applicationId,
  2. java.lang.String desktopId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static ViewOneConfig getViewOneConfig( java.lang.String applicationId)
  2. throws org.apache.commons.configuration.ConfigurationException
  3. 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

  1. public static ViewOneConfig getViewOneConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static FilenetConfig getFilenetConfig( java.lang.String applicationId)
  2. throws org.apache.commons.configuration.ConfigurationException
  3. 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

  1. public static FilenetConfig getFilenetConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getDesktopAccessConfig

  1. public static DesktopAccessConfig getDesktopAccessConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getSyncConfig

  1. public static SyncConfig getSyncConfig( java.lang.String applicationId)
  2. throws org.apache.commons.configuration.ConfigurationException
  3. 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

  1. public static SettingsConfig getSettingsConfig( java.lang.String applicationId)
  2. throws org.apache.commons.configuration.ConfigurationException
  3. 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

  1. public static SettingsConfig getSettingsConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getInterfaceTextConfig

  1. public static InterfaceTextConfig getInterfaceTextConfig( java.lang.String applicationId,
  2. java.lang.String interfaceTextId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static InterfaceTextLocaleConfig getInterfaceTextLocaleConfig( java.lang.String applicationId,
  2. java.lang.String interfaceTextId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static ViewerConfig getViewerConfig( java.lang.String applicationId,
  2. java.lang.String viewerId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static ViewerDefConfig getViewerDefConfig( java.lang.String applicationId,
  2. java.lang.String viewerDefId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static ViewerMappingConfig getViewerMappingConfig( java.lang.String applicationId,
  2. java.lang.String viewerMappingId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static LocaleConfig getLocaleConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static IdLabelConfig getIdLabelConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static UserGroupConfig getUserGroupConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static IconConfig getDefaultIconConfig( java.lang.String iconId)
  2. throws org.apache.commons.configuration.ConfigurationException
  3. 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

  1. public static IconConfig getIconConfig( java.lang.String applicationId,
  2. java.lang.String iconId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static FileTypeConfig getFileTypeConfig( java.lang.String applicationId,
  2. java.lang.String fileType)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static PropertyMappingConfig getPropertyMappingConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getMobileFeatureConfig

  1. public static MobileFeatureConfig getMobileFeatureConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static DesktopFeatureConfig getDesktopFeatureConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static OfficeCustomCommandConfig getOfficeCustomCommandConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. MissingValueException
Throws:
org.apache.commons.configuration.ConfigurationException
MissingValueException
Since:
2.0.3

getUserActionMacroConfig

  1. public static UserActionMacroConfig getUserActionMacroConfig( java.lang.String applicationId,
  2. java.lang.String userAction)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static IconStatusConfig getIconStatusConfig( java.lang.String applicationId,
  2. java.lang.String iconId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static RepositoryConfig getRepositoryConfig( java.lang.String applicationId,
  2. java.lang.String repositoryId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. MissingValueException
Get the RepositoryConfig configuration object.
Parameters:
applicationId - - A string value of application id, for example "navigator".
Returns:
a RepositoryConfig configuration object.
Throws:
org.apache.commons.configuration.ConfigurationException
MissingValueException

getServerConfig

  1. public static ServerConfig getServerConfig( java.lang.String applicationId,
  2. java.lang.String serverId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static MenuConfig getMenuConfig( java.lang.String applicationId,
  2. java.lang.String menuId,
  3. boolean... flags)
  4. throws org.apache.commons.configuration.ConfigurationException
  5. 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

  1. public static MenuTypeConfig getMenuTypeConfig( java.lang.String applicationId,
  2. java.lang.String menuTypeId,
  3. boolean... flags)
  4. throws org.apache.commons.configuration.ConfigurationException
  5. 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

  1. public static PluginConfig getPluginConfig( java.lang.String applicationId,
  2. java.lang.String pluginId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static ThemeConfig getThemeConfig( java.lang.String applicationId,
  2. java.lang.String themeId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getFavoriteConfig

  1. public static FavoriteConfig getFavoriteConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static FavoriteConfig getFavoriteConfig( java.lang.String applicationId,
  2. java.lang.String id,
  3. boolean skipCaching)
  4. throws org.apache.commons.configuration.ConfigurationException
  5. 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

getUserConfig

  1. public static UserConfig getUserConfig( java.lang.String applicationId,
  2. java.lang.String userId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. MissingValueException
Get the UserConfig configuration object.
Parameters:
applicationId - - A string value of application id, for example "navigator".
userId - - A string value of id
Returns:
a UserConfig configuration object.
Throws:
org.apache.commons.configuration.ConfigurationException
MissingValueException

getPluginUserConfig

  1. public static PluginUserConfig getPluginUserConfig( java.lang.String applicationId,
  2. java.lang.String userId,
  3. java.lang.String pluginId,
  4. java.lang.String key)
  5. throws org.apache.commons.configuration.ConfigurationException
  6. 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

  1. public static ODLoginConfig getODLoginConfig( java.lang.String applicationId,
  2. java.lang.String repositoryId)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

  1. public static RecentSearchConfig getRecentSearchConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getRecentItemConfig

  1. public static RecentItemConfig getRecentItemConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getRecentTeamspaceConfig

  1. public static RecentTeamspaceConfig getRecentTeamspaceConfig( java.lang.String applicationId,
  2. java.lang.String id)
  3. throws org.apache.commons.configuration.ConfigurationException
  4. 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

getApplicationConfig

  1. 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.

getDesktopConfig

  1. 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

  1. 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

  1. public static RepositoryConfig getRepositoryConfigUsingIdOrServerName( javax.servlet.http.HttpServletRequest request,
  2. java.lang.String repositoryId)
Get a repository definition out of the desktop definitions.
Parameters:
request - - A HttpServletRequest object.
Returns:
a RepositoryConfig configuration object.

hasRepositoryConfigUsingIdOrServerName

  1. public static boolean hasRepositoryConfigUsingIdOrServerName( javax.servlet.http.HttpServletRequest request,
  2. 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

  1. 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

  1. 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

  1. public static boolean removeConfigurationFromCache( ConfigurationObject config)
Remove configuration object from the DB/Properties.
Parameters:
config - - A ICN configuration object.
Returns:

getConfiguration

  1. public static final org.apache.commons.configuration.AbstractConfiguration getConfiguration( )
Return the configuration object back.
Returns:
a Apache configuraiton object.

getDefaultConfiguration

  1. public static final org.apache.commons.configuration.AbstractConfiguration getDefaultConfiguration( )
Return default configuration object back.
Returns:
a Apache configuration object.

getJDBCVersion

  1. public static java.lang.String getJDBCVersion( )
Get the JDBC version
Returns:
JDBC version number from the DB connection object.

getDatabseName

  1. public static java.lang.String getDatabseName( )
Returns:

getDatabaseSchemaName

  1. public static java.lang.String getDatabaseSchemaName( javax.servlet.ServletContext servletContext)
Return DB schema name.
Parameters:
servletContext - - a ServletContext object.
Returns:
DB schema name.

getDefaultDesktopName

  1. public static java.lang.String getDefaultDesktopName( javax.servlet.http.HttpServletRequest request)
  2. throws org.apache.commons.configuration.ConfigurationException
  3. MissingValueException
Static method to find the current default desktop name
Parameters:
request -
Returns:
Throws:
org.apache.commons.configuration.ConfigurationException
MissingValueException