com.ibm.ecm.configuration

Class ConfigurationObject

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccessRoleConfig, AdminRoleConfig, ApplicationConfig, ConversionConfig, DataKeyConfig, DesktopAccessConfig, DesktopConfig, DesktopFeatureConfig, EditServiceCategoryConfig, EdsConfig, FavoriteConfig, FilenetConfig, FileTypeConfig, IconConfig, IconStatusConfig, IdLabelConfig, InterfaceTextConfig, InterfaceTextLabelConfig, InterfaceTextLocaleConfig, LocaleConfig, MenuConfig, MenuTypeConfig, MobileFeatureConfig, OAuthTokenConfig, ODLoginConfig, OfficeCustomCommandConfig, OfficeOnlineTokenConfig, PluginConfig, PluginUserConfig, PropertyMappingConfig, RecentConfig, RedactionReasonConfig, RedactionReasonUsageConfig, RepositoryConfig, ServerConfig, SettingsConfig, SimpleSearchSettingsConfig, SyncConfig, SyncItemConfig, TenantRegistrationConfig, ThemeConfig, TreeItemConfig, UserActionMacroConfig, UserConfig, UserGroupConfig, ViewerConfig, ViewerContentTypeConfig, ViewerDefConfig, ViewerMappingConfig, ViewOneConfig

public abstract class ConfigurationObject
extends java.lang.Object
implements java.io.Serializable

This is the superclass of all configuration objects, ie, objects stored in the configuration datastore. Subclasses should implement getObjectType and provide getter/setters that use the properties field. ICN stores its configuration data in DB. ICN DB uses ID and ATTRIBUTES two fields in configuration table to store its data. Both ID and ATTRIBUTES field are string type. ID is a key field that can store data up to 256 characters. ICN requires ID to contain only alphanumeric characters. ID has multiple parts. It is separate by "." to form a unique value in DB. The first part is configuration type for example "desktop", "repository". Second part is the application name followed by the ID field in the third part. Therefore "desktop.navigator.default" means this is a desktop configuration using by IBM Navigator application and its ID is "default". ATTRIBUTES a string type field that can hold up to 100M double bytes characters in ICN release 2.0.3. Prior to ICN 2.0.3 this filed can hold 32K of double bytes data. Data stores in this field has serialized properties file format that it has multiple key and value pair and each pair is separated by a separater, ";". In loading time, value in this field will be parsed and stored in a internal properties object by using Apache Common Configuration framework. Saving reverse this process by serialized properties object value to a string then store in the ATTRIBUTES field. setValues(JSONObject, boolean, boolean, boolean) saves fields with MODIFIER. Use Secret for fields that contain secrets. getPropertyValue(String) decrypts secrets before returning and setProperty(String, String) encrypts secrets before setting. toJSON() returns PLACEHOLDER_SECRET instead of secrets and setValues(JSONObject, boolean, boolean, boolean) ignores PLACEHOLDER_SECRET. Use toRawJSON() fromRawJSON(JSONObject) to handle configuration data without processing values.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static char	ARRAY_DELIMITER
protected boolean	cloned
protected org.apache.commons.configuration.Configuration	configuration
protected java.util.Map<java.lang.String,java.lang.String>	DEFAULT_PROPERTY_VALUE_MAP
static java.lang.String	ERROR_MISSING_KEY
protected boolean	fromTenant
protected static char	KEY_DELIMITER
protected static char	LIST_ESC_CHAR
protected static java.lang.String	LIST_SEPARATOR
protected static int	MODIFIER
static java.lang.String	PLACEHOLDER_SECRET
protected java.util.Properties	properties
protected boolean	returnCopyFromCache

Constructor Summary

Constructors

Constructor and Description
ConfigurationObject(org.apache.commons.configuration.Configuration configuration, java.lang.String idPrefix, java.lang.String objectId) Constructor method that it uses configuration type in the concrete subclass, idPrefix and objectID to form a unique key to retrieve from DB in method load.

Method Summary

