org.opendaylight.controller.blueprint.ext

Class DataStoreAppConfigMetadata

java.lang.Object

org.opendaylight.controller.blueprint.ext.DataStoreAppConfigMetadata

All Implemented Interfaces:

org.apache.aries.blueprint.ext.ComponentFactoryMetadata, org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata, org.osgi.service.blueprint.reflect.ComponentMetadata, org.osgi.service.blueprint.reflect.Metadata, org.osgi.service.blueprint.reflect.NonNullMetadata, org.osgi.service.blueprint.reflect.Target

public class DataStoreAppConfigMetadata
extends Object

Factory metadata corresponding to the "clustered-app-config" element that obtains an application's config data from the data store and provides the binding DataObject instance to the Blueprint container as a bean. In addition registers a DataTreeChangeListener to restart the Blueprint container when the config data is changed.

Author:

Thomas Pantelis

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata

org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata.SatisfactionCallback

Field Summary

Fields inherited from interface org.osgi.service.blueprint.reflect.ComponentMetadata

ACTIVATION_EAGER, ACTIVATION_LAZY

Constructor Summary

Constructors

Constructor and Description
DataStoreAppConfigMetadata(String id, String appConfigBindingClassName, String appConfigListKeyValue, String defaultAppConfigFileName, UpdateStrategy updateStrategyValue, Element defaultAppConfigElement)

Method Summary

Modifier and Type	Method and Description
protected org.apache.aries.blueprint.services.ExtendedBlueprintContainer	container()
Object	create()
void	destroy(Object instance)
int	getActivation()
String	getDependencyDescriptor()
List<String>	getDependsOn()
String	getId()
protected <T> T	getOSGiService(Class<T> serviceInterface)
void	init(org.apache.aries.blueprint.services.ExtendedBlueprintContainer container)
boolean	isSatisfied()
protected String	logName()
protected void	onCreate()
protected void	restartContainer()
protected void	retrieveService(String name, Class<?> interfaceClass, Consumer<Object> onServiceRetrieved)
protected void	retrieveService(String name, String interfaceName, Consumer<Object> onServiceRetrieved)
protected void	setDependencyDesc(String dependencyDesc)
protected void	setFailure(String failureMessage, Throwable failureCause)
protected void	setFailureMessage(String failureMessage)
protected void	setSatisfied()
protected void	startTracking()
void	startTracking(org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata.SatisfactionCallback newSatisfactionCallback)
void	stopTracking()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataStoreAppConfigMetadata

public DataStoreAppConfigMetadata(@Nonnull
                                  String id,
                                  @Nonnull
                                  String appConfigBindingClassName,
                                  @Nullable
                                  String appConfigListKeyValue,
                                  @Nullable
                                  String defaultAppConfigFileName,
                                  @Nonnull
                                  UpdateStrategy updateStrategyValue,
                                  @Nullable
                                  Element defaultAppConfigElement)

Method Detail

init

public void init(org.apache.aries.blueprint.services.ExtendedBlueprintContainer container)

Specified by:

init in interface org.apache.aries.blueprint.ext.ComponentFactoryMetadata

create

public Object create()
              throws org.osgi.service.blueprint.container.ComponentDefinitionException

Throws:

org.osgi.service.blueprint.container.ComponentDefinitionException

startTracking

protected void startTracking()

destroy

public void destroy(Object instance)

Specified by:

destroy in interface org.apache.aries.blueprint.ext.ComponentFactoryMetadata

getId

public String getId()

Specified by:

getId in interface org.osgi.service.blueprint.reflect.ComponentMetadata

getActivation

public int getActivation()

Specified by:

getActivation in interface org.osgi.service.blueprint.reflect.ComponentMetadata

getDependsOn

public List<String> getDependsOn()

Specified by:

getDependsOn in interface org.osgi.service.blueprint.reflect.ComponentMetadata

getDependencyDescriptor

public String getDependencyDescriptor()

Specified by:

getDependencyDescriptor in interface org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata

isSatisfied

public boolean isSatisfied()

Specified by:

isSatisfied in interface org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata

setFailureMessage

protected void setFailureMessage(String failureMessage)

setFailure

protected void setFailure(String failureMessage,
                          Throwable failureCause)

setDependencyDesc

protected void setDependencyDesc(String dependencyDesc)

container

protected final org.apache.aries.blueprint.services.ExtendedBlueprintContainer container()

setSatisfied

protected void setSatisfied()

retrieveService

protected void retrieveService(String name,
                               Class<?> interfaceClass,
                               Consumer<Object> onServiceRetrieved)

retrieveService

protected void retrieveService(String name,
                               String interfaceName,
                               Consumer<Object> onServiceRetrieved)

logName

protected final String logName()

onCreate

protected void onCreate()
                 throws org.osgi.service.blueprint.container.ComponentDefinitionException

Throws:

org.osgi.service.blueprint.container.ComponentDefinitionException

startTracking

public final void startTracking(org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata.SatisfactionCallback newSatisfactionCallback)

Specified by:

startTracking in interface org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata

stopTracking

public void stopTracking()

Specified by:

stopTracking in interface org.apache.aries.blueprint.ext.DependentComponentFactoryMetadata

restartContainer

protected void restartContainer()

getOSGiService

@Nullable
protected <T> T getOSGiService(Class<T> serviceInterface)