com.ibm.ecm.configuration

Class SettingsConfig

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

public class SettingsConfig
extends ConfigurationObject

Field Summary

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

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
`SettingsConfig(org.apache.commons.configuration.Configuration configuration,java.lang.String idPrefix,java.lang.String id)`

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	`getAdminUsers()`
java.util.List<java.lang.String>	`getAdminUsersList()`
int	`getCMCTTL()` Content Engine metadata cache time to live (CMC_TIME_TO_LIVE) unit in second therefore you need to multiply 1000 to be milliseconds.
boolean	`getCulturalCollation()`
java.lang.String	`getCustomProperties()`
boolean	`getDaejaRedactionTrace()`
boolean	`getDaejaRedactionTraceNet()`
boolean	`getDaejaStreamerTrace()`
boolean	`getDaejaStreamerTraceNet()`
boolean	`getDaejaViewONEProTrace()`
boolean	`getDaejaViewONEProTraceAnnotations()`
boolean	`getDaejaViewONEProTraceNet()`
boolean	`getDaejaVirtualTrace()`
boolean	`getDaejaVirtualTraceAnnotations()`
boolean	`getDaejaVirtualTraceNet()`
protected java.lang.Class	`getDataType(java.lang.String key)`
java.lang.String	`getDeajeRedactionLogFile()`
java.lang.String	`getDeajeStreamerLogFile()`
java.lang.String	`getDeajeVirtualLogFile()`
boolean	`getDisableAutocomplete()`
java.lang.String	`getEncryptionKey()`
java.lang.String[]	`getFileTypes()`
java.util.Collection<FileTypeConfig>	`getFileTypesList(java.lang.String appName)`
java.util.Map<java.lang.String,FileTypeConfig>	`getFileTypesMap(java.lang.String appName)`
java.lang.String[]	`getFilterredFileType()`
java.lang.String	`getHelpURL()`
java.lang.String[]	`getIconStatusId()`
java.util.Collection<IconStatusConfig>	`getIconStatusList()`
java.util.Collection	`getList(java.lang.String type,java.lang.String appName,javax.servlet.http.HttpServletRequest request)`
static java.lang.String	`getLocalizedFileTypeLabel(FileTypeConfig fileTypeConfig,java.util.Locale locale)`
java.lang.String	`getLoggingClassExcludes()`
java.lang.String	`getLoggingClassIncludes()`
java.lang.String	`getLoggingDebugHosts()`
java.lang.String	`getLoggingDebugUsers()`
int	`getLoggingLevel()`
<T extends ConfigurationObject> java.lang.String[]	`getMacros(java.lang.Class<T> configClass)`
<T extends ConfigurationObject> java.util.Map<java.lang.String,T>	`getMacrosMap(java.lang.String appName,java.lang.Class<T> configClass)`
java.lang.String	`getObjectType()`
java.lang.String	`getODAfp2pdfInstalldir()`
java.lang.String	`getODLanguage()`
int	`getODMaxTraceFilesize()`
java.lang.String	`getODMaxTraceFilesizeString()`
java.lang.String	`getODTempdir()`
java.lang.String	`getODTracedir()`
int	`getODTracelevel()`
java.lang.String	`getODTracelevelString()`
java.lang.String	`getOfficeLoggingClassExcludes()`
java.lang.String	`getOfficeLoggingClassIncludes()`
java.lang.String	`getOfficeLoggingDebugHosts()`
java.lang.String	`getOfficeLoggingDebugUsers()`
int	`getOfficeLoggingFileSize()`
int	`getOfficeLoggingLevel()`
boolean	`getOfficeLoggingShowStacktraceOnDialogs()`
boolean	`getTaskManagerHeartBeatMonitor()`
java.lang.String	`getTaskManagerLogDirectory()`
java.lang.String	`getTaskManagerServiceEnabled()` Use a string so it can have 3 states.
java.lang.String	`getTaskManagerServiceURL()`
java.lang.String[]	`getUserActionMacros()`
java.util.Collection<UserActionMacroConfig>	`getUserActionMacrosList(java.lang.String appName)`
java.util.Map<java.lang.String,UserActionMacroConfig>	`getUserActionMacrosMap(java.lang.String appName)`
void	`setAdminUsers(java.lang.String[] adminUsers)`
void	`setCMCTTL(int ttl)`
void	`setCulturalCollation(boolean culturalCollation)`
void	`setCustomProperties(java.lang.String customProps)`
void	`setDaejaRedactionLogFile(java.lang.String daejaRedactionLogFile)`
void	`setDaejaRedactionTrace(boolean daejaRedactionTrace)`
void	`setDaejaRedactionTraceNet(boolean daejaRedactionTraceNet)`
void	`setDaejaStreamerLogFile(java.lang.String daejaStreamerLogFile)`
void	`setDaejaStreamerTrace(boolean daejaStreamerTrace)`
void	`setDaejaStreamerTraceNet(boolean daejaStreamerTraceNet)`
void	`setDaejaViewONEProTrace(boolean p8DaejaTrace)`
void	`setDaejaViewONEProTraceAnnotations(boolean p8DaejaTraceAnnotations)`
void	`setDaejaViewONEProTraceNet(boolean p8DaejaTraceNet)`
void	`setDaejaVirtualLogFile(java.lang.String daejaVirtualLogFile)`
void	`setDaejaVirtualTrace(boolean daejaVirtualTrace)`
void	`setDaejaVirtualTraceAnnotations(boolean daejaVirtualTraceAnnotations)`
void	`setDaejaVirtualTraceNet(boolean daejaVirtualTraceNet)`
void	`setDisableAutocomplete(boolean disableAutocomplete)`
void	`setEncryptionKey(java.lang.String key)`
void	`setFileTypes(java.lang.String[] fileTypes)`
void	`setHelpURL(java.lang.String url)`
void	`setLoggingClassExcludes(java.lang.String loggingClassExcludes)`
void	`setLoggingClassIncludes(java.lang.String loggingClassIncludes)`
void	`setLoggingDebugHosts(java.lang.String loggingDebugHosts)`
void	`setLoggingDebugUsers(java.lang.String loggingDebugUsers)`
void	`setLoggingLevel(int loggingLevel)`
void	`setODAfp2pdfInstalldir(java.lang.String afp2pdfInstalldir)`
void	`setODLanguage(java.lang.String language)`
void	`setODMaxTraceFilesize(int maxTraceFilesize)`
void	`setODTempdir(java.lang.String tempdir)`
void	`setODTracedir(java.lang.String tracedir)`
void	`setODTracelevel(int tracelevel)`
void	`setOfficeLoggingClassExcludes(java.lang.String officeLoggingClassExcludes)`
void	`setOfficeLoggingClassIncludes(java.lang.String loggingClassIncludes)`
void	`setOfficeLoggingDebugHosts(java.lang.String officeLoggingDebugHosts)`
void	`setOfficeLoggingDebugUsers(java.lang.String officeLoggingDebugUsers)`
void	`setOfficeLoggingFileSize(int officeLoggingFileSize)`
void	`setOfficeLoggingLevel(int officeLoggingLevel)`
void	`setOficeLoggingShowStacktraceOnDialogs(boolean officeLoggingShowStacktraceOnDialogs)`
void	`setTaskManagerHeartBeatMonitor(boolean enabled)`
void	`setTaskManagerLogDirectory(java.lang.String directory)`
void	`setTaskManagerServiceEnabled(java.lang.String enabled)`
void	`setTaskManagerServiceURL(java.lang.String url)`
void	`setUserActionMacros(java.lang.String[] userActionMacros)`

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

