com.ibm.ecm.configuration

Class ApplicationConfig

java.lang.Object
com.ibm.ecm.configuration.ConfigurationObject
com.ibm.ecm.configuration.ApplicationConfig

public class ApplicationConfig
extends ConfigurationObject

Field Summary

Modifier and Type	Field and Description
static java.lang.String	`ENCRYPTION_KEY`

Fields inherited from class com.ibm.ecm.configuration.ConfigurationObject
`ARRAY_DELIMITER, cloned, KEY_DELIMITER, LIST_ESC_CHAR, LIST_ESCAPE, LIST_SEPARATOR, MODIFIER, properties`

Constructor Summary

Constructor and Description
`ApplicationConfig(org.apache.commons.configuration.Configuration configuration,java.lang.String idPrefix,java.lang.String id)`

Method Summary

Modifier and Type	Method and Description
boolean	`checkAdminAccessForUser(java.lang.String userid)` This method needs to be implemented by the admin team to check the use has the rights to access the Admin application.
boolean	`containsIgnoreCase(java.util.List<java.lang.String> l,java.lang.String s)`
void	`exportDesktops(javax.servlet.http.HttpServletRequest request,java.io.OutputStreamWriter osw,java.lang.String[] desktopIds,java.lang.String[] repositoryIds,java.lang.String[] pluginIds,boolean includeSecurity)` This method exports selected desktops and its associated object.
void	`exportPlugins(javax.servlet.http.HttpServletRequest request,java.io.OutputStreamWriter osw,java.lang.String[] pluginIds)`
void	`exportRepositories(javax.servlet.http.HttpServletRequest request,java.io.OutputStreamWriter osw,java.lang.String[] repositoryIds)`
void	`exportThemes(javax.servlet.http.HttpServletRequest request,java.io.OutputStreamWriter osw,java.lang.String[] themeIds)`
java.lang.String	`getApplicationVersion()`
protected java.lang.Class	`getDataType(java.lang.String key)`
DesktopConfig	`getDesktop()`
java.util.Collection<DesktopConfig>	`getDesktopList()`
java.util.Collection<DesktopConfig>	`getDesktopList(javax.servlet.http.HttpServletRequest request)`
java.util.Collection<DesktopConfig>	`getDesktopList(javax.servlet.http.HttpServletRequest request,java.lang.String[] desktopsId)`
java.lang.String	`getDesktopName()`
java.lang.String[]	`getDesktopsId()`
java.lang.String	`getEncryptionKey()`
java.util.Collection<IconStatusConfig>	`getIconStatusList()`
java.util.Collection	`getList(java.lang.String type,java.lang.String appName,javax.servlet.http.HttpServletRequest request)` appName is not used in this case, since it is application config object.
java.lang.String[]	`getLocales()` Add additional locale here for upgrading beside added it to the SQL files.
java.lang.String[]	`getLocalizeSettings()`
java.lang.String[]	`getMenusId()`
java.util.Collection<MenuConfig>	`getMenusList(javax.servlet.http.HttpServletRequest request)`
int	`getObjectExpiration()`
java.lang.String	`getObjectType()`
java.lang.String[]	`getPluginsId()`
java.util.Collection<PluginConfig>	`getPluginsList()`
java.util.Collection<PluginConfig>	`getPluginsList(java.lang.String[] ids)`
java.lang.String[]	`getRepositoriesId()`
java.util.Collection<RepositoryConfig>	`getRepositoriesList()`
java.util.Collection<RepositoryConfig>	`getRepositoriesList(java.lang.String[] ids)`
java.lang.String[]	`getServersId()`
java.util.Collection<ServerConfig>	`getServersList()`
SettingsConfig	`getSettingsConfig()`
SyncConfig	`getSyncConfig()`
java.lang.String[]	`getThemesId()`
java.util.Collection<ThemeConfig>	`getThemesList()`
java.util.Collection<ThemeConfig>	`getThemesList(java.lang.String[] ids)`
int	`getThreadSleepTime()`
java.lang.String[]	`getViewersId()`
java.util.Collection<ViewerConfig>	`getViewersList(javax.servlet.http.HttpServletRequest request)`
void	`setApplicationVersion(java.lang.String version)`
void	`setDesktopName(java.lang.String desktop)`
void	`setDesktopsId(java.lang.String[] ids)`
void	`setEncryptionKey(java.lang.String key)`
void	`setMenusId(java.lang.String[] ids)`
void	`setObjectExpiration(int expirationTime)`
void	`setPluginsId(java.lang.String[] ids)`
void	`setRepositoriesId(java.lang.String[] ids)`
void	`setThemesId(java.lang.String[] ids)`
void	`setThreadSleepTime(int sleepTime)`
void	`setViewersId(java.lang.String[] ids)`

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject
`addValueToList, arrayToString, covertEmptyStringtoNull, delete, dump, getConfigurationObject, getDataTypeValue, getIdPrefix, getKey, getMap, getName, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, isEmpty, load, propertiesToString, removeValuesFromList, removeValuesFromList, save, setDefaultValue, setProperty, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toString, writeConfigurationToFile`

