org.eclipse.soda.dk.core
Class ConfigurableObject

java.lang.Object
  org.eclipse.soda.dk.core.EscObject
      org.eclipse.soda.dk.core.ConfigurableObject

All Implemented Interfaces:

ConfigurableService

Direct Known Subclasses:

Agent, org.eclipse.soda.dk.testagent.TestAgent

public class ConfigurableObject
extends EscObject
implements ConfigurableService

Version:

1.2.0

Field Summary

static java.lang.String

BUNDLE_VERSION_PROPERTY Define the bundle version property (String) constant.

Fields inherited from class org.eclipse.soda.dk.core.EscObject

CLONE_EXCEPTION_RESOURCE, EMPTY_BYTES, EMPTY_STRING, ERROR_OCCURRED_EXCEPTION_RESOURCE, ID_FILTER_KEY, ID_KEY, ID_KEY_ANY, ID_NAME_KEY, INTEGER_TABLE, INTEGER_TABLE_SIZE, KEY_KEY, LOG_DEBUG, LOG_DEFAULT, LOG_ERROR, LOG_INFO, LOG_LEVEL_KEY, LOG_TRACE, LOG_WARNING, LONG_TABLE, LONG_TABLE_SIZE, PREFIX_KEY, READONLY_EMPTY_COLLECTION, READONLY_EMPTY_LIST, READONLY_EMPTY_MAP, RESOURCE_BUNDLE, SLEEP_EXCEPTION_RESOURCE, SYSTEM_INFO_RESOURCE, TO_STRING_CONFIGURATION_KEYS, TRACE_LEVEL_HIGH, TRACE_LEVEL_LOW, TRACE_LEVEL_MAX, TRACE_LEVEL_MIN, TRACE_LEVEL_NONE, TRACE_LEVEL_NORMAL, TRACELEVEL_KEY, UNKNOWN_ERROR_RESOURCE, Unmodifiable

Constructor Summary

ConfigurableObject()
Constructs an instance of this class.

Method Summary

static java.util.Hashtable	createPropertiesFromHeaders(java.util.Dictionary headers) Create properties from headers with the specified headers parameter and return the Hashtable result.
java.util.Dictionary	getConfigurationInformation() Return the property table.
ConfigurationService	getConfigurationService() Gets the configuration service value.
java.lang.String	getId() Gets the ID (String) value.
void	putConfigurationInformation(java.lang.String propertyName, java.lang.Object value) Put configuration information with the specified property name and value parameters.
void	setConfigurationInformation(java.util.Dictionary configurationInformation) Sets the configuration information value.
void	setConfigurationService(ConfigurationService configurationService) Sets the configuration service value.
void	setId(java.lang.String id) Sets the ID value.
static void	validateConfiguration(java.lang.String pid, java.util.Dictionary properties, org.osgi.service.metatype.MetaTypeInformation info) Validate configuration with the specified PID, properties and info parameters.

Methods inherited from class org.eclipse.soda.dk.core.EscObject

attemptRecoveryFromError, createBoolean, createDefaultLogService, createException, createException, createInteger, createIntegerTable, createLong, createLongTable, createNumber, format, getBoolean, getByte, getChar, getCurrentTimestamp, getDefaultLogService, getDefaultResource, getDouble, getErrorSeverity, getFloat, getIdName, getInt, getLoadLibraryName, getLogDetails, getLogDetails, getLogDetails0, getLogDetails1, getLogDetails2, getLogDetails3, getLogDetails4, getLogDetails5, getLogDetails6, getLogDetails7, getLogLevel, getLogService, getLong, getObject, getOutputName, getReadOnlyEmptyCollection, getReadOnlyEmptyList, getReadOnlyEmptyMap, getResource, getShort, getSimpleClassName, getStaticBoolean, getStaticByte, getStaticChar, getStaticDouble, getStaticFloat, getStaticInt, getStaticLong, getStaticObject, getStaticShort, getStaticString, getString, getTraceLevel, getVmLibraryVersion, handleError, handleError, handleError, handleError, handleErrorInternal, handleStaticError, handleStaticException, isBackward, isDebug, isLogging, isTrace, isUnmodifiable, loadService, log, log, log, report, report, report, report, report, report, report, reportError, reportSystemInfo, setBackward, setDebug, setDefaultLogService, setLogService, setTraceLevel, setUnmodifiable, shouldLog, sleep, startupEscStatic, toString, toStringConfigurationKeys, toStringInfo

Methods inherited from class java.lang.Object

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

Field Detail

BUNDLE_VERSION_PROPERTY

public static final java.lang.String BUNDLE_VERSION_PROPERTY

Define the bundle version property (String) constant.

Constructor Detail

ConfigurableObject

public ConfigurableObject()

Constructs an instance of this class.

Method Detail

createPropertiesFromHeaders

public static java.util.Hashtable createPropertiesFromHeaders(java.util.Dictionary headers)

Create properties from headers with the specified headers parameter and return the Hashtable result.

Parameters:

headers - The headers (Dictionary) parameter.

Returns:

Results of the create properties from headers (Hashtable) value.

validateConfiguration

public static void validateConfiguration(java.lang.String pid,
                                         java.util.Dictionary properties,
                                         org.osgi.service.metatype.MetaTypeInformation info)
                                  throws org.osgi.service.cm.ConfigurationException

Validate configuration with the specified PID, properties and info parameters. Configuration Exception.

Parameters:

pid - The PID (String) parameter.

properties - The properties (Dictionary) parameter.

info - The info (MetaTypeInformation) parameter.

Throws:

org.osgi.service.cm.ConfigurationException - Configuration Exception.

getConfigurationInformation

public java.util.Dictionary getConfigurationInformation()

Return the property table. value.

Specified by:

getConfigurationInformation in interface ConfigurableService

Returns:

Results of the get configuration information (Dictionary)

See Also:

putConfigurationInformation(String,Object), setConfigurationInformation(Dictionary)

getConfigurationService

public ConfigurationService getConfigurationService()

Gets the configuration service value.

Overrides:

getConfigurationService in class EscObject

Returns:

The configuration service (ConfigurationService)

See Also:

setConfigurationService(ConfigurationService)

getId

public java.lang.String getId()

Gets the ID (String) value.

Overrides:

getId in class EscObject

Returns:

The id (String) value.

See Also:

setId(String)

putConfigurationInformation

public void putConfigurationInformation(java.lang.String propertyName,
                                        java.lang.Object value)

Put configuration information with the specified property name and value parameters.

Parameters:

propertyName - The property name (String) parameter.

value - The value (Object) parameter.

See Also:

getConfigurationInformation(), setConfigurationInformation(Dictionary)

setConfigurationInformation

public void setConfigurationInformation(java.util.Dictionary configurationInformation)

Sets the configuration information value.

Specified by:

setConfigurationInformation in interface ConfigurableService

Parameters:

configurationInformation - The configuration information (Dictionary) parameter.

See Also:

getConfigurationInformation(), putConfigurationInformation(String,Object)

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

Sets the configuration service value.

Parameters:

configurationService - The configuration service (ConfigurationService) parameter.

See Also:

getConfigurationService()

setId

public void setId(java.lang.String id)

Sets the ID value.

Parameters:

id - The ID (String) parameter.

See Also:

getId()