org.apache.felix.dm

Class DependencyManager

java.lang.Object

org.apache.felix.dm.DependencyManager

public class DependencyManager
extends java.lang.Object

The dependency manager manages all components and their dependencies. Using this API you can declare all components and their dependencies. Under normal circumstances, you get passed an instance of this class through the DependencyActivatorBase subclass you use as your BundleActivator, but it is also possible to create your own instance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASPECT
static java.lang.String	METHOD_CACHE_SIZE
static java.lang.String	PARALLEL The DependencyManager Activator will wait for a threadpool before creating any DM components if the following OSGi system property is set to true.
static java.lang.String	SERVICEREGISTRY_CACHE_INDICES

Constructor Summary

Constructors

Constructor and Description
DependencyManager(org.osgi.framework.BundleContext context) Creates a new dependency manager.

Method Summary

Modifier and Type	Method and Description
void	add(Component c) Adds a new component to the dependency manager.
void	clear() Removes all components and their dependencies.
Component	createAdapterFactoryConfigurationService(java.lang.String factoryPid, java.lang.String update, boolean propagate, java.lang.String heading, java.lang.String desc, java.lang.String localization, PropertyMetaData[] propertiesMetaData) Creates a new Managed Service Factory Configuration Adapter with meta type support.
Component	createAdapterService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter) Creates a new adapter.
Component	createAdapterService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, java.lang.String autoConfig) Creates a new adapter.
Component	createAdapterService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, java.lang.String autoConfig, java.lang.Object callbackInstance, java.lang.String add, java.lang.String change, java.lang.String remove, java.lang.String swap, boolean propagate) Creates a new adapter.
Component	createAdapterService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, java.lang.String add, java.lang.String change, java.lang.String remove) Creates a new adapter.
Component	createAdapterService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, java.lang.String add, java.lang.String change, java.lang.String remove, java.lang.String swap) Creates a new adapter.
Component	createAspectService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, int ranking) Creates a new aspect.
Component	createAspectService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, int ranking, java.lang.Object callbackInstance, java.lang.String add, java.lang.String change, java.lang.String remove, java.lang.String swap) Creates a new aspect.
Component	createAspectService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, int ranking, java.lang.String autoConfig) Creates a new aspect.
Component	createAspectService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, int ranking, java.lang.String add, java.lang.String change, java.lang.String remove) Creates a new aspect.
Component	createAspectService(java.lang.Class<?> serviceInterface, java.lang.String serviceFilter, int ranking, java.lang.String add, java.lang.String change, java.lang.String remove, java.lang.String swap) Creates a new aspect.
Component	createBundleAdapterService(int bundleStateMask, java.lang.String bundleFilter, boolean propagate) Creates a new bundle adapter.
Component	createBundleAdapterService(int bundleStateMask, java.lang.String bundleFilter, boolean propagate, java.lang.Object callbackInstance, java.lang.String add, java.lang.String change, java.lang.String remove) Creates a new bundle adapter using specific callback instance.
BundleDependency	createBundleDependency() Creates a new bundle dependency.
Component	createComponent() Creates a new component.
ConfigurationDependency	createConfigurationDependency() Creates a new configuration dependency.
Component	createFactoryConfigurationAdapterService(java.lang.String factoryPid, java.lang.String update, boolean propagate) Creates a new Factory Configuration Adapter.
Component	createFactoryConfigurationAdapterService(java.lang.String factoryPid, java.lang.String update, boolean propagate, java.lang.Class<?> configType) Creates a new Factory Configuration Adapter.
Component	createFactoryConfigurationAdapterService(java.lang.String factoryPid, java.lang.String update, boolean propagate, java.lang.Object callbackInstance) Creates a new Factory Configuration Adapter using a specific update callback instance.
Component	createFactoryConfigurationAdapterService(java.lang.String factoryPid, java.lang.String update, boolean propagate, java.lang.Object callbackInstance, java.lang.Class<?> configType) Creates a new Factory Configuration Adapter using a specific update callback instance.
PropertyMetaData	createPropertyMetaData() Creates a new configuration property metadata.
Component	createResourceAdapterService(java.lang.String resourceFilter, boolean propagate, java.lang.Object callbackInstance, java.lang.String callbackChanged) Creates a new resource adapter.
Component	createResourceAdapterService(java.lang.String resourceFilter, boolean propagate, java.lang.Object callbackInstance, java.lang.String callbackSet, java.lang.String callbackChanged)
Component	createResourceAdapterService(java.lang.String resourceFilter, java.lang.Object propagateCallbackInstance, java.lang.String propagateCallbackMethod, java.lang.Object callbackInstance, java.lang.String callbackChanged)
Component	createResourceAdapterService(java.lang.String resourceFilter, java.lang.Object propagateCallbackInstance, java.lang.String propagateCallbackMethod, java.lang.Object callbackInstance, java.lang.String callbackSet, java.lang.String callbackChanged)
ResourceDependency	createResourceDependency() Creates a new resource dependency.
ServiceDependency	createServiceDependency() Creates a new service dependency.
ServiceDependency	createTemporalServiceDependency(long timeout) Creates a new timed required service dependency.
org.osgi.framework.BundleContext	getBundleContext() Returns the bundle context associated with this dependency manager.
java.util.List<Component>	getComponents() Returns a list of components.
static java.util.List<DependencyManager>	getDependencyManagers() Returns the list of currently created dependency managers.
void	remove(Component c) Removes a service from the dependency manager.