Modifier and Type	Method and Description
protected void	addIdNameToJSONModel(com.ibm.json.java.JSONObject model, boolean readOnly) Adds the ID and name fields to the JSON model.
void	addValueToList(java.lang.String key, java.lang.String value)
java.lang.String	arrayToString(java.util.List<java.lang.String> list) Convert a list to a string.
java.lang.String	arrayToString(java.lang.String[] array) Convert an array object to a string.
java.lang.Object	clone()
java.lang.String	covertEmptyStringtoNull(java.lang.String value) Utility method to convert a string to null if it is empty.
protected com.ibm.json.java.JSONObject	createJSONModelField(java.lang.Object value, boolean readOnly, boolean disabled) Creates a field for a JSON model used to populate a stateful client-side model.
protected com.ibm.json.java.JSONObject	createJSONModelToggleField(java.lang.Object value, boolean readOnly, boolean disabled, boolean checked) Creates a field with toggle capability for a JSON model used to populate a stateful client-side model.
protected com.ibm.json.java.JSONObject	createJSONModelValidationField(java.lang.Object value, boolean readOnly, boolean disabled, boolean required, java.lang.String pattern) Creates a field with validation for a JSON model used to populate a stateful client-side model.
void	delete() Remove this configuration object from the DB.
void	dump(java.io.OutputStreamWriter osw) Dumps the configuration to the specified output stream (used for logging and export)
void	fromJSONModel(com.ibm.json.java.JSONObject jsonObj, boolean forceUpdate, boolean skipEncoding) Reads a JSON model object and populates the configuration properties.
boolean	getBooleanPropertyValue(java.lang.String key) Return the value back from the properties as a boolean.
org.apache.commons.configuration.Configuration	getConfigurationObject() Return configuration object back.
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
java.lang.Object	getDataTypeValue(java.lang.String field) Returns the field's value as per the field's data type.
double	getDoublePropertyValue(java.lang.String key) Return the value back from the properties as a double.
java.lang.String	getIdPrefix() Return the application name used as ID prefix.
int	getIntPropertyValue(java.lang.String key) Return the value back from the properties as an int.
java.lang.String	getKey() Return the key value back by combined configuration type, ID prefix and ID.
java.util.Collection	getList(java.lang.String type, java.lang.String appName, javax.servlet.http.HttpServletRequest request) Abstract method that needs to be override in concrete class to a return a collection back by type.
long	getLongPropertyValue(java.lang.String key) Return the value back from the properties as a long.
<V extends ConfigurationObject> java.util.Map<java.lang.String,V>	getMap(java.lang.Class<V> configClass, java.lang.String idPrefix, java.lang.String[] ids, boolean... flags) Return a map of configuration object identified by ids field back.
java.lang.String	getName()
java.lang.String	getObjectId() Return the object ID back.
java.lang.String	getObjectIdAlias()
abstract java.lang.String	getObjectType() Abstract method to return object type.
protected java.util.Map<java.lang.String,java.lang.String>	getPropertyNames() Return a map of string of all the fields name in the class where field is a private static final string
java.lang.String	getPropertyValue(java.lang.String key) Return the value back from the properties.
int	getPropertyValue(java.lang.String key, int defaultValue)
long	getPropertyValue(java.lang.String key, long defaultValue)
java.lang.String	getPropertyValue(java.lang.String key, java.lang.String defaultValue)
boolean	hasProperties()
boolean	isEmpty() Deprecated. Use either hasProperties() or isNew() instead.
boolean	isNew()
void	load() Retrieves the latest version from the configuration store.
void	performSyncedUpdate(SyncedUpdateHandlerInterface handler)
protected java.lang.String	propertiesToString(java.util.Properties properties) Serialized properties object value to a string.
void	removeValuesFromList(java.lang.String key, java.util.List<java.lang.String> deleteValues) Remove values from the properties object.
protected void	removeValuesFromList(java.lang.String key, java.util.List<java.lang.String> deleteValues, java.util.Properties props)
protected void	resetNonTenantSettings()
boolean	returnCopyFromCache() Return whether or not a copy of this configuration object should be returned from cache.
void	save() Saves the object back to the configuration store.
protected void	setDefaultValue(java.lang.String propertyName, java.lang.String defaultValue) Set the default value if not found in the properties object
protected void	setProperties(java.util.Properties properties)
void	setProperty(java.lang.String key, java.lang.String value) Store value into properties directly.
void	setValues(com.ibm.json.java.JSONObject json)
void	setValues(com.ibm.json.java.JSONObject json, boolean forceUpdate)
void	setValues(com.ibm.json.java.JSONObject json, boolean forceUpdate, boolean isJSONModel)
void	setValues(com.ibm.json.java.JSONObject json, boolean forceUpdate, boolean skipEncoding, boolean isJSONModel) Used by the configuration action for example addConfiguration to store value into properties object.
protected boolean	skipThisPropertyWhenSaving(java.lang.String key) Skip this property in saving if return value is true.
java.lang.String[]	stringToArray(java.lang.String string) Convert string value to an array object.
java.util.List	stringToList(java.lang.String string) Convert string value to a list object.
com.ibm.json.java.JSONObject	toJSON() Convert this configuration object to JSON object to be stream back to client.
com.ibm.json.java.JSONObject	toJSON(boolean includeDependencies) Convert this configuration object and its dependencies to JSON object to be stream back to client.
com.ibm.json.java.JSONObject	toJSONModel() Creates a new JSON model object, used to enable model binding in the user interface.
java.lang.String	toString() Override to return the object ID of this configuration back.
void	validate()
void	validateObjectId()
static <V extends ConfigurationObject> void	writeConfigurationToFile(java.io.OutputStreamWriter osw, java.util.Collection<V> configList) Write the configuration object out to the write object

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MISSING_KEY