Methods inherited from class com.ibm.ecm.configuration.ConfigurationObject

addValueToList, arrayToString, covertEmptyStringtoNull, delete, dump, getConfigurationObject, getDataTypeValue, getIdPrefix, getKey, getMap, getName, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, isEmpty, load, propertiesToString, removeValuesFromList, removeValuesFromList, save, setDefaultValue, setProperty, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toString, writeConfigurationToFile

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

ENCRYPTION_KEY

public static final java.lang.String ENCRYPTION_KEY

Constructor Detail

ApplicationConfig

public ApplicationConfig(org.apache.commons.configuration.Configuration configuration,
java.lang.String idPrefix,
java.lang.String id)

Method Detail

getObjectType

public java.lang.String getObjectType( )

Description copied from class: ConfigurationObject

Abstract method to return object type.

Specified by:

getObjectType in class ConfigurationObject

Returns:

a string object type back, for example "desktop", "repository"...

getDataType

protected java.lang.Class getDataType( java.lang.String key)

Description copied from class: ConfigurationObject

Returns the datatype of a configuration property. This is implemented in subclasses and is used to properly serialize the properties. The default implementation returns null which indicates that compatible behavior should be used, which inspects the property value itself and guesses at the type of the property.

Overrides:

getDataType in class ConfigurationObject

Returns:

a Class instance describing the datatype of the property.

getThreadSleepTime

public int getThreadSleepTime()

setThreadSleepTime

public void setThreadSleepTime( int sleepTime)

getObjectExpiration

public int getObjectExpiration( )

setObjectExpiration

public void setObjectExpiration( int expirationTime)

getList

public java.util.Collection getList( java.lang.String type,
java.lang.String appName,
javax.servlet.http.HttpServletRequest request)

appName is not used in this case, since it is application config object.

Overrides:

getList in class ConfigurationObject

Parameters:

type - - A string value of object type.

appName - - A string value of application name.

request - - A HttpServletRequest object.

Returns:

a collection of type.

getDesktopsId

public java.lang.String[] getDesktopsId( )

setDesktopsId

public void setDesktopsId(java.lang.String[] ids)

getDesktopList

public java.util.Collection<DesktopConfig> getDesktopList( javax.servlet.http.HttpServletRequest request)

getDesktopList

public java.util.Collection<DesktopConfig> getDesktopList( javax.servlet.http.HttpServletRequest request,
java.lang.String[] desktopsId)

getDesktopList

public java.util.Collection<DesktopConfig> getDesktopList( )

getRepositoriesId

public java.lang.String[] getRepositoriesId( )

setRepositoriesId

public void setRepositoriesId(java.lang.String[] ids)

getRepositoriesList

public java.util.Collection<RepositoryConfig> getRepositoriesList( )

getRepositoriesList

public java.util.Collection<RepositoryConfig> getRepositoriesList( java.lang.String[] ids)

getViewersId

public java.lang.String[] getViewersId( )

setViewersId

public void setViewersId(java.lang.String[] ids)

setPluginsId

public void setPluginsId(java.lang.String[] ids)

setThemesId

public void setThemesId(java.lang.String[] ids)

