DependencyManagerActivator

java.lang.Object
- org.apache.felix.dm.lambda.DependencyManagerActivator

public abstract class DependencyManagerActivator
extends java.lang.Object

Defines a base for Activators in order to build DependencyManager Components using a java8 style.

Code example using auto configured fields:

 
 
 import org.apache.felix.dm.lambda.DependencyManagerActivator;

 public class Activator extends DependencyManagerActivator {    
     public void init(BundleContext ctx, DependencyManager dm) throws Exception {
         component(comp -> comp
             .provides(Service.class, property -> "value")
             .impl(ServiceImpl.class)            
             .withSvc(LogService.class, ConfigurationAdmni.class) // both services are required and injected in class fields with compatible types.           
     }
 }

Code example using reflection callbacks:

 
 import org.apache.felix.dm.lambda.DependencyManagerActivator;

 public class Activator extends DependencyManagerActivator {    
     public void init(BundleContext ctx, DependencyManager dm) throws Exception {
         component(comp -> comp
             .provides(Service.class, property -> "value")
             .impl(ServiceImpl.class)            
             .withSvc(LogService.class, svc -> svc.add("setLog"))              
             .withSvc(ConfigurationAdmni.class, svc -> svc.add("setConfigAdmin")))                
     }
 }

Code example using method references:

 
 import org.apache.felix.dm.lambda.DependencyManagerActivator;

 public class Activator extends DependencyManagerActivator {    
     public void init(BundleContext ctx, DependencyManager dm) throws Exception {
         component(comp -> comp
             .provides(Service.class, property -> "value")
             .impl(ServiceImpl.class)            
             .withSvc(LogService.class, svc -> svc.add(ServiceImpl::setLog))              
             .withSvc(ConfigurationAdmni.class, svc -> svc.add(ServiceImpl::setConfigAdmin)))                
     }
 }

When a dependency is not explicitly defined as "required" or "optional", then it is assumed to be optional by default, like it is the case with the original DM API. You can change the default mode using the "org.apache.felix.dependencymanager.lambda.defaultRequiredDependency system property" (see Felix dm-lambda online documentation).

Constructor Summary

Constructors
Constructor and Description

DependencyManagerActivator()

Constructors
Constructor and Description
`DependencyManagerActivator()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected <T> ServiceAdapterBuilder<T>`	`adapter(java.lang.Class<T> adaptee)` Creates a service Adapter builder that can be used to create a DM Adapter Component.
`protected <T> Component`	`adapter(java.lang.Class<T> adaptee, java.util.function.Consumer<ServiceAdapterBuilder<T>> consumer)` Builds a DM Adapter Component using a Java8 style AdapterBuilder.
`static <T> ServiceAdapterBuilder<T>`	`adapter(DependencyManager dm, java.lang.Class<T> adaptee)` Creates a service Adapter builder that can be used to create an Adapter Component.
`static <T> Component`	`adapter(DependencyManager dm, java.lang.Class<T> adaptee, java.util.function.Consumer<ServiceAdapterBuilder<T>> consumer)` Builds an adapter DM Component.
`protected <T> ServiceAspectBuilder<T>`	`aspect(java.lang.Class<T> aspectType)` Creates a service Aspect builder that can be used to create a DM Aspect Component.
`protected <T> Component`	`aspect(java.lang.Class<T> aspect, java.util.function.Consumer<ServiceAspectBuilder<T>> consumer)` Builds a DM Aspect Component using a Java8 style AspectBuilder.
`static <T> ServiceAspectBuilder<T>`	`aspect(DependencyManager dm, java.lang.Class<T> aspect)` Creates a service Aspect builder that can be used to create an Aspect Component.
`static <T> Component`	`aspect(DependencyManager dm, java.lang.Class<T> aspect, java.util.function.Consumer<ServiceAspectBuilder<T>> consumer)` Builds an aspect DM Component.
`protected Component`	`bundleAdapter(java.util.function.Consumer<BundleAdapterBuilder> consumer)` Builds a DM Bundle Adapter Component.
`static BundleAdapterBuilder`	`bundleAdapter(DependencyManager dm)` Creates a bundle adapter builder that can be used to create a DM bundle adapter Component.
`static Component`	`bundleAdapter(DependencyManager dm, java.util.function.Consumer<BundleAdapterBuilder> consumer)` Builds a bundle adapter DM Component.
`static BundleDependencyBuilder`	`bundleDependency(Component component)` Creates a DM Bundle Dependency builder.
`protected ComponentBuilder<?>`	`component()` Creates a Component builder that can be used to create a DM Component.
`static void`	`component(Component comp, java.util.function.Consumer<ComponentBuilder<?>> consumer)` Update an existing component.
`protected Component`	`component(java.util.function.Consumer<ComponentBuilder<?>> consumer)` Builds a DM Component using a Java8 style ComponentBuilder.
`static ComponentBuilder<?>`	`component(DependencyManager dm)` Creates a Component builder that can be used to create a Component.
`static Component`	`component(DependencyManager dm, java.util.function.Consumer<ComponentBuilder<?>> consumer)` Builds a component using a lambda and a component builder
`static ConfigurationDependencyBuilder`	`confDependency(Component component)` Creates a DM Configuration Dependency builder.
`protected void`	`destroy()` Sub classes may override this method that is called when the Activator is stopped.
`protected Component`	`factoryPidAdapter(java.util.function.Consumer<FactoryPidAdapterBuilder> consumer)` Builds a DM Factory Configuration Adapter Component using a Java8 style FactoryPidAdapterBuilder.
`static FactoryPidAdapterBuilder`	`factoryPidAdapter(DependencyManager dm)` Creates a factory pid adapter that can be used to create a factory adapter Component.
`static Component`	`factoryPidAdapter(DependencyManager dm, java.util.function.Consumer<FactoryPidAdapterBuilder> consumer)` Builds a DM factory configuration adapter.
`static <F> FutureDependencyBuilder<F>`	`futureDependency(Component component, java.util.concurrent.CompletableFuture<F> future)` Creates a DM CompletableFuture Dependency builder.
`BundleContext`	`getBC()` Returns the bundle context that is associated with this bundle.
`DependencyManager`	`getDM()` Returns the DependencyManager used to create/managed DM Components.
`protected abstract void`	`init(BundleContext ctx, DependencyManager dm)` Sub classes must override this method in order to build some DM components.
`static <T> ServiceDependencyBuilder<T>`	`serviceDependency(Component component, java.lang.Class<T> service)` Creates a DM ServiceDependency builder.
`void`	`start(BundleContext context)` Our Activator is starting.
`void`	`stop(BundleContext context)` Our Activator is stopped.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DependencyManagerActivator
```
public DependencyManagerActivator()
```
- Method Detail
  - start
```
public void start(BundleContext context)
           throws java.lang.Exception
```
    Our Activator is starting.
    
    Throws:
    
    java.lang.Exception
  - stop
```
public void stop(BundleContext context)
          throws java.lang.Exception
```
    Our Activator is stopped.
    
    Throws:
    
    java.lang.Exception
  - init
```
protected abstract void init(BundleContext ctx,
                             DependencyManager dm)
                      throws java.lang.Exception
```
    Sub classes must override this method in order to build some DM components.
    
    Parameters:
    
    ctx - the context associated to the bundle
    
    dm - the DependencyManager assocaited to this activator
    
    Throws:
    
    java.lang.Exception - if the activation fails
  - destroy
```
protected void destroy()
                throws java.lang.Exception
```
    Sub classes may override this method that is called when the Activator is stopped.
    
    Throws:
    
    java.lang.Exception - if the deactivation fails
  - getDM
```
public DependencyManager getDM()
```
    Returns the DependencyManager used to create/managed DM Components.
    
    Returns:
    
    the DependencyManager associated to this Activator
  - getBC
```
public BundleContext getBC()
```
    Returns the bundle context that is associated with this bundle.
    
    Returns:
    
    the bundle context
  - component
```
protected ComponentBuilder<?> component()
```
    Creates a Component builder that can be used to create a DM Component.
    
    Returns:
    
    a Component builder that can be used to create a DM Component.
  - aspect
```
protected <T> ServiceAspectBuilder<T> aspect(java.lang.Class<T> aspectType)
```
    Creates a service Aspect builder that can be used to create a DM Aspect Component.
    
    Type Parameters:
    
    T - the aspect service type
    
    Parameters:
    
    aspectType - the aspect service
    
    Returns:
    
    a service Aspect builder.
  - adapter
```
protected <T> ServiceAdapterBuilder<T> adapter(java.lang.Class<T> adaptee)
```
    Creates a service Adapter builder that can be used to create a DM Adapter Component.
    
    Type Parameters:
    
    T - the adapted service type.
    
    Parameters:
    
    adaptee - the adapted service
    
    Returns:
    
    a service Adapter builder.
  - component
```
protected Component component(java.util.function.Consumer<ComponentBuilder<?>> consumer)
```
    Builds a DM Component using a Java8 style ComponentBuilder.
    
    Parameters:
    
    consumer - the lambda that will use the ComponentBuilder for building the DM component. The component is auto-added to the DependencyManager, unless the lambda calls the ComponentBuilder.autoAdd(false) method.
    
    Returns:
    
    a newly built DM component.
  - aspect
```
protected <T> Component aspect(java.lang.Class<T> aspect,
                               java.util.function.Consumer<ServiceAspectBuilder<T>> consumer)
```
    Builds a DM Aspect Component using a Java8 style AspectBuilder. The component is auto-added to the DependencyManager, unless the lambda calls the AspectBuilder.autoAdd(false) method.
    
    Type Parameters:
    
    T - the aspect service type
    
    Parameters:
    
    aspect - the aspect service
    
    consumer - the lambda that will use the AspectBuilder for building the DM aspect component.
    
    Returns:
    
    the DM component build by the consumer of the aspect builder
  - adapter
```
protected <T> Component adapter(java.lang.Class<T> adaptee,
                                java.util.function.Consumer<ServiceAdapterBuilder<T>> consumer)
```
    Builds a DM Adapter Component using a Java8 style AdapterBuilder. The component is auto-added to the DependencyManager, unless the lambda calls the AdapterBuilder.autoAdd(false) method.
    
    Type Parameters:
    
    T - the adapted service type
    
    Parameters:
    
    adaptee - the adapted service
    
    consumer - the lambda that will use the AdapterBuilder for building the DM adapter component.
    
    Returns:
    
    a newly built DM component.
  - factoryPidAdapter
```
protected Component factoryPidAdapter(java.util.function.Consumer<FactoryPidAdapterBuilder> consumer)
```
    Builds a DM Factory Configuration Adapter Component using a Java8 style FactoryPidAdapterBuilder. The component is auto-added to the DependencyManager, unless the lambda calls the FactoryPidAdapterBuilder.autoAdd(false) method.
    
    Parameters:
    
    consumer - the lambda that will use the FactoryPidAdapterBuilder for building the DM factory configuration adapter component.
    
    Returns:
    
    a newly built DM component.
  - bundleAdapter
```
protected Component bundleAdapter(java.util.function.Consumer<BundleAdapterBuilder> consumer)
```
    Builds a DM Bundle Adapter Component.
    
    Parameters:
    
    consumer - the lambda used to build the actual bundle adapter. The component is auto-added to the DependencyManager, unless the lambda calls the BundleAdapter.autoAdd(false) method.
    
    Returns:
    
    a newly built DM component.
  - component
```
public static ComponentBuilder<?> component(DependencyManager dm)
```
    Creates a Component builder that can be used to create a Component.
    
    Parameters:
    
    dm - the DependencyManager object used to create the component builder
    
    Returns:
    
    a Component builder that can be used to create a Component.
  - aspect
```
public static <T> ServiceAspectBuilder<T> aspect(DependencyManager dm,
                                                 java.lang.Class<T> aspect)
```
    Creates a service Aspect builder that can be used to create an Aspect Component.
    
    Type Parameters:
    
    T - the aspect service type
    
    Parameters:
    
    dm - the DependencyManager object used to register the built component
    
    aspect - the type of the aspect service
    
    Returns:
    
    a service Aspect builder that can be used to create an Aspect Component.
  - adapter
```
public static <T> ServiceAdapterBuilder<T> adapter(DependencyManager dm,
                                                   java.lang.Class<T> adaptee)
```
    Creates a service Adapter builder that can be used to create an Adapter Component.
    
    Type Parameters:
    
    T - the adapted service type
    
    Parameters:
    
    dm - the DependencyManager object used to register the built component
    
    adaptee - the type of the adaptee service
    
    Returns:
    
    a service Adapter builder that can be used to create an Adapter Component.
  - factoryPidAdapter
```
public static FactoryPidAdapterBuilder factoryPidAdapter(DependencyManager dm)
```
    Creates a factory pid adapter that can be used to create a factory adapter Component.
    
    Parameters:
    
    dm - the DependencyManager object used to register the built component
    
    Returns:
    
    a factory pid adapter that can be used to create a factory adapter Component.
  - bundleAdapter
```
public static BundleAdapterBuilder bundleAdapter(DependencyManager dm)
```
    Creates a bundle adapter builder that can be used to create a DM bundle adapter Component.
    
    Parameters:
    
    dm - the DependencyManager object used to create the bundle adapter builder.
    
    Returns:
    
    a bundle adapter builder that can be used to create a DM bundle adapter Component.
  - serviceDependency
```
public static <T> ServiceDependencyBuilder<T> serviceDependency(Component component,
                                                                java.lang.Class<T> service)
```
    Creates a DM ServiceDependency builder.
    
    Type Parameters:
    
    T - the service dependency type
    
    Parameters:
    
    component - the component on which you want to build a new service dependency using the returned builder
    
    service - the service dependency type.
    
    Returns:
    
    a DM ServiceDependency builder.
  - confDependency
```
public static ConfigurationDependencyBuilder confDependency(Component component)
```
    Creates a DM Configuration Dependency builder.
    
    Parameters:
    
    component - the component on which you want to build a new configuration dependency using the returned builder
    
    Returns:
    
    a DM Configuration Dependency builder.
  - bundleDependency
```
public static BundleDependencyBuilder bundleDependency(Component component)
```
    Creates a DM Bundle Dependency builder.
    
    Parameters:
    
    component - the component on which you want to build a new bundle dependency using the returned builder
    
    Returns:
    
    a DM Configuration Dependency builder.
  - futureDependency
```
public static <F> FutureDependencyBuilder<F> futureDependency(Component component,
                                                              java.util.concurrent.CompletableFuture<F> future)
```
    Creates a DM CompletableFuture Dependency builder.
    
    Type Parameters:
    
    F - the type of the CompletableFuture result.
    
    Parameters:
    
    component - the component on which you want to build a new completable future dependency using the returned builder.
    
    future - the future the dependency built using the returned builder will depend on.
    
    Returns:
    
    a CompletableFuture dependency builder.
  - component
```
public static Component component(DependencyManager dm,
                                  java.util.function.Consumer<ComponentBuilder<?>> consumer)
```
    Builds a component using a lambda and a component builder
    
    Parameters:
    
    dm - the DependencyManager where the component is auto-added (unless the component.autoAdd(false) is called)
    
    consumer - a lambda that is called to build the component. When the lambda is called, it will be provided with a ComponentBuilder object that is used to build the actual DM component.
    
    Returns:
    
    the built DM component.
  - component
```
public static void component(Component comp,
                             java.util.function.Consumer<ComponentBuilder<?>> consumer)
```
    Update an existing component. Typically, this method can be used from a Component.init method, where more dependencies has to be added.
    
    Parameters:
    
    comp - an existing DM component
    
    consumer - the lambda that will be used to update the component
  - aspect
```
public static <T> Component aspect(DependencyManager dm,
                                   java.lang.Class<T> aspect,
                                   java.util.function.Consumer<ServiceAspectBuilder<T>> consumer)
```
    Builds an aspect DM Component.
    
    Type Parameters:
    
    T - the aspect service type
    
    Parameters:
    
    dm - the DependencyManager object used to register the built component
    
    aspect - the type of the aspect service
    
    consumer - a lambda used to build the DM aspect component
    
    Returns:
    
    a new DM aspect component. The aspect component is auto-added into the dm object, unless the lambda calls the AspectBuilder.autoAdd(false) method.
  - adapter
```
public static <T> Component adapter(DependencyManager dm,
                                    java.lang.Class<T> adaptee,
                                    java.util.function.Consumer<ServiceAdapterBuilder<T>> consumer)
```
    Builds an adapter DM Component.
    
    Type Parameters:
    
    T - the adapted service type
    
    Parameters:
    
    dm - the DependencyManager object used to register the built component
    
    adaptee - the type of the adapted service
    
    consumer - a lambda used to build the DM adapter component
    
    Returns:
    
    a new DM adapter component. The adapter component is auto-added into the dm object, unless the lambda calls the AspectBuilder.autoAdd(false) method is called.
  - bundleAdapter
```
public static Component bundleAdapter(DependencyManager dm,
                                      java.util.function.Consumer<BundleAdapterBuilder> consumer)
```
    Builds a bundle adapter DM Component.
    
    Parameters:
    
    dm - the DependencyManager object used to register the built component
    
    consumer - a lambda used to build the bundle adapter component
    
    Returns:
    
    a new bundle adapter component. The adapter component is auto-added into the dm object, unless the lambda calls the AspectBuilder.autoAdd(false) method is called.
  - factoryPidAdapter
```
public static Component factoryPidAdapter(DependencyManager dm,
                                          java.util.function.Consumer<FactoryPidAdapterBuilder> consumer)
```
    Builds a DM factory configuration adapter.
    
    Parameters:
    
    dm - the DependencyManager object used to create DM components.
    
    consumer - a lambda used to build the DM factory configuration adapter component
    
    Returns:
    
    a new DM factory configuration adapter component. The adapter component is auto-added into the dm object, unless the lambda calls the FactoryPidAdapterBuilder.autoAdd(false) method is called

Class DependencyManagerActivator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DependencyManagerActivator

Method Detail

start

stop

init

destroy

getDM

getBC

component

aspect

adapter

component

aspect

adapter

factoryPidAdapter

bundleAdapter

component

aspect

adapter

factoryPidAdapter

bundleAdapter

serviceDependency

confDependency

bundleDependency

futureDependency

component

component

aspect

adapter

bundleAdapter

factoryPidAdapter