public static final java.lang.String ERROR_MISSING_KEY

See Also:

Constant Field Values

ARRAY_DELIMITER

protected static final char ARRAY_DELIMITER

See Also:

Constant Field Values

KEY_DELIMITER

protected static final char KEY_DELIMITER

See Also:

Constant Field Values

LIST_ESC_CHAR

protected static final char LIST_ESC_CHAR

See Also:

Constant Field Values

LIST_SEPARATOR

protected static final java.lang.String LIST_SEPARATOR

See Also:

Constant Field Values

MODIFIER

protected static final int MODIFIER

See Also:

Constant Field Values

PLACEHOLDER_SECRET

public static final java.lang.String PLACEHOLDER_SECRET

See Also:

Constant Field Values

configuration

protected transient org.apache.commons.configuration.Configuration configuration

properties

protected java.util.Properties properties

cloned

protected boolean cloned

fromTenant

protected boolean fromTenant

returnCopyFromCache

protected boolean returnCopyFromCache

DEFAULT_PROPERTY_VALUE_MAP

protected java.util.Map<java.lang.String,java.lang.String> DEFAULT_PROPERTY_VALUE_MAP

Since:

2.0.3.8 Subclasses of configuration object should populate this map. It contains default values for each property.

Constructor Detail

ConfigurationObject

public ConfigurationObject(org.apache.commons.configuration.Configuration configuration,
                           java.lang.String idPrefix,
                           java.lang.String objectId)

Constructor method that it uses configuration type in the concrete subclass, idPrefix and objectID to form a unique key to retrieve from DB in method load.

Parameters:

configuration - - A @{org.apache.commons.configuration.Configuration} object.

idPrefix - - A string value of application name.

objectId - - A string value of object ID.

Method Detail

validateObjectId

public void validateObjectId()

getConfigurationObject

public org.apache.commons.configuration.Configuration getConfigurationObject()

Return configuration object back.

Returns:

a @{org.apache.commons.configuration.Configuration} object

getObjectType

public abstract java.lang.String getObjectType()

Abstract method to return object type.

Returns:

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

getName

public java.lang.String getName()

returnCopyFromCache

public boolean returnCopyFromCache()

Return whether or not a copy of this configuration object should be returned from cache. For example, after a MenuConfig is retrieved it is updated with context specific information such as it's parent menu, localized display name, etc. These changes should not be applied to the cached MenuConfig.

