com.ibm.ecm.configuration

Class PluginUserConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.PluginUserConfig

All Implemented Interfaces:

java.io.Serializable

public class PluginUserConfig
extends ConfigurationObject
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

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
PluginUserConfig(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	getConfiguration()
java.util.Collection<PluginConfig>	getConfigurationList(javax.servlet.http.HttpServletRequest request)
java.util.Collection<PluginConfig>	getConfigurationList(javax.servlet.http.HttpServletRequest request, java.lang.String[] keys)
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
java.lang.String[]	getKeys()
java.lang.String	getObjectIdAlias()
java.lang.String	getObjectType() Abstract method to return object type.
boolean	hasMoreConfiguration()
void	setConfiguration(java.lang.String configuration)
void	setKeys(java.lang.String[] keys)
void	setObjectIdAlias(java.lang.String alias)
void	validateObjectId()

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, getList, getLongPropertyValue, getMap, getName, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, hasProperties, isEmpty, isNew, load, performSyncedUpdate, propertiesToString, removeValuesFromList, removeValuesFromList, resetNonTenantSettings, returnCopyFromCache, save, setDefaultValue, setProperties, setProperty, setValues, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toJSON, toJSONModel, toString, validate, writeConfigurationToFile

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginUserConfig

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

Method Detail

setObjectIdAlias

public void setObjectIdAlias(java.lang.String alias)

getObjectIdAlias

public java.lang.String getObjectIdAlias()

Overrides:

getObjectIdAlias in class ConfigurationObject

validateObjectId

public void validateObjectId()

Overrides:

validateObjectId in class ConfigurationObject

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.

getConfiguration

public java.lang.String getConfiguration()

setConfiguration

public void setConfiguration(java.lang.String configuration)

getKeys

public java.lang.String[] getKeys()

Since:

2.0.3

hasMoreConfiguration

public boolean hasMoreConfiguration()

Since:

2.0.3

setKeys

public void setKeys(java.lang.String[] keys)

Since:

2.0.3

getConfigurationList

public java.util.Collection<PluginConfig> getConfigurationList(javax.servlet.http.HttpServletRequest request)

Since:

2.0.3

getConfigurationList

public java.util.Collection<PluginConfig> getConfigurationList(javax.servlet.http.HttpServletRequest request,
                                                               java.lang.String[] keys)

Since:

2.0.3