org.apache.felix.dm

Interface FactoryComponent

All Superinterfaces:

AbstractComponent, Component<FactoryComponent>

public interface FactoryComponent
extends Component<FactoryComponent>

Interface used to configure the various parameters needed when defining a Dependency Manager factory component. A factory component is a component which can be instantiated multiple times using standard OSGi Factory Configurations.

When a factory configuration is created, an instance of the component is created and the configuration is injected by default in the "updated" callback, which supports the following signatures:

• callback(Dictionary)
• callback(Component, Dictionary)
• callback(Component, Configuration ... configTypes) // type safe configuration interface(s)
• callback(Configuration ... configTypes) // type safe configuration interface(s)
• callback(Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s)
• callback(Component, Dictionary, Configuration ... configTypes) // type safe configuration interfaces(s)

Usage Examples

Here is a sample showing a Hello component, which can be instantiated multiple times using a factory configuration:

 
 public class Activator extends DependencyActivatorBase {
     &Override
     public void init(BundleContext context, DependencyManager dm) throws Exception {
         Component factoryComponent = createFactoryComponent()
             .setFactoryPid("my.factory.pid")
             .setInterface(MySevice.class.getName(), null)
             .setImplementation(MyComponent.class)
             .setConfigType(MyConfig.class);
         dm.add(factoryComponent);
     }
 }
 
 public interface MyConfig {
     int getPort();
     String getAddress();
 }
 
 public class MyComponent implements MyService {
     void updated(MyConfig cnf) {
         int port = cnf.getPort();
         String addr = cnf.getAddress();
         ...
     }
 }
  

See Also:

DependencyManager.createFactoryComponent()

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.felix.dm.Component

Component.ServiceScope

Method Summary

Modifier and Type	Method and Description
FactoryComponent	add(PropertyMetaData... metaData) Sets metatype MetaData regarding configuration properties.
FactoryComponent	setConfigType(java.lang.Class<?>... configTypes) Sets the configuration type to use instead of a dictionary.
FactoryComponent	setDesc(java.lang.String desc) A metatype human readable description of the factory PID this configuration is associated with.
FactoryComponent	setFactoryPid(java.lang.Class<?> clazz) Sets the pid matching the factory configuration using the specified class.
FactoryComponent	setFactoryPid(java.lang.String factoryPid) Sets the pid matching the factory configuration
FactoryComponent	setHeading(java.lang.String heading) Sets the metatype label used to display the tab name (or section) where the properties are displayed.
FactoryComponent	setLocalization(java.lang.String localization) Points to the metatype basename of the Properties file that can localize the Meta Type informations.
FactoryComponent	setPropagate(boolean propagate) Sets the propagate flag (true means all public configuration properties are propagated to service properties).
FactoryComponent	setUpdated(java.lang.String update) Sets the method name that will be notified when the factory configuration is created/updated.
FactoryComponent	setUpdateInstance(java.lang.Object updatedCallbackInstance) Sets the object on which the updated callback will be invoked.

Methods inherited from interface org.apache.felix.dm.Component

add, add, getServiceRegistration, remove, remove, setAutoConfig, setAutoConfig, setCallbacks, setCallbacks, setComposition, setComposition, setDebug, setFactory, setFactory, setImplementation, setInterface, setInterface, setInterface, setInterface, setScope, setServiceProperties

Methods inherited from interface org.apache.felix.dm.AbstractComponent

getComponentDeclaration, getDependencyManager, getInstance, getInstances, getServiceProperties

Method Detail

setFactoryPid

FactoryComponent setFactoryPid(java.lang.String factoryPid)

Sets the pid matching the factory configuration

Parameters:

factoryPid - the pid matching the factory configuration

setFactoryPid

FactoryComponent setFactoryPid(java.lang.Class<?> clazz)

Sets the pid matching the factory configuration using the specified class. The FQDN of the specified class will be used as the factory pid.

Parameters:

clazz - the class whose FQDN name will be used for the factory pid

setUpdated

FactoryComponent setUpdated(java.lang.String update)

Sets the method name that will be notified when the factory configuration is created/updated. By default, the callback name used is updated TODO describe supported signatures

Parameters:

update - the method name that will be notified when the factory configuration is created/updated.

setUpdateInstance

FactoryComponent setUpdateInstance(java.lang.Object updatedCallbackInstance)

Sets the object on which the updated callback will be invoked. By default, the callback is invoked on the component instance.

Parameters:

updatedCallbackInstance - the object on which the updated callback will be invoked.

setPropagate

FactoryComponent setPropagate(boolean propagate)

Sets the propagate flag (true means all public configuration properties are propagated to service properties). By default, public configurations are not propagated.

Parameters:

propagate - the propagate flag (false, by default; true means all public configuration properties are propagated to service properties).

setConfigType

FactoryComponent setConfigType(java.lang.Class<?>... configTypes)

Sets the configuration type to use instead of a dictionary. The updated callback is assumed to take as arguments the specified configuration types in the same order they are provided in this method. Optionally, the callback may define a Dictionary as the first argument, in order to also get the raw configuration.

Parameters:

configTypes - the configuration type to use instead of a dictionary

See Also:

ConfigurationDependency

setHeading

FactoryComponent setHeading(java.lang.String heading)

Sets the metatype label used to display the tab name (or section) where the properties are displayed. Example: "Printer Service"

Parameters:

heading - the label used to display the tab name (or section) where the properties are displayed.

setDesc

FactoryComponent setDesc(java.lang.String desc)

A metatype human readable description of the factory PID this configuration is associated with.

Parameters:

desc -

setLocalization

FactoryComponent setLocalization(java.lang.String localization)

Points to the metatype basename of the Properties file that can localize the Meta Type informations. The default localization base name for the properties is OSGI-INF/l10n/bundle, but can be overridden by the manifest Bundle-Localization header (see core specification, in section Localization on page 68). You can specify a specific localization basename file using this parameter (e.g. "person" will match person_du_NL.properties in the root bundle directory).

Parameters:

localization -

add

FactoryComponent add(PropertyMetaData... metaData)

Sets metatype MetaData regarding configuration properties.

Parameters:

metaData - the metadata regarding configuration properties