Returns:

a boolean - if true, a copy of this configuration object should be returned if it is from the cache.

Since:

2.0.3.6

getObjectId

public java.lang.String getObjectId()

Return the object ID back.

Returns:

a string value of object ID.

getObjectIdAlias

public java.lang.String getObjectIdAlias()

getIdPrefix

public java.lang.String getIdPrefix()

Return the application name used as ID prefix. ICN uses this field to identify which application this configuration is for.

Returns:

a string value of ID prefix, for example "navigator".

getKey

public java.lang.String getKey()

Return the key value back by combined configuration type, ID prefix and ID.

Returns:

a string value of key.

getList

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

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

Parameters:

type - - A string value of object type.

appName - - A string value of application name.

request - - A HttpServletRequest object.

Returns:

a collection of type.

setProperties

protected void setProperties(java.util.Properties properties)

performSyncedUpdate

public void performSyncedUpdate(SyncedUpdateHandlerInterface handler)

load

public void load()

Retrieves the latest version from the configuration store.

validate

public void validate()
              throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

save

public void save()
          throws org.apache.commons.configuration.ConfigurationException

Saves the object back to the configuration store.

Throws:

org.apache.commons.configuration.ConfigurationException

dump

public void dump(java.io.OutputStreamWriter osw)
          throws java.io.IOException

Dumps the configuration to the specified output stream (used for logging and export)

Parameters:

osw - - the output stream writer to be used for the config dump and it has to use "ISO-8859-1" encoding to preserve localized label

Throws:

java.io.IOException

writeConfigurationToFile

public static <V extends ConfigurationObject> void writeConfigurationToFile(java.io.OutputStreamWriter osw,
                                                                            java.util.Collection<V> configList)
                                                                     throws java.io.IOException,
                                                                            java.io.FileNotFoundException

Write the configuration object out to the write object

Parameters:

osw - - OutputStreamWriter to be used for the config dump and it has to use "ISO-8859-1" encoding

configList - - a collection of objects inherited from ConfigurationObject for example DesktopConfig.

Throws:

java.io.IOException

java.io.FileNotFoundException

delete

public void delete()

Remove this configuration object from the DB.

isEmpty

public boolean isEmpty()

Deprecated. Use either hasProperties() or isNew() instead.

Is this configuration empty

Returns:

a boolean value if there is no property stored in the properties object.

isNew

public boolean isNew()

Since:

2.0.3.8 Returns true if the configuration object is new -- it doesn't currently exist in the database.

hasProperties

public boolean hasProperties()

Since:

2.0.3.8 Returns true if the configuration object contains property values.

stringToList

public java.util.List stringToList(java.lang.String string)

Convert string value to a list object. This string object expect to have multiple value separated by "," ARRAY_DELIMITER.

Parameters:

string - - A value that needs to be parsed.

Returns:

a list object back with parsed value.

stringToArray

public java.lang.String[] stringToArray(java.lang.String string)

Convert string value to an array object. This string object expect to have multiple value separated by "," ARRAY_DELIMITER.

Parameters:

string - - A value that needs to be parsed.

Returns:

an array object back with parsed value.

arrayToString

public java.lang.String arrayToString(java.lang.String[] array)

Convert an array object to a string. Each value in the array will be separated by a "," ARRAY_DELIMITER character in string.

Parameters:

array - - An array of string

Returns:

a string. Each value in the array will be separated by a "," ARRAY_DELIMITER character in string.

arrayToString

public java.lang.String arrayToString(java.util.List<java.lang.String> list)

Convert a list to a string. Each value in the array will be separated by a "," ARRAY_DELIMITER character in string.

Parameters:

list - A string list

Returns:

a string. Each value in the array will be separated by a "," ARRAY_DELIMITER character in string.

skipThisPropertyWhenSaving

protected boolean skipThisPropertyWhenSaving(java.lang.String key)

Skip this property in saving if return value is true. Ambient property that no need to be saved.

Parameters:

