org.eclipse.kura.configuration.metatype

Interface OCDService

@ProviderType
public interface OCDService

This Interface provides the capability to get the OCDs for the specified Factories or Service Providers.

Since:

1.4

Method Summary

Modifier and Type	Method and Description
ComponentConfiguration	getFactoryComponentOCD(java.lang.String factoryPid) Returns the OCD of the registered component factory identified by the provided factoryPid and for which an OSGi MetaType is registered in the ConfigurationService.
java.util.List<ComponentConfiguration>	getFactoryComponentOCDs() Returns the OCDs of all registered component factories for which an OSGi MetaType is is registered in the ConfigurationService.
java.util.List<ComponentConfiguration>	getServiceProviderOCDs(java.lang.Class<?>... classes) Searches the Declarative Services layer for Components implementing any of the specified services and returns a ComponentConfiguration instance describing it.
java.util.List<ComponentConfiguration>	getServiceProviderOCDs(java.lang.String... classNames)

Method Detail

getFactoryComponentOCDs

java.util.List<ComponentConfiguration> getFactoryComponentOCDs()

Returns the OCDs of all registered component factories for which an OSGi MetaType is is registered in the ConfigurationService.
The OCDs are returned in the form of a ComponentConfiguration instance. The component factory pid can be obtained by calling ComponentConfiguration.getPid() method and the actual OCD can be obtained by calling the ComponentConfiguration.getDefinition() method.

Returns:

The list of the component factory OCDs.

Since:

1.4

getFactoryComponentOCD

ComponentConfiguration getFactoryComponentOCD(java.lang.String factoryPid)

Returns the OCD of the registered component factory identified by the provided factoryPid and for which an OSGi MetaType is registered in the ConfigurationService.
The OCD is returned in the form of a ComponentConfiguration instance. The component factory pid can be obtained by calling ComponentConfiguration.getPid() method and the actual OCD can be obtained by calling the ComponentConfiguration.getDefinition() method.

Returns:

The OCD for the requested component factory if available, or null otherwise

Since:

1.4

getServiceProviderOCDs

java.util.List<ComponentConfiguration> getServiceProviderOCDs(java.lang.Class<?>... classes)

Searches the Declarative Services layer for Components implementing any of the specified services and returns a ComponentConfiguration instance describing it. If the ConfigurationService contains a registered OSGi MetaType for a found Component, it will be returned inside the ComponentConfiguration instance.
The ComponentConfiguration instances in the returned list contain the following information:

• The ComponentConfiguration.getPid() method returns the Component name.
• The ComponentConfiguration.getDefinition() method returns the OCD for the found Component if it is known to the ConfigurationService, or null otherwise.

Parameters:

clazzes - The list of service classes to be used as search filter.

Returns:

A list of ComponentConfiguration instances representing the found Components.

Since:

1.4

getServiceProviderOCDs

java.util.List<ComponentConfiguration> getServiceProviderOCDs(java.lang.String... classNames)

Parameters:

classNames - The list of service class or interface names to be used as search filter.

Returns:

A list of ComponentConfiguration instances representing the found Components.

Since:

1.4

See Also:

ConfigurationService#getServiceProviderOCDs(Class...)