com.ibm.ecm.configuration

Class ApplicationConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.ApplicationConfig

All Implemented Interfaces:

java.io.Serializable

public class ApplicationConfig
extends ConfigurationObject
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	DEFAULT_THEMES
static java.lang.String	ENCRYPTION_KEY

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

ARRAY_DELIMITER, cloned, configuration, DEFAULT_PROPERTY_VALUE_MAP, ERROR_MISSING_KEY, fromTenant, KEY_DELIMITER, LIST_ESC_CHAR, LIST_SEPARATOR, MODIFIER, PLACEHOLDER_SECRET, properties, returnCopyFromCache

Constructor Summary

Constructors

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 checks if the passed in user Id has administrator access.
boolean	checkPotentialAdminUser(java.lang.String name) This method checks if the name appears within any administrator names.
boolean	containsIgnoreCase(java.util.List<java.lang.String> names, java.lang.String name)
void	exportAdminRoles(javax.servlet.http.HttpServletRequest request, java.io.OutputStreamWriter osw, java.lang.String[] roleIds)
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	exportRedactionReasons(javax.servlet.http.HttpServletRequest request, java.io.OutputStreamWriter osw, java.lang.String[] reasonIds)
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.util.Collection<AdminRoleConfig>	getAdminRoleList(java.lang.String[] ids)
java.lang.String[]	getAdminRolesId()
java.util.Collection<AdminRoleConfig>	getAdminRolesList()
static java.lang.String	getAdminUser(javax.servlet.http.HttpServletRequest request, java.lang.String appName, java.lang.String userId) This method returns the user if userId has permission to access the Navigator administration desktop or feature.
java.lang.String[]	getAllMenuTypeIds()
java.lang.String	getApplicationVersion()
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
java.util.List<ViewerDefConfig>	getDefaultViewerDefs()
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()
DraftDesktopConfig	getDraftDesktop(javax.servlet.http.HttpServletRequest request, java.util.List<java.lang.String> desktopIds)
java.util.Collection<DraftDesktopConfig>	getDraftDesktopList(javax.servlet.http.HttpServletRequest request)
java.util.Collection<DraftDesktopConfig>	getDraftDesktopList(javax.servlet.http.HttpServletRequest request, java.util.List<java.lang.String> desktopIds)
java.lang.String	getEncryptionKey()
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	getMatchingAdminUserName(java.lang.String userId) This method gets the administrator user name if the passed user Id has administrator access.
java.lang.String	getMatchingLimitedAdminUserName(java.lang.String userId) This method gets the administrator user name if the passed user Id has administrator access.
java.lang.String[]	getMenusId()
java.util.Collection<MenuConfig>	getMenusList(javax.servlet.http.HttpServletRequest request)
int	getObjectExpiration()
java.lang.String	getObjectType() Abstract method to return object type.
java.lang.String[]	getPluginsId()
java.util.Collection<PluginConfig>	getPluginsList()
java.util.Collection<PluginConfig>	getPluginsList(java.lang.String[] ids)
java.util.Collection<RedactionReasonConfig>	getRedactionReasonList()
java.util.Collection<RedactionReasonConfig>	getRedactionReasonList(java.lang.String[] ids)
java.lang.String[]	getRedactionReasonsId()
java.util.Collection<RedactionReasonConfig>	getRedactionReasonsList(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)
static boolean	isAdminUser(javax.servlet.http.HttpServletRequest request, java.lang.String appName, java.lang.String userId) This method checks if userId has permission to access the Navigator administration desktop or feature.
static boolean	isEnableLdapAdminGroupPlugin()
boolean	isRedactionReasonsInitialized()
void	load() Initializes the superclass default property values map.
boolean	namesContainName(java.util.List<java.lang.String> names, java.lang.String name)
static boolean	potentialAdminUser(javax.servlet.http.HttpServletRequest request, java.lang.String appName, java.lang.String userId) This method checks if the login userId might have permission to access the Navigator administration desktop or feature.
protected void	resetNonTenantSettings()
void	setAdminRolesId(java.lang.String[] ids)
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	setRedactionReasonsId(java.lang.String[] ids)
void	setRedactionReasonsInitialized(boolean initialized)
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

addIdNameToJSONModel, addValueToList, arrayToString, arrayToString, clone, covertEmptyStringtoNull, createJSONModelField, createJSONModelToggleField, createJSONModelValidationField, delete, dump, fromJSONModel, getBooleanPropertyValue, getConfigurationObject, getDataTypeValue, getDoublePropertyValue, getIdPrefix, getIntPropertyValue, getKey, getLongPropertyValue, getMap, getName, getObjectId, getObjectIdAlias, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, hasProperties, isEmpty, isNew, performSyncedUpdate, propertiesToString, removeValuesFromList, removeValuesFromList, returnCopyFromCache, save, setDefaultValue, setProperties, setProperty, setValues, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toJSON, toJSONModel, toString, validate, validateObjectId, writeConfigurationToFile

Methods inherited from class java.lang.Object

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

Field Detail

ENCRYPTION_KEY

public static final java.lang.String ENCRYPTION_KEY

See Also:

Constant Field Values

DEFAULT_THEMES

public static final java.util.List<java.lang.String> DEFAULT_THEMES

Constructor Detail

ApplicationConfig

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

Method Detail

load

public void load()

Initializes the superclass default property values map.

Overrides:

load in class ConfigurationObject

Since:

2.0.3.8

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

Parameters:

key - ths name of the property

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()

getDraftDesktopList

public java.util.Collection<DraftDesktopConfig> getDraftDesktopList(javax.servlet.http.HttpServletRequest request)

getDraftDesktop

public DraftDesktopConfig getDraftDesktop(javax.servlet.http.HttpServletRequest request,
                                          java.util.List<java.lang.String> desktopIds)

getDraftDesktopList

public java.util.Collection<DraftDesktopConfig> getDraftDesktopList(javax.servlet.http.HttpServletRequest request,
                                                                    java.util.List<java.lang.String> desktopIds)

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)

setRedactionReasonsId

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

setAdminRolesId

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

Since:

3.0.2

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)

getAllMenuTypeIds

public java.lang.String[] getAllMenuTypeIds()

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)

getRedactionReasonsList

public java.util.Collection<RedactionReasonConfig> getRedactionReasonsList(java.lang.String[] ids)

getThemesId

public java.lang.String[] getThemesId()

getAdminRolesId

public java.lang.String[] getAdminRolesId()

Since:

3.0.2

getRedactionReasonsId

public java.lang.String[] getRedactionReasonsId()

Returns:

Since:

2.0.3.8

isRedactionReasonsInitialized

public boolean isRedactionReasonsInitialized()

Returns:

Since:

2.0.3.8

setRedactionReasonsInitialized

public void setRedactionReasonsInitialized(boolean initialized)

Parameters:

initialized -

Since:

2.0.3.8

getThemesList

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

Returns:

Since:

2.0.3

getRedactionReasonList

public java.util.Collection<RedactionReasonConfig> getRedactionReasonList()

Returns:

Since:

2.0.3.8

getRedactionReasonList

public java.util.Collection<RedactionReasonConfig> getRedactionReasonList(java.lang.String[] ids)

Returns:

Since:

2.0.3.8

getAdminRolesList

public java.util.Collection<AdminRoleConfig> getAdminRolesList()

Returns:

Since:

3.0.3

getAdminRoleList

public java.util.Collection<AdminRoleConfig> getAdminRoleList(java.lang.String[] ids)

Returns:

Since:

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

getDefaultViewerDefs

public java.util.List<ViewerDefConfig> getDefaultViewerDefs()

Since:

3.0.12

checkAdminAccessForUser

public boolean checkAdminAccessForUser(java.lang.String userId)

This method checks if the passed in user Id has administrator access. Administrator access is granted if the user Id (which may include the domain) fully matches a name in the application administrator list. If a name in the administrator list is just the user name (domain information not included), then just the user name is extracted from the user Id and compared against the administrator list name (legacy behavior).

Parameters:

userId -

Returns:

boolean

getMatchingAdminUserName

public java.lang.String getMatchingAdminUserName(java.lang.String userId)

This method gets the administrator user name if the passed user Id has administrator access.

Parameters:

userId -

Returns:

String

getMatchingLimitedAdminUserName

public java.lang.String getMatchingLimitedAdminUserName(java.lang.String userId)

This method gets the administrator user name if the passed user Id has administrator access.

Parameters:

userId -

Returns:

String

containsIgnoreCase

public boolean containsIgnoreCase(java.util.List<java.lang.String> names,
                                  java.lang.String name)

checkPotentialAdminUser

public boolean checkPotentialAdminUser(java.lang.String name)

This method checks if the name appears within any administrator names. If it does, the login name may be an admin user name. We won't know for sure until after the login and we have the full login name.

Parameters:

name -

Returns:

boolean

namesContainName

public boolean namesContainName(java.util.List<java.lang.String> names,
                                java.lang.String name)

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.lang.Exception

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.lang.Exception

exportRepositories

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

Throws:

java.lang.Exception

exportAdminRoles

public void exportAdminRoles(javax.servlet.http.HttpServletRequest request,
                             java.io.OutputStreamWriter osw,
                             java.lang.String[] roleIds)
                      throws java.lang.Exception

Throws:

java.lang.Exception

Since:

3.0.2

exportRedactionReasons

public void exportRedactionReasons(javax.servlet.http.HttpServletRequest request,
                                   java.io.OutputStreamWriter osw,
                                   java.lang.String[] reasonIds)
                            throws java.lang.Exception

Throws:

java.lang.Exception

exportPlugins

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

Throws:

java.lang.Exception

exportThemes

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

Throws:

java.lang.Exception

isAdminUser

public static boolean isAdminUser(javax.servlet.http.HttpServletRequest request,
                                  java.lang.String appName,
                                  java.lang.String userId)

This method checks if userId has permission to access the Navigator administration desktop or feature.

Parameters:

request - HttpServletRequest that provides the application name

appName - The application name.

userId - The user Id that will be checked against administrator names (contains check).

Returns:

Returns true if userId has administrator access.

isEnableLdapAdminGroupPlugin

public static boolean isEnableLdapAdminGroupPlugin()

getAdminUser

public static java.lang.String getAdminUser(javax.servlet.http.HttpServletRequest request,
                                            java.lang.String appName,
                                            java.lang.String userId)

This method returns the user if userId has permission to access the Navigator administration desktop or feature.

Parameters:

request - HttpServletRequest that provides the application name

appName - The application name.

userId - The user Id that will be checked against administrator names (contains check).

Returns:

Returns user name if userId has administrator access.

potentialAdminUser

public static boolean potentialAdminUser(javax.servlet.http.HttpServletRequest request,
                                         java.lang.String appName,
                                         java.lang.String userId)

This method checks if the login userId might have permission to access the Navigator administration desktop or feature. The full user Id will not be known until after login, and the full user Id may or may not be found in the administrators list.

Parameters:

request - HttpServletRequest that provides the application name

appName - The application name.

userId - The user Id that will be checked against administrator names (contains check).

Returns:

Returns true if userId has administrator access.

resetNonTenantSettings

protected void resetNonTenantSettings()
                               throws org.apache.commons.configuration.ConfigurationException

Overrides:

resetNonTenantSettings in class ConfigurationObject

Throws:

org.apache.commons.configuration.ConfigurationException

Since:

3.0.12