key - - A string value of property name.

Returns:

a boolean value, true to skip this property in saving and false is otherwise.

propertiesToString

protected java.lang.String propertiesToString(java.util.Properties properties)

Serialized properties object value to a string. Each key and value pair in the properties will be separated by a ";", LIST_DELIMITER character. if property in the properties object has this character in it. It needs to be encoded first to avoid parsing problem in load method. Move append list delimiter to the front to prevent we might skip some properties but delimiter already appended to the end of string. That will cause parsing to throw exception of '' with no = in front of it.

Parameters:

properties -

Returns:

a string value that has all the property in the properties object.

covertEmptyStringtoNull

public java.lang.String covertEmptyStringtoNull(java.lang.String value)

Utility method to convert a string to null if it is empty.

Parameters:

value - - A string value that needs to be converted.

Returns:

null or original value back if not null and not empty.

getMap

public <V extends ConfigurationObject> java.util.Map<java.lang.String,V> getMap(java.lang.Class<V> configClass,
                                                                                java.lang.String idPrefix,
                                                                                java.lang.String[] ids,
                                                                                boolean... flags)

Return a map of configuration object identified by ids field back.

Parameters:

configClass - - A configuration class object.

idPrefix - - A string value of ID prefix.

ids - - A array of ID. All ID in this array expected to be the same type identify by the configClass parameter.

flags - - A optional flags to skip caching. Default is true.

Returns:

a map of configuration object.

getDataTypeValue

public java.lang.Object getDataTypeValue(java.lang.String field)

Returns the field's value as per the field's data type.

Since:

2.0.3

toJSON

public com.ibm.json.java.JSONObject toJSON()

Convert this configuration object to JSON object to be stream back to client. Since toJSON is using properties object directly therefore any default value is not applicable in this case. All added property after ICN 2.0.0 is required to add itself into upgrade method to support this method.

Returns:

A JSONObject of this configuration

toJSON

public com.ibm.json.java.JSONObject toJSON(boolean includeDependencies)

Convert this configuration object and its dependencies to JSON object to be stream back to client.

Returns:

A JSONObject of this configuration

toJSONModel

public com.ibm.json.java.JSONObject toJSONModel()

Creates a new JSON model object, used to enable model binding in the user interface.

Returns:

A JSONObject containing the model definition.

createJSONModelField

protected com.ibm.json.java.JSONObject createJSONModelField(java.lang.Object value,
                                                            boolean readOnly,
                                                            boolean disabled)

Creates a field for a JSON model used to populate a stateful client-side model.

Parameters:

value - Value of the field being created.

readOnly - Boolean indicating if the field is readOnly.

disabled - Boolean indicating if the field is disabled.

Returns:

JSONObject containing the properties provided

createJSONModelValidationField

protected com.ibm.json.java.JSONObject createJSONModelValidationField(java.lang.Object value,
                                                                      boolean readOnly,
                                                                      boolean disabled,
                                                                      boolean required,
                                                                      java.lang.String pattern)

Creates a field with validation for a JSON model used to populate a stateful client-side model.

Parameters:

value - Value of the field being created.

readOnly - Boolean indicating if the field is readOnly.

disabled - Boolean indicating if the field is disabled.

required - Boolean indicating if the field is required.

pattern - String containing a pattern to apply to the field.

Returns:

JSONObject containing the properties provided

createJSONModelToggleField

protected com.ibm.json.java.JSONObject createJSONModelToggleField(java.lang.Object value,
                                                                  boolean readOnly,
                                                                  boolean disabled,
                                                                  boolean checked)

Creates a field with toggle capability for a JSON model used to populate a stateful client-side model. Fields with toggle capability include checkboxes, radio buttons and toggle buttons.

Parameters:

value - Value of the field being created.

readOnly - Boolean indicating if the field is readOnly.

disabled - Boolean indicating if the field is disabled.

checked - Boolean indicating if the field is checked.

Returns:

JSONObject containing the properties provided

addIdNameToJSONModel

protected void addIdNameToJSONModel(com.ibm.json.java.JSONObject model,
                                    boolean readOnly)

