org.apache.felix.dm

Interface ResourceComponent

All Superinterfaces:

AbstractComponent, Component<ResourceComponent>

public interface ResourceComponent
extends Component<ResourceComponent>

Interface used to configure the various parameters needed when defining a Dependency Manager resource adapter component. The resource 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 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 resourceComponent = dm.createResourceComponent()
             .setResourceFilter("(path=/videos/*.mkv)")
             .setInterface(VideoPlayer.class, null)
             .setImplementation(VideoPlayerImpl.class);
         dm.add(resourceComponent);
     }
 }
 
 public interface VideoPlayer {
     void play();
 }
 
 public class VideoPlayerImpl implements VideoPlayer {
     volatile URL resource; // injected 
     
     void play() {
         ...
     }
 }
  

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

 (Component, URL, Dictionary)
 (Component, URL)
 (Component) 
 (URL, Dictionary)
 (URL)
 (Object)
 

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
ResourceComponent	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 resource adapter itself)
ResourceComponent	setBundleCallbacks(java.lang.String add, java.lang.String change) Sets the callbacks to invoke when injecting the resource into the adapter component.
ResourceComponent	setPropagate(boolean propagate) Sets if properties from the resource should be propagated to the resource adapter service.
ResourceComponent	setPropagate(java.lang.Object propagateCbInstance, java.lang.String propagateCbMethod) Sets the propagate callback to invoke in order to propagate the resource properties to the adapter service.
ResourceComponent	setResourceFilter(java.lang.String filter) Sets the resource filter used to match a given resource URL.

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

setResourceFilter

ResourceComponent setResourceFilter(java.lang.String filter)

Sets the resource filter used to match a given resource URL.

Parameters:

filter - the filter condition to use with the resource

Returns:

this ResourceComponent

setPropagate

ResourceComponent setPropagate(boolean propagate)

Sets if properties from the resource should be propagated to the resource adapter service. true by default.

Parameters:

propagate - true if if properties from the resource should be propagated to the resource adapter service. true by default. The provided resource adapter service properties take precedence over the propagated resource service properties.

Returns:

this ResourceComponent

setPropagate

ResourceComponent setPropagate(java.lang.Object propagateCbInstance,
                               java.lang.String propagateCbMethod)

Sets the propagate callback to invoke in order to propagate the resource properties to the adapter service. The provided resource adapter service properties take precedence over the propagated resource service properties.

Parameters:

propagateCbInstance - the object to invoke the propagate callback method on

propagateCbMethod - the method name to invoke in order to propagate the resource properties to the adapter service.

Returns:

this ResourceComponent

setBundleCallbacks

ResourceComponent setBundleCallbacks(java.lang.String add,
                                     java.lang.String change)

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

Parameters:

add - the method to invoke when injected the resource into the adapter component

change - the method to invoke when the resource properties have changed

Returns:

this ResourceComponent

setBundleCallbackInstance

ResourceComponent 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 resource adapter itself)

Parameters:

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

Returns:

this ResourceComponent