com.ibm.ecm.configuration

Class PluginConfig

java.lang.Object

com.ibm.ecm.configuration.ConfigurationObject

com.ibm.ecm.configuration.PluginConfig

All Implemented Interfaces:

java.io.Serializable

public class PluginConfig
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
PluginConfig(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	getActions()
java.lang.String	getChecksum()
java.lang.String	getClassName()
java.lang.String	getConfigClass()
java.lang.String	getConfiguration()
java.lang.String[]	getConfigurationKeys()
java.util.Collection<PluginConfig>	getConfigurationList()
java.util.Collection<PluginConfig>	getConfigurationList(java.lang.String[] keys)
protected java.lang.Class	getDataType(java.lang.String key) Returns the datatype of a configuration property.
boolean	getEnabled()
java.lang.String	getFileName()
java.lang.String	getName()
java.lang.String	getObjectIdAlias()
java.lang.String	getObjectType() Abstract method to return object type.
int	getOrdering()
java.lang.String[]	getPluginDependencies()
java.lang.String	getVersion()
java.lang.String	getViewers()
boolean	hasMoreConfiguration()
boolean	isChecksumValidated()
boolean	isOptional()
void	load() Initializes the superclass default property values map.
void	populateDetails(com.ibm.json.java.JSONObject jsonObject)
void	setActions(java.lang.String actions)
void	setChecksum(java.lang.String checksum)
void	setChecksumValidated(boolean checksumValidated)
void	setClassName(java.lang.String name)
void	setConfigClass(java.lang.String configClass)
void	setConfiguration(java.lang.String configuration)
void	setConfigurationKeys(java.lang.String[] keys)
void	setEnabled(boolean enabled)
void	setFileName(java.lang.String name)
void	setName(java.lang.String name)
void	setObjectIdAlias(java.lang.String alias)
void	setOptional(boolean optional)
void	setOrdering(java.lang.Integer ordering)
void	setPluginDependencies(java.lang.String[] dependencies)
void	setPluginDetailsObject(com.ibm.json.java.JSONObject pluginDetailsObject)
void	setVersion(java.lang.String version)
void	setViewers(java.lang.String viewers)
java.lang.String	toString() Override to return the object ID of this configuration back.
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, getObjectId, getPropertyNames, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, hasProperties, isEmpty, isNew, performSyncedUpdate, propertiesToString, removeValuesFromList, removeValuesFromList, resetNonTenantSettings, returnCopyFromCache, save, setDefaultValue, setProperties, setProperty, setValues, setValues, setValues, setValues, skipThisPropertyWhenSaving, stringToArray, stringToList, toJSON, toJSON, toJSONModel, validate, writeConfigurationToFile

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginConfig

public PluginConfig(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

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.

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String name)

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String name)

getName

public java.lang.String getName()

Overrides:

getName in class ConfigurationObject

setName

public void setName(java.lang.String name)

getConfiguration

public java.lang.String getConfiguration()

setConfiguration

public void setConfiguration(java.lang.String configuration)

getConfigClass

public java.lang.String getConfigClass()

setConfigClass

public void setConfigClass(java.lang.String configClass)

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean optional)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getActions

public java.lang.String getActions()

setActions

public void setActions(java.lang.String actions)

getViewers

public java.lang.String getViewers()

setViewers

public void setViewers(java.lang.String viewers)

toString

public java.lang.String toString()

Description copied from class: ConfigurationObject

Override to return the object ID of this configuration back.

Overrides:

toString in class ConfigurationObject

getConfigurationKeys

public java.lang.String[] getConfigurationKeys()

Since:

2.0.3

hasMoreConfiguration

public boolean hasMoreConfiguration()

Since:

2.0.3

setConfigurationKeys

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

Since:

2.0.3

getConfigurationList

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

Since:

2.0.3

getConfigurationList

public java.util.Collection<PluginConfig> getConfigurationList(java.lang.String[] keys)

Since:

2.0.3

getEnabled

public boolean getEnabled()

Since:

2.0.3

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled -

getOrdering

public int getOrdering()

Since:

2.0.3

setOrdering

public void setOrdering(java.lang.Integer ordering)

Parameters:

ordering -

getPluginDependencies

public java.lang.String[] getPluginDependencies()

Since:

2.0.3

setPluginDependencies

public void setPluginDependencies(java.lang.String[] dependencies)

Since:

2.0.3

isChecksumValidated

public boolean isChecksumValidated()

Since:

3.0.11

setChecksumValidated

public void setChecksumValidated(boolean checksumValidated)

Since:

3.0.11

getChecksum

public java.lang.String getChecksum()

Since:

3.0.11

setChecksum

public void setChecksum(java.lang.String checksum)

Since:

3.0.11

setPluginDetailsObject

public void setPluginDetailsObject(com.ibm.json.java.JSONObject pluginDetailsObject)

Since:

3.1.0

populateDetails

public void populateDetails(com.ibm.json.java.JSONObject jsonObject)

Since:

3.1.0