Adds the ID and name fields to the JSON model.

Parameters:

model - Model to update.

getDataType

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

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.

Parameters:

key - ths name of the property

Returns:

a Class instance describing the datatype of the property.

Since:

2.0.2.1

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Store value into properties directly.

Parameters:

key - - A string value of property name.

value - - A string value of value

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String key)

Return the value back from the properties.

Parameters:

key - - A string value of property name.

Returns:

a string value.

getBooleanPropertyValue

public boolean getBooleanPropertyValue(java.lang.String key)

Return the value back from the properties as a boolean.

Parameters:

key - - A string value of property name.

Returns:

a boolean value.

getIntPropertyValue

public int getIntPropertyValue(java.lang.String key)

Return the value back from the properties as an int.

Parameters:

key - - A string value of property name.

Returns:

an int value.

getLongPropertyValue

public long getLongPropertyValue(java.lang.String key)

Return the value back from the properties as a long.

Parameters:

key - - A string value of property name.

Returns:

a long value.

getDoublePropertyValue

public double getDoublePropertyValue(java.lang.String key)

Return the value back from the properties as a double.

Parameters:

key - - A string value of property name.

Returns:

a double value.

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String key,
                                         java.lang.String defaultValue)

getPropertyValue

public int getPropertyValue(java.lang.String key,
                            int defaultValue)

getPropertyValue

public long getPropertyValue(java.lang.String key,
                             long defaultValue)

getPropertyNames

protected java.util.Map<java.lang.String,java.lang.String> getPropertyNames()

Return a map of string of all the fields name in the class where field is a private static final string

Returns:

setValues

public void setValues(com.ibm.json.java.JSONObject json)

Parameters:

json -

setValues

public void setValues(com.ibm.json.java.JSONObject json,
                      boolean forceUpdate)

Parameters:

json -

setValues

public void setValues(com.ibm.json.java.JSONObject json,
                      boolean forceUpdate,
                      boolean isJSONModel)

setValues

public void setValues(com.ibm.json.java.JSONObject json,
                      boolean forceUpdate,
                      boolean skipEncoding,
                      boolean isJSONModel)

Used by the configuration action for example addConfiguration to store value into properties object. It uses json object, a incoming parameter and published properties from a configuration to set value. A published property is identified by property signature of private static final String. Property value will encoded to protect "\", "," and ";".

Parameters:

json - - A JSON object.

forceUpdate - - Set this value even there is no matching published property.

skipEncoding - - If true, backslashes are not encoded

fromJSONModel

public void fromJSONModel(com.ibm.json.java.JSONObject jsonObj,
                          boolean forceUpdate,
                          boolean skipEncoding)

Reads a JSON model object and populates the configuration properties.

Parameters:

jsonObj -

removeValuesFromList

public void removeValuesFromList(java.lang.String key,
                                 java.util.List<java.lang.String> deleteValues)

Remove values from the properties object.

Parameters:

key - - A string of property name that identified a list.

deleteValues - - values need to be removed.

removeValuesFromList

protected void removeValuesFromList(java.lang.String key,
                                    java.util.List<java.lang.String> deleteValues,
                                    java.util.Properties props)

addValueToList

public void addValueToList(java.lang.String key,
                           java.lang.String value)

Parameters:

key - Key field name.

value - Key.

Since:

2.0.3 Added additional logic to filter out duplicated key

setDefaultValue

protected void setDefaultValue(java.lang.String propertyName,
                               java.lang.String defaultValue)

Set the default value if not found in the properties object

Parameters:

propertyName - - A string value of property name.

defaultValue - - A string value of default value if not found.

toString

public java.lang.String toString()

Override to return the object ID of this configuration back.

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Returns:

Returns a deep copy of this configuration object, except for the reference to the source Configuration object (shallow copy).

Throws:

java.lang.CloneNotSupportedException

Since:

ICN 2.0.3.6

resetNonTenantSettings

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

Throws:

org.apache.commons.configuration.ConfigurationException

Since:

3.0.12