setMenusId

public void setMenusId(java.lang.String[] ids)

getViewersList

public java.util.Collection<ViewerConfig> getViewersList( javax.servlet.http.HttpServletRequest request)

getServersId

public java.lang.String[] getServersId( )

getServersList

public java.util.Collection<ServerConfig> getServersList( )

getMenusId

public java.lang.String[] getMenusId( )

getMenusList

public java.util.Collection<MenuConfig> getMenusList( javax.servlet.http.HttpServletRequest request)

getLocales

public java.lang.String[] getLocales( )

Add additional locale here for upgrading beside added it to the SQL files.

Returns:

a array of locale

getLocalizeSettings

public java.lang.String[] getLocalizeSettings( )

getPluginsId

public java.lang.String[] getPluginsId( )

getPluginsList

public java.util.Collection<PluginConfig> getPluginsList( )

getPluginsList

public java.util.Collection<PluginConfig> getPluginsList( java.lang.String[] ids)

getThemesId

public java.lang.String[] getThemesId( )

getThemesList

public java.util.Collection<ThemeConfig> getThemesList( )

Returns:

Since:

2.0.3

getThemesList

public java.util.Collection<ThemeConfig> getThemesList( java.lang.String[] ids)

Returns:

Since:

2.0.3

getDesktop

public DesktopConfig getDesktop( )

getDesktopName

public java.lang.String getDesktopName( )

setDesktopName

public void setDesktopName(java.lang.String desktop)

getEncryptionKey

public java.lang.String getEncryptionKey( )

setEncryptionKey

public void setEncryptionKey(java.lang.String key)

getApplicationVersion

public java.lang.String getApplicationVersion( )

setApplicationVersion

public void setApplicationVersion( java.lang.String version)

getSettingsConfig

public SettingsConfig getSettingsConfig( )

getSyncConfig

public SyncConfig getSyncConfig( )

Since:

2.0.3

getIconStatusList

public java.util.Collection<IconStatusConfig> getIconStatusList( )

checkAdminAccessForUser

public boolean checkAdminAccessForUser( java.lang.String userid)

This method needs to be implemented by the admin team to check the use has the rights to access the Admin application.

Parameters:

userid -

Returns:

Throws:

MissingValueException

org.apache.commons.configuration.ConfigurationException

containsIgnoreCase

public boolean containsIgnoreCase( java.util.List<java.lang.String> l,
java.lang.String s)

exportDesktops

public void exportDesktops(javax.servlet.http.HttpServletRequest request,
java.io.OutputStreamWriter osw,
java.lang.String[] desktopIds,
java.lang.String[] repositoryIds,
java.lang.String[] pluginIds,
boolean includeSecurity)
throws java.io.IOException
java.io.FileNotFoundException

This method exports selected desktops and its associated object. Desktop security won't be exported if plugin where the default data source defined wasn't included in the export. Likewise, security won't be exported if default repository wasn't exported.

Parameters:

request - Request object

osw - Output Input stream to carry all the export content.

desktopIds - String array of desktop id

repositoryIds - String array of repository id

pluginIds - String array of plugin id

includeSecurity - boolean flag to include or exclude desktop's security

Throws:

java.io.IOException

java.io.FileNotFoundException

exportRepositories

public void exportRepositories( javax.servlet.http.HttpServletRequest request,
java.io.OutputStreamWriter osw,
java.lang.String[] repositoryIds)
throws java.io.IOException
java.io.FileNotFoundException

Throws:

java.io.IOException

java.io.FileNotFoundException

exportPlugins

public void exportPlugins(javax.servlet.http.HttpServletRequest request,
java.io.OutputStreamWriter osw,
java.lang.String[] pluginIds)
throws java.io.IOException
java.io.FileNotFoundException

Throws:

java.io.IOException

java.io.FileNotFoundException

exportThemes

public void exportThemes(javax.servlet.http.HttpServletRequest request,
java.io.OutputStreamWriter osw,
java.lang.String[] themeIds)
throws java.io.IOException
java.io.FileNotFoundException

Throws:

java.io.IOException

java.io.FileNotFoundException