org.apache.felix.dm

Interface BundleComponent

All Superinterfaces:

AbstractComponent, Component<BundleComponent>

public interface BundleComponent
extends Component<BundleComponent>

Interface used to configure the various parameters needed when defining a Dependency Manager bundle adapter component. Bundle Adapters, like AdapterComponent, are used to "extend" existing bundles, and can publish an adapter services based on the existing bundle. An example would be implementing a video player which adapters a resource bundle having some specific headers.

When you create a bundle adapter component, it will be applied to any bundle that matches the specified bundle state mask as well as the specified ldap filter used to match the bundle manifest headers. The bundle adapter will be registered with the specified bundle manifest headers as service properties, plus any extra properties you suppl. If you declare a bundle field in your bundle adapter class, it will be injected it will be injected with the original bundle.

Usage Examples

Here is a sample showing a VideoPlayer adapter component which plays a video found from a bundle having a Video-Path manifest header.

 
 public class Activator extends DependencyActivatorBase {
     &Override
     public void init(BundleContext context, DependencyManager dm) throws Exception {
         Component bundleComponent = createBundleComponent()
             .setFilter(Bundle.ACTIVE, "(Video-Path=*)")
             .setInterface(VideoPlayer.class.getName(), null)
             .setImplementation(VideoPlayerImpl.class);
         dm.add(bundleComponent);
     }
 }
 
 public interface VideoPlayer {
     void play();
 }
 
 public class VideoPlayerImpl implements VideoPlayer {
     volatile Bundle bundle; // injected
     String path;
     
     void start() {
        path = bundle.getHeaders().get("Video-Path");
     }
     
     void play() {
         ...
     }
 }
  

When you use callbacks to get injected with the bundle, the "add", "change", "remove" callbacks support the following method signatures:

 (Bundle)
 (Object)
 (COmponent, Bundle)
 

See Also:

DependencyManager.createBundleComponent()

Nested Class Summary

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

Component.ServiceScope

Method Summary

Modifier and Type	Method and Description
BundleComponent	setBundleCallbackInstance(java.lang.Object callbackInstance) Sets the instance to invoke the callbacks on (null by default, meaning the callbacks have to be invoked on the adapter itself)
BundleComponent	setBundleCallbacks(java.lang.String add, java.lang.String change, java.lang.String remove) Sets the callbacks to invoke when injecting the bundle into the adapter component.
BundleComponent	setBundleFilter(int bundleStateMask, java.lang.String bundleFilter) Sets the bundle state mask and bundle manifest headers filter.
BundleComponent	setPropagate(boolean propagate) Sets if the bundle manifest headers should be propagated to the bundle component adapter service consumer (true by default).

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

setBundleFilter

BundleComponent setBundleFilter(int bundleStateMask,
                                java.lang.String bundleFilter)

Sets the bundle state mask and bundle manifest headers filter.

Parameters:

bundleStateMask - the bundle state mask to apply

bundleFilter - the filter to apply to the bundle manifest

Returns:

this BundleComponent

setBundleCallbacks

BundleComponent setBundleCallbacks(java.lang.String add,
                                   java.lang.String change,
                                   java.lang.String remove)

Sets the callbacks to invoke when injecting the bundle into the adapter component.

Parameters:

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:

this BundleComponent

setBundleCallbackInstance

BundleComponent setBundleCallbackInstance(java.lang.Object callbackInstance)

Sets the instance to invoke the callbacks on (null by default, meaning the callbacks have to be invoked on the adapter itself)

Parameters:

callbackInstance - the instance to invoke the callbacks on (null by default, meaning the callbacks have to be invoked on the adapter itself)

Returns:

this BundleComponent

setPropagate

BundleComponent setPropagate(boolean propagate)

Sets if the bundle manifest headers should be propagated to the bundle component adapter service consumer (true by default). The component service properties take precedence over the propagated bundle manifest headers.

Parameters:

propagate - true if the bundle manifest headers should be propagated to the adapter service consumers

Returns:

this BundleComponent