org.eclipse.kura.configuration

Interface ComponentConfiguration

@ProviderType
public interface ComponentConfiguration

The ComponentConfiguration groups all the information related to the Configuration of a Component. It provides access to parsed ObjectClassDefintion associated to this Component. ComponentConfiguration does not reuse the OSGi ObjectClassDefinition as the latter does not provide access to certain aspects such as the required attribute, the min and max values. Instead it returns the raw ObjectClassDefintion as parsed from the MetaType Information XML resource associated to this Component.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getConfigurationProperties() Returns the Dictionary of properties currently used by this component.
OCD	getDefinition() Returns the raw ObjectClassDefinition as parsed from the MetaType Information XML resource associated to this Component.
java.lang.String	getPid() Returns the PID (service's persistent identity) of the component associated to this Configuration.

Method Detail

getPid

java.lang.String getPid()

Returns the PID (service's persistent identity) of the component associated to this Configuration. For a component created via ConfigurationService.createFactoryConfiguration(String, String, Map, boolean) , the service's persistent identity is the value of the second parameter of that method; at runtime, the same value is also available in the ConfigurationService.KURA_SERVICE_PID property of one of the configurations of the associated Factory Component. Otherwise, the service's persistent identity is defined as the name attribute of the Component Descriptor XML file; at runtime, the same value is also available in the component.name and in the service.pid properties of the Component Configuration. If not already specified by the component, the Configuration Service will automatically set the ConfigurationService.KURA_SERVICE_PID to the value of service.pid when the component is first updated.

Returns:

PID of the component associated to this Configuration.

getDefinition

OCD getDefinition()

Returns the raw ObjectClassDefinition as parsed from the MetaType Information XML resource associated to this Component.

Returns:

getConfigurationProperties

java.util.Map<java.lang.String,java.lang.Object> getConfigurationProperties()

Returns the Dictionary of properties currently used by this component.

Returns:

the Component's Configuration properties.