MS_FILE_TYPES

public static final java.lang.String MS_FILE_TYPES

ENCRYPTION_KEY

public static final java.lang.String ENCRYPTION_KEY

Constructor Detail

SettingsConfig

public SettingsConfig(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.

getCMCTTL

public int getCMCTTL()

Content Engine metadata cache time to live (CMC_TIME_TO_LIVE) unit in second therefore you need to multiply 1000 to be milliseconds. Default is 10 hours as in CE.

Returns:

setCMCTTL

public void setCMCTTL(int ttl)

getLoggingClassIncludes

public java.lang.String getLoggingClassIncludes( )

setLoggingClassIncludes

public void setLoggingClassIncludes( java.lang.String loggingClassIncludes)

getTaskManagerServiceURL

public java.lang.String getTaskManagerServiceURL( )

setTaskManagerServiceURL

public void setTaskManagerServiceURL( java.lang.String url)

getTaskManagerLogDirectory

public java.lang.String getTaskManagerLogDirectory( )

setTaskManagerLogDirectory

public void setTaskManagerLogDirectory( java.lang.String directory)

getTaskManagerServiceEnabled

public java.lang.String getTaskManagerServiceEnabled( )

Use a string so it can have 3 states. Empty string for uninitialized and then true/false.

Returns:

setTaskManagerServiceEnabled

public void setTaskManagerServiceEnabled( java.lang.String enabled)

getTaskManagerHeartBeatMonitor

public boolean getTaskManagerHeartBeatMonitor( )

setTaskManagerHeartBeatMonitor

public void setTaskManagerHeartBeatMonitor( boolean enabled)

getHelpURL

public java.lang.String getHelpURL( )

Since:

2.0.3

setHelpURL

public void setHelpURL(java.lang.String url)

Since:

2.0.3

getEncryptionKey

public java.lang.String getEncryptionKey( )

Returns:

Since:

2.0.3

setEncryptionKey

public void setEncryptionKey(java.lang.String key)

Parameters:

key -

Since:

2.0.3

getLoggingClassExcludes

public java.lang.String getLoggingClassExcludes( )

setLoggingClassExcludes

public void setLoggingClassExcludes( java.lang.String loggingClassExcludes)

getLoggingDebugUsers

public java.lang.String getLoggingDebugUsers( )

setLoggingDebugUsers

public void setLoggingDebugUsers( java.lang.String loggingDebugUsers)

getLoggingDebugHosts

public java.lang.String getLoggingDebugHosts( )

setLoggingDebugHosts

public void setLoggingDebugHosts( java.lang.String loggingDebugHosts)

getLoggingLevel

public int getLoggingLevel()

setLoggingLevel

public void setLoggingLevel(int loggingLevel)

getOfficeLoggingClassIncludes

public java.lang.String getOfficeLoggingClassIncludes( )

setOfficeLoggingClassIncludes

public void setOfficeLoggingClassIncludes( java.lang.String loggingClassIncludes)

getOfficeLoggingClassExcludes

public java.lang.String getOfficeLoggingClassExcludes( )

setOfficeLoggingClassExcludes

public void setOfficeLoggingClassExcludes( java.lang.String officeLoggingClassExcludes)

getOfficeLoggingDebugUsers

public java.lang.String getOfficeLoggingDebugUsers( )

setOfficeLoggingDebugUsers

public void setOfficeLoggingDebugUsers( java.lang.String officeLoggingDebugUsers)

getOfficeLoggingDebugHosts

public java.lang.String getOfficeLoggingDebugHosts( )

setOfficeLoggingDebugHosts

public void setOfficeLoggingDebugHosts( java.lang.String officeLoggingDebugHosts)

getOfficeLoggingLevel

public int getOfficeLoggingLevel( )

setOfficeLoggingLevel

public void setOfficeLoggingLevel( int officeLoggingLevel)

getOfficeLoggingShowStacktraceOnDialogs

public boolean getOfficeLoggingShowStacktraceOnDialogs( )

setOficeLoggingShowStacktraceOnDialogs

public void setOficeLoggingShowStacktraceOnDialogs( boolean officeLoggingShowStacktraceOnDialogs)

getOfficeLoggingFileSize

public int getOfficeLoggingFileSize( )

setOfficeLoggingFileSize

public void setOfficeLoggingFileSize( int officeLoggingFileSize)

getDisableAutocomplete

public boolean getDisableAutocomplete( )

setDisableAutocomplete

public void setDisableAutocomplete( boolean disableAutocomplete)

getCulturalCollation

public boolean getCulturalCollation( )

setCulturalCollation

public void setCulturalCollation( boolean culturalCollation)

getIconStatusId

public java.lang.String[] getIconStatusId( )

getIconStatusList

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

getODLanguage

public java.lang.String getODLanguage( )

setODLanguage

public void setODLanguage(java.lang.String language)

getODTempdir

public java.lang.String getODTempdir( )

setODTempdir

public void setODTempdir(java.lang.String tempdir)

getODTracedir

public java.lang.String getODTracedir( )

setODTracedir

public void setODTracedir(java.lang.String tracedir)

getODTracelevelString

public java.lang.String getODTracelevelString( )

getODTracelevel

public int getODTracelevel()

setODTracelevel

public void setODTracelevel(int tracelevel)

getODMaxTraceFilesizeString

public java.lang.String getODMaxTraceFilesizeString( )

getODMaxTraceFilesize

public int getODMaxTraceFilesize( )

setODMaxTraceFilesize

public void setODMaxTraceFilesize( int maxTraceFilesize)

getODAfp2pdfInstalldir

public java.lang.String getODAfp2pdfInstalldir( )

setODAfp2pdfInstalldir

public void setODAfp2pdfInstalldir( java.lang.String afp2pdfInstalldir)

getDaejaViewONEProTrace

public boolean getDaejaViewONEProTrace( )

setDaejaViewONEProTrace

public void setDaejaViewONEProTrace( boolean p8DaejaTrace)

getDaejaViewONEProTraceNet

public boolean getDaejaViewONEProTraceNet( )

setDaejaViewONEProTraceNet

public void setDaejaViewONEProTraceNet( boolean p8DaejaTraceNet)

getDaejaViewONEProTraceAnnotations

public boolean getDaejaViewONEProTraceAnnotations( )

setDaejaViewONEProTraceAnnotations

public void setDaejaViewONEProTraceAnnotations( boolean p8DaejaTraceAnnotations)

getDaejaStreamerTrace

public boolean getDaejaStreamerTrace( )

setDaejaStreamerTrace

public void setDaejaStreamerTrace( boolean daejaStreamerTrace)

getDaejaStreamerTraceNet

public boolean getDaejaStreamerTraceNet( )

setDaejaStreamerTraceNet

public void setDaejaStreamerTraceNet( boolean daejaStreamerTraceNet)

getDeajeStreamerLogFile

public java.lang.String getDeajeStreamerLogFile( )

setDaejaStreamerLogFile

public void setDaejaStreamerLogFile( java.lang.String daejaStreamerLogFile)

getDaejaRedactionTrace

public boolean getDaejaRedactionTrace( )

setDaejaRedactionTrace

public void setDaejaRedactionTrace( boolean daejaRedactionTrace)

getDaejaRedactionTraceNet

public boolean getDaejaRedactionTraceNet( )

setDaejaRedactionTraceNet

public void setDaejaRedactionTraceNet( boolean daejaRedactionTraceNet)

getDeajeRedactionLogFile

public java.lang.String getDeajeRedactionLogFile( )

setDaejaRedactionLogFile

public void setDaejaRedactionLogFile( java.lang.String daejaRedactionLogFile)

getDaejaVirtualTrace

public boolean getDaejaVirtualTrace( )

setDaejaVirtualTrace

public void setDaejaVirtualTrace( boolean daejaVirtualTrace)

getDaejaVirtualTraceNet

public boolean getDaejaVirtualTraceNet( )

setDaejaVirtualTraceNet

public void setDaejaVirtualTraceNet( boolean daejaVirtualTraceNet)

getDaejaVirtualTraceAnnotations

public boolean getDaejaVirtualTraceAnnotations( )

setDaejaVirtualTraceAnnotations

public void setDaejaVirtualTraceAnnotations( boolean daejaVirtualTraceAnnotations)

getDeajeVirtualLogFile

public java.lang.String getDeajeVirtualLogFile( )

setDaejaVirtualLogFile

public void setDaejaVirtualLogFile( java.lang.String daejaVirtualLogFile)

getCustomProperties

public java.lang.String getCustomProperties( )

setCustomProperties

public void setCustomProperties( java.lang.String customProps)

getAdminUsers

public java.lang.String[] getAdminUsers( )

setAdminUsers

public void setAdminUsers(java.lang.String[] adminUsers)

getAdminUsersList

public java.util.List<java.lang.String> getAdminUsersList( )

getFileTypes

public java.lang.String[] getFileTypes( )

getFilterredFileType

public java.lang.String[] getFilterredFileType( )

setFileTypes

public void setFileTypes(java.lang.String[] fileTypes)

getLocalizedFileTypeLabel

public static java.lang.String getLocalizedFileTypeLabel( FileTypeConfig fileTypeConfig,
java.util.Locale locale)

getList

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

Description copied from class: ConfigurationObject

Abstract method that needs to be override in concrete class to a return a collection back by type.

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.

getFileTypesList

public java.util.Collection<FileTypeConfig> getFileTypesList( java.lang.String appName)

getFileTypesMap

public java.util.Map<java.lang.String,FileTypeConfig> getFileTypesMap( java.lang.String appName)

getUserActionMacros

public java.lang.String[] getUserActionMacros( )

setUserActionMacros

public void setUserActionMacros( java.lang.String[] userActionMacros)

getUserActionMacrosList

public java.util.Collection<UserActionMacroConfig> getUserActionMacrosList( java.lang.String appName)

getUserActionMacrosMap

public java.util.Map<java.lang.String,UserActionMacroConfig> getUserActionMacrosMap( java.lang.String appName)

getMacros

public <T extends ConfigurationObject> java.lang.String[] getMacros( java.lang.Class<T> configClass)

getMacrosMap

public <T extends ConfigurationObject> java.util.Map<java.lang.String,T> getMacrosMap( java.lang.String appName,
java.lang.Class<T> configClass)