Methods inherited from class java.lang.Object

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

Field Detail

PARALLEL

public static final java.lang.String PARALLEL

The DependencyManager Activator will wait for a threadpool before creating any DM components if the following OSGi system property is set to true.

See Also:

Constant Field Values

ASPECT

public static final java.lang.String ASPECT

See Also:

Constant Field Values

SERVICEREGISTRY_CACHE_INDICES

public static final java.lang.String SERVICEREGISTRY_CACHE_INDICES

See Also:

Constant Field Values

METHOD_CACHE_SIZE

public static final java.lang.String METHOD_CACHE_SIZE

See Also:

Constant Field Values

Constructor Detail

DependencyManager

public DependencyManager(org.osgi.framework.BundleContext context)

Creates a new dependency manager. You need to supply the BundleContext to be used by the dependency manager to register services and communicate with the framework.

Parameters:

context - the bundle context

Method Detail

getDependencyManagers

public static java.util.List<DependencyManager> getDependencyManagers()

Returns the list of currently created dependency managers.

Returns:

the list of currently created dependency managers

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()

Returns the bundle context associated with this dependency manager.

Returns:

the bundle context associated with this dependency manager.

add

public void add(Component c)

Adds a new component to the dependency manager. After the service is added it will be started immediately.

Parameters:

c - the service to add

remove

public void remove(Component c)

Removes a service from the dependency manager. Before the service is removed it is stopped first.

Parameters:

c - the component to remove

createComponent

public Component createComponent()

Creates a new component.

Returns:

the new component

createServiceDependency

public ServiceDependency createServiceDependency()

Creates a new service dependency.

Returns:

the service dependency

createConfigurationDependency

public ConfigurationDependency createConfigurationDependency()

Creates a new configuration dependency.

Returns:

the configuration dependency

createBundleDependency

public BundleDependency createBundleDependency()

Creates a new bundle dependency.

Returns:

a new BundleDependency instance.

createResourceDependency

public ResourceDependency createResourceDependency()

Creates a new resource dependency.

Returns:

the resource dependency

createTemporalServiceDependency

public ServiceDependency createTemporalServiceDependency(long timeout)

Creates a new timed required service dependency. A timed dependency blocks the invoker thread is the required dependency is currently unavailable, until it comes up again.

Returns:

a new timed service dependency

createAdapterService

public Component createAdapterService(java.lang.Class<?> serviceInterface,
                                      java.lang.String serviceFilter)

Creates a new adapter. The adapter will be applied to any service that matches the specified interface and filter. For each matching service an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface and existing properties from the original service plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAdapterService(AdapteeService.class, "(foo=bar)")
     .setInterface(AdapterService.class, new Hashtable() {{ put("extra", "property"); }})
     .setImplementation(AdapterImpl.class);
 

Parameters:

serviceInterface - the service interface to apply the adapter to

serviceFilter - the filter condition to use with the service interface

Returns:

a service that acts as a factory for generating adapters

createAdapterService

public Component createAdapterService(java.lang.Class<?> serviceInterface,
                                      java.lang.String serviceFilter,
                                      java.lang.String autoConfig)

Creates a new adapter. The adapter will be applied to any service that matches the specified interface and filter. For each matching service an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface and existing properties from the original service plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAdapterService(AdapteeService.class, "(foo=bar)", "m_service")
     .setInterface(AdapterService.class, new Hashtable() {{ put("extra", "property"); }})
     .setImplementation(AdapterImpl.class);
 

Parameters:

serviceInterface - the service interface to apply the adapter to

serviceFilter - the filter condition to use with the service interface

autoConfig - the name of the member to inject the service into

Returns:

a service that acts as a factory for generating adapters

createAdapterService

public Component createAdapterService(java.lang.Class<?> serviceInterface,
                                      java.lang.String serviceFilter,
                                      java.lang.String add,
                                      java.lang.String change,
                                      java.lang.String remove)

Creates a new adapter. The adapter will be applied to any service that matches the specified interface and filter. For each matching service an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface and existing properties from the original service plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAdapterService(AdapteeService.class, "(foo=bar)", "add", "change", "remove")
     .setInterface(AdapterService.class, new Hashtable() {{ put("extra", "property"); }})
     .setImplementation(AdapterImpl.class);
 

Parameters:

serviceInterface - the service interface to apply the adapter to

serviceFilter - the filter condition to use with the service interface

add - name of the callback method to invoke on add

change - name of the callback method to invoke on change

remove - name of the callback method to invoke on remove

Returns:

a service that acts as a factory for generating adapters

createAdapterService

public Component createAdapterService(java.lang.Class<?> serviceInterface,
                                      java.lang.String serviceFilter,
                                      java.lang.String add,
                                      java.lang.String change,
                                      java.lang.String remove,
                                      java.lang.String swap)

Creates a new adapter. The adapter will be applied to any service that matches the specified interface and filter. For each matching service an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface and existing properties from the original service plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAdapterService(AdapteeService.class, "(foo=bar)", "add", "change", "remove", "swap")
     .setInterface(AdapterService.class, new Hashtable() {{ put("extra", "property"); }})
     .setImplementation(AdapterImpl.class);
 

Parameters:

serviceInterface - the service interface to apply the adapter to

serviceFilter - the filter condition to use with the service interface

add - name of the callback method to invoke on add

change - name of the callback method to invoke on change

remove - name of the callback method to invoke on remove

swap - name of the callback method to invoke on swap

Returns:

a service that acts as a factory for generating adapters

createAdapterService

public Component createAdapterService(java.lang.Class<?> serviceInterface,
                                      java.lang.String serviceFilter,
                                      java.lang.String autoConfig,
                                      java.lang.Object callbackInstance,
                                      java.lang.String add,
                                      java.lang.String change,
                                      java.lang.String remove,
                                      java.lang.String swap,
                                      boolean propagate)

Creates a new adapter. The adapter will be applied to any service that matches the specified interface and filter. For each matching service an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface (and existing properties from the original service if you set the propagate flag) plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAdapterService(AdapteeService.class, "(foo=bar)", "add", "change", "remove", "swap")
     .setInterface(AdapterService.class, new Hashtable() {{ put("extra", "property"); }})
     .setImplementation(AdapterImpl.class);
 

Parameters:

serviceInterface - the service interface to apply the adapter to

serviceFilter - the filter condition to use with the service interface

autoConfig - the name of the member to inject the service into, or null.

callbackInstance - the instance to invoke the callbacks on, or null if the callbacks have to be invoked on the adapter itself

add - name of the callback method to invoke on add

change - name of the callback method to invoke on change

remove - name of the callback method to invoke on remove

swap - name of the callback method to invoke on swap

propagate - true if the adaptee service properties should be propagated to the adapter service consumers

Returns:

a service that acts as a factory for generating adapters

createFactoryConfigurationAdapterService

public Component createFactoryConfigurationAdapterService(java.lang.String factoryPid,
                                                          java.lang.String update,
                                                          boolean propagate)

Creates a new Factory Configuration Adapter. For each new factory configuration matching the factoryPid, an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface, and with the specified adapter service properties. Depending on the propagate parameter, every public factory configuration properties (which don't start with ".") will be propagated along with the adapter service properties. It will also inherit all dependencies.

The callback you specify may accept the following method signatures:

• updated(Dictionary)
• updated(Component, Dictionary)

Usage example:

  manager.createFactoryConfigurationAdapterService("MyFactoryPid",  "update", true)
         // The interface to use when registering adapter
         .setInterface(AdapterService.class.getName(), new Hashtable() {{ put("foo", "bar"); }})
         // the implementation of the adapter
         .setImplementation(AdapterServiceImpl.class);
 

Parameters:

factoryPid - the pid matching the factory configuration

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

propagate - true if public factory configuration should be propagated to the adapter service properties

Returns:

a service that acts as a factory for generating the managed service factory configuration adapter

createFactoryConfigurationAdapterService

public Component createFactoryConfigurationAdapterService(java.lang.String factoryPid,
                                                          java.lang.String update,
                                                          boolean propagate,
                                                          java.lang.Object callbackInstance)

Creates a new Factory Configuration Adapter using a specific update callback instance. For each new factory configuration matching the factoryPid, an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface, and with the specified adapter service properties. Depending on the propagate parameter, every public factory configuration properties (which don't start with ".") will be propagated along with the adapter service properties. It will also inherit all dependencies.

The callback you specify may accept the following method signatures:

• updated(Dictionary)
• updated(Component, Dictionary)

Parameters:

factoryPid - the pid matching the factory configuration

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

propagate - true if public factory configuration should be propagated to the adapter service properties

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

Returns:

a service that acts as a factory for generating the managed service factory configuration adapter

createFactoryConfigurationAdapterService

public Component createFactoryConfigurationAdapterService(java.lang.String factoryPid,
                                                          java.lang.String update,
                                                          boolean propagate,
                                                          java.lang.Class<?> configType)

Creates a new Factory Configuration Adapter. For each new factory configuration matching the factoryPid, an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface, and with the specified adapter service properties. Depending on the propagate parameter, every public factory configuration properties (which don't start with ".") will be propagated along with the adapter service properties. It will also inherit all dependencies.

The callback you specify may accept the following method signatures:

• updated(Dictionary)
• updated(Component, Dictionary)
• updated(ConfigurationType)
• updated(Component, ConfigurationType)

The ConfigurationType parameter is an implementation of the configType argument.

Parameters:

factoryPid - the pid matching the factory configuration

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

propagate - true if public factory configuration should be propagated to the adapter service properties

configType - the configuration type to use instead of a dictionary. See the javadoc from ConfigurationDependency for more informations about type-safe configuration.

Returns:

a service that acts as a factory for generating the managed service factory configuration adapter

See Also:

ConfigurationDependency

createFactoryConfigurationAdapterService

public Component createFactoryConfigurationAdapterService(java.lang.String factoryPid,
                                                          java.lang.String update,
                                                          boolean propagate,
                                                          java.lang.Object callbackInstance,
                                                          java.lang.Class<?> configType)

Creates a new Factory Configuration Adapter using a specific update callback instance. For each new factory configuration matching the factoryPid, an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface, and with the specified adapter service properties. Depending on the propagate parameter, every public factory configuration properties (which don't start with ".") will be propagated along with the adapter service properties. It will also inherit all dependencies.

The callback you specify may accept the following method signatures:

• updated(Dictionary)
• updated(Component, Dictionary)
• updated(ConfigurationType)
• updated(Component, ConfigurationType)

The ConfigurationType parameter is an implementation of the configType argument.

Parameters:

factoryPid - the pid matching the factory configuration

propagate - true if public factory configuration should be propagated to the adapter service properties

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

configType - the configuration type to use instead of a dictionary. See the javadoc from ConfigurationDependency for more informations about type-safe configuration.

Returns:

a service that acts as a factory for generating the managed service factory configuration adapter

createAdapterFactoryConfigurationService

public Component createAdapterFactoryConfigurationService(java.lang.String factoryPid,
                                                          java.lang.String update,
                                                          boolean propagate,
                                                          java.lang.String heading,
                                                          java.lang.String desc,
                                                          java.lang.String localization,
                                                          PropertyMetaData[] propertiesMetaData)

Creates a new Managed Service Factory Configuration Adapter with meta type support. For each new factory configuration matching the factoryPid, an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface, and with the specified adapter service properties. Depending on the propagate parameter, every public factory configuration properties (which don't start with ".") will be propagated along with the adapter service properties. It will also inherit all dependencies.

Usage example:

       PropertyMetaData[] propertiesMetaData = new PropertyMetaData[] {
            manager.createPropertyMetaData()
               .setCardinality(Integer.MAX_VALUE)
               .setType(String.class)
               .setHeading("English words")
               .setDescription("Declare here some valid english words")
               .setDefaults(new String[] {"hello", "world"})
               .setId("words")
       };
 
       manager.add(createFactoryConfigurationAdapterService("FactoryPid", 
                                                            "updated",
                                                            true, // propagate CM settings
                                                            "EnglishDictionary",
                                                            "English dictionary configuration properties",
                                                            null,
                                                            propertiesMetaData)
               .setImplementation(Adapter.class));
 

Parameters:

factoryPid - the pid matching the factory configuration

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

The following signatures are supported:

• updated(Dictionary)
• updated(Component, Dictionary)

propagate - true if public factory configuration should be propagated to the adapter service properties

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

desc - A human readable description of the factory PID this configuration is associated with. Example: "Configuration for the PrinterService bundle"

localization - Points to the 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).

propertiesMetaData - Array of MetaData regarding configuration properties

Returns:

a service that acts as a factory for generating the managed service factory configuration adapter

createBundleAdapterService

public Component createBundleAdapterService(int bundleStateMask,
                                            java.lang.String bundleFilter,
                                            boolean propagate)

Creates a new bundle adapter. The adapter will be applied to any bundle that matches the specified bundle state mask and filter condition. For each matching bundle an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface TODO and existing properties from the original resource plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

  manager.createBundleAdapterService(Bundle.INSTALLED | Bundle.RESOLVED | Bundle.ACTIVE, 
                                     "(Bundle-SymbolicName=org.apache.felix.dependencymanager)",
                                     true)
         // The interface to use when registering adapter
         .setInterface(AdapterService.class.getName(), new Hashtable() {{ put("foo", "bar"); }})
         // the implementation of the adapter
         .setImplementation(AdapterServiceImpl.class);
 

Parameters:

bundleStateMask - the bundle state mask to apply

bundleFilter - the filter to apply to the bundle manifest

propagate - true if properties from the bundle should be propagated to the service

Returns:

a service that acts as a factory for generating bundle adapters

createBundleAdapterService

public Component createBundleAdapterService(int bundleStateMask,
                                            java.lang.String bundleFilter,
                                            boolean propagate,
                                            java.lang.Object callbackInstance,
                                            java.lang.String add,
                                            java.lang.String change,
                                            java.lang.String remove)

Creates a new bundle adapter using specific callback instance. The adapter will be applied to any bundle that matches the specified bundle state mask and filter condition. For each matching bundle an adapter will be created based on the adapter implementation class, and The adapter will be registered with the specified interface.

Parameters:

bundleStateMask - the bundle state mask to apply

bundleFilter - the filter to apply to the bundle manifest

propagate - true if properties from the bundle should be propagated to the service

callbackInstance - the instance to invoke the callbacks on, or null if the callbacks have to be invoked on the adapter itself

add - name of the callback method to invoke on add

change - name of the callback method to invoke on change

remove - name of the callback method to invoke on remove

Returns:

a service that acts as a factory for generating bundle adapters

createResourceAdapterService

public Component createResourceAdapterService(java.lang.String resourceFilter,
                                              boolean propagate,
                                              java.lang.Object callbackInstance,
                                              java.lang.String callbackChanged)

Creates a new resource adapter. The adapter will be applied to any resource that matches the specified filter condition. For each matching resource an adapter will be created based on the adapter implementation class. The adapter will be registered with the specified interface and existing properties from the original resource plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

  manager.createResourceAdapterService("(&(path=/test)(repository=TestRepository))", true)
         // The interface to use when registering adapter
         .setInterface(AdapterService.class.getName(), new Hashtable() {{ put("foo", "bar"); }})
         // the implementation of the adapter
         .setImplementation(AdapterServiceImpl.class);
 

Parameters:

resourceFilter - the filter condition to use with the resource

propagate - true if properties from the resource should be propagated to the service

callbackInstance - instance to invoke the callback on

callbackChanged - the name of the callback method

Returns:

a service that acts as a factory for generating resource adapters

createResourceAdapterService

public Component createResourceAdapterService(java.lang.String resourceFilter,
                                              boolean propagate,
                                              java.lang.Object callbackInstance,
                                              java.lang.String callbackSet,
                                              java.lang.String callbackChanged)

See Also:

createResourceAdapterService(String, boolean, Object, String)

createResourceAdapterService

public Component createResourceAdapterService(java.lang.String resourceFilter,
                                              java.lang.Object propagateCallbackInstance,
                                              java.lang.String propagateCallbackMethod,
                                              java.lang.Object callbackInstance,
                                              java.lang.String callbackChanged)

See Also:

createResourceAdapterService(String, boolean, Object, String)

createResourceAdapterService

public Component createResourceAdapterService(java.lang.String resourceFilter,
                                              java.lang.Object propagateCallbackInstance,
                                              java.lang.String propagateCallbackMethod,
                                              java.lang.Object callbackInstance,
                                              java.lang.String callbackSet,
                                              java.lang.String callbackChanged)

See Also:

createResourceAdapterService(String, boolean, Object, String)

getComponents

public java.util.List<Component> getComponents()

Returns a list of components.

Returns:

a list of components

createAspectService

public Component createAspectService(java.lang.Class<?> serviceInterface,
                                     java.lang.String serviceFilter,
                                     int ranking,
                                     java.lang.String autoConfig)

Creates a new aspect. The aspect will be applied to any service that matches the specified interface and filter. For each matching service an aspect will be created based on the aspect implementation class. The aspect will be registered with the same interface and properties as the original service, plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAspectService(ExistingService.class, "(foo=bar)", 10, "m_service")
     .setImplementation(ExistingServiceAspect.class)
 );
 

Parameters:

serviceInterface - the service interface to apply the aspect to

serviceFilter - the filter condition to use with the service interface

ranking - the level used to organize the aspect chain ordering

autoConfig - the aspect implementation field name where to inject original service. If null, any field matching the original service will be injected.

Returns:

a service that acts as a factory for generating aspects

createAspectService

public Component createAspectService(java.lang.Class<?> serviceInterface,
                                     java.lang.String serviceFilter,
                                     int ranking)

Creates a new aspect. The aspect will be applied to any service that matches the specified interface and filter. For each matching service an aspect will be created based on the aspect implementation class. The aspect will be registered with the same interface and properties as the original service, plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAspectService(ExistingService.class, "(foo=bar)", 10)
     .setImplementation(ExistingServiceAspect.class)
 );
 

Parameters:

serviceInterface - the service interface to apply the aspect to

serviceFilter - the filter condition to use with the service interface

ranking - the level used to organize the aspect chain ordering

Returns:

a service that acts as a factory for generating aspects

createAspectService

public Component createAspectService(java.lang.Class<?> serviceInterface,
                                     java.lang.String serviceFilter,
                                     int ranking,
                                     java.lang.String add,
                                     java.lang.String change,
                                     java.lang.String remove)

Creates a new aspect. The aspect will be applied to any service that matches the specified interface and filter. For each matching service an aspect will be created based on the aspect implementation class. The aspect will be registered with the same interface and properties as the original service, plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAspectService(ExistingService.class, "(foo=bar)", 10, "add", "change", "remove")
     .setImplementation(ExistingServiceAspect.class)
 );
 

Parameters:

serviceInterface - the service interface to apply the aspect to

serviceFilter - the filter condition to use with the service interface

ranking - the level used to organize the aspect chain ordering

add - name of the callback method to invoke on add

change - name of the callback method to invoke on change

remove - name of the callback method to invoke on remove

Returns:

a service that acts as a factory for generating aspects

createAspectService

public Component createAspectService(java.lang.Class<?> serviceInterface,
                                     java.lang.String serviceFilter,
                                     int ranking,
                                     java.lang.String add,
                                     java.lang.String change,
                                     java.lang.String remove,
                                     java.lang.String swap)

Creates a new aspect. The aspect will be applied to any service that matches the specified interface and filter. For each matching service an aspect will be created based on the aspect implementation class. The aspect will be registered with the same interface and properties as the original service, plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAspectService(ExistingService.class, "(foo=bar)", 10, "add", "change", "remove")
     .setImplementation(ExistingServiceAspect.class)
 );
 

Parameters:

serviceInterface - the service interface to apply the aspect to

serviceFilter - the filter condition to use with the service interface

ranking - the level used to organize the aspect chain ordering

add - name of the callback method to invoke on add

change - name of the callback method to invoke on change

remove - name of the callback method to invoke on remove

swap - name of the callback method to invoke on swap

Returns:

a service that acts as a factory for generating aspects

createAspectService

public Component createAspectService(java.lang.Class<?> serviceInterface,
                                     java.lang.String serviceFilter,
                                     int ranking,
                                     java.lang.Object callbackInstance,
                                     java.lang.String add,
                                     java.lang.String change,
                                     java.lang.String remove,
                                     java.lang.String swap)

Creates a new aspect. The aspect will be applied to any service that matches the specified interface and filter. For each matching service an aspect will be created based on the aspect implementation class. The aspect will be registered with the same interface and properties as the original service, plus any extra properties you supply here. It will also inherit all dependencies, and if you declare the original service as a member it will be injected.

Usage example:

 manager.createAspectService(ExistingService.class, "(foo=bar)", 10, "add", "change", "remove")
     .setImplementation(ExistingServiceAspect.class)
 );
 

Parameters:

serviceInterface - the service interface to apply the aspect to

serviceFilter - the filter condition to use with the service interface

ranking - the level used to organize the aspect chain ordering

callbackInstance - the instance to invoke the callbacks on, or null if the callbacks have to be invoked on the aspect itself

add - name of the callback method to invoke on add

change - name of the callback method to invoke on change

remove - name of the callback method to invoke on remove

swap - name of the callback method to invoke on swap

Returns:

a service that acts as a factory for generating aspects

clear

public void clear()

Removes all components and their dependencies.

createPropertyMetaData

public PropertyMetaData createPropertyMetaData()

Creates a new configuration property metadata.

Returns:

the configuration property metadata.