org.apache.felix.scr.impl.manager

Class ComponentFactoryImpl<S>

java.lang.Object

org.apache.felix.scr.impl.manager.AbstractComponentManager<S>

org.apache.felix.scr.impl.manager.ComponentFactoryImpl<S>

All Implemented Interfaces:

SimpleLogger, ComponentContainer<S>, ComponentManager<S>, org.osgi.service.component.ComponentFactory

public class ComponentFactoryImpl<S>
extends AbstractComponentManager<S>
implements org.osgi.service.component.ComponentFactory, ComponentContainer<S>

The ComponentFactoryImpl extends the AbstractComponentManager class to implement the component factory functionality. As such the OSGi Declarative Services ComponentFactory interface is implemented.

In addition the ComponentHolder interface is implemented to use this class directly as the holder for component instances created by the newInstance(Dictionary) method.

This class implements spec-compliant component factories and the felix "persistent" component factory, where the factory is always registered whether or not all dependencies are present and the created components also persist whether or not the dependencies are present to allow the component instance to exist.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ComponentFactoryImpl.ModifyComponentInstance<S>

Nested classes/interfaces inherited from class org.apache.felix.scr.impl.manager.AbstractComponentManager

AbstractComponentManager.State

Field Summary

Fields

Modifier and Type	Field and Description
protected long	m_changeCount Configuration change count (R5) or imitation (R4)
private java.util.Map<SingleComponentManager<S>,SingleComponentManager<S>>	m_componentInstances Contains the component instances created by calling the newInstance(Dictionary) method.
private java.util.Map<java.lang.String,java.lang.Object>	m_configuration The configuration for the component factory.
private boolean	m_hasConfiguration Flag telling if our component factory is currently configured from config admin.
protected TargetedPID	m_targetedPID

Fields inherited from class org.apache.felix.scr.impl.manager.AbstractComponentManager

m_activationLock, m_container, m_factoryInstance, REASONS

Fields inherited from interface org.apache.felix.scr.impl.manager.ComponentManager

STATE_ACTIVE, STATE_DISABLED, STATE_DISPOSED, STATE_SATISFIED, STATE_UNSATISFIED_CONFIGURATION, STATE_UNSATISFIED_REFERENCE

Constructor Summary

Constructors

Constructor and Description
ComponentFactoryImpl(ComponentContainer<S> container, ComponentMethods componentMethods)

Method Summary

Modifier and Type	Method and Description
protected boolean	collectDependencies(ComponentContextImpl<S> componentContext) Collect and store in m_dependencies_map all the services for dependencies, outside of any locks.
private SingleComponentManager<S>	createComponentManager() Creates an SingleComponentManager instance with the BundleComponentActivator and ComponentMetadata of this instance.
protected void	deleteComponent(int reason) The component factory does not have a component to delete.
void	dispose(int reason) Disposes off all components ever created by this component holder.
void	disposed(SingleComponentManager<S> component) Informs the holder that the component has been disposed as a result of calling the dispose method.
boolean	equals(java.lang.Object object) Compares this ComponentFactoryImpl object to another object.
org.osgi.service.component.ComponentInstance	getComponentInstance()
void	getComponentManagers(java.util.List<AbstractComponentManager<S>> cms)
protected void	getComponentManagers(java.util.Map<?,SingleComponentManager<S>> componentMap, java.util.List<AbstractComponentManager<S>> componentManagers)
TargetedPID	getConfigurationTargetedPID(TargetedPID pid, TargetedPID factoryPid)
java.util.Map<java.lang.String,java.lang.Object>	getProperties() For ComponentFactoryImpl, this is used only for updating targets on the dependency managers, so we don't need any other properties.
protected java.lang.String[]	getProvidedServices()
java.util.Dictionary<java.lang.String,java.lang.Object>	getServiceProperties() Returns the subset of component properties to be used as service properties.
boolean	hasConfiguration()
int	hashCode() Returns a hash code value for the object.
(package private) boolean	hasInstance()
(package private) <T> void	invokeBindMethod(DependencyManager<S,T> dependencyManager, RefPair<S,T> reference, int trackingCount)
(package private) <T> void	invokeUnbindMethod(DependencyManager<S,T> dependencyManager, RefPair<S,T> oldRef, int trackingCount)
(package private) <T> boolean	invokeUpdatedMethod(DependencyManager<S,T> dependencyManager, RefPair<S,T> ref, int trackingCount) Invoke updated method
boolean	isFactory()
org.osgi.service.component.ComponentInstance	newInstance(java.util.Dictionary<java.lang.String,?> dictionary)
(package private) void	postRegister()
(package private) void	preDeregister()
void	reconfigure(java.util.Map<java.lang.String,java.lang.Object> configuration, boolean configurationDeleted, TargetedPID factoryPid)
void	setServiceProperties(java.util.Dictionary<java.lang.String,?> serviceProperties)
protected boolean	verifyDependencyManagers()

Methods inherited from class org.apache.felix.scr.impl.manager.AbstractComponentManager

activateInternal, clear, copyTo, copyToDictionary, copyToMap, deactivateInternal, disable, disableInternal, dispose, dumpThreads, enable, enableInternal, enableLatchWait, getActivator, getBundle, getBundleContext, getComponentMetadata, getComponentMethods, getDependencyManager, getDependencyManagers, getId, getLockTimeout, getName, getReferenceManagers, getReversedDependencyManagers, getServiceInternal, getSpecState, getState, getTrackingCount, isActivatorActive, isImmediate, isLogEnabled, isStateLocked, log, log, obtainActivationReadLock, obtainActivationWriteLock, obtainStateLock, registerComponentId, registerMissingDependency, registerService, releaseActivationReadLock, releaseActivationWriteeLock, releaseStateLock, setServiceProperties, setState, toString, tracked, unregisterComponentId, unregisterService, updateTargets, waitForTracked

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.felix.scr.impl.manager.ComponentContainer

getActivator, getComponentMetadata

Field Detail

m_componentInstances

private final java.util.Map<SingleComponentManager<S>,SingleComponentManager<S>> m_componentInstances

Contains the component instances created by calling the newInstance(Dictionary) method. These component instances are provided with updated configuration (or deleted configuration) if such modifications for the component factory takes place.

The map is keyed by the component manager instances. The value of each entry is the same as the entry's key. This is an IdentityHashMap for speed, thus not a Set.

m_configuration

private volatile java.util.Map<java.lang.String,java.lang.Object> m_configuration

The configuration for the component factory. This configuration is supplied as the base configuration for each component instance created by the newInstance(Dictionary) method.

m_hasConfiguration

private volatile boolean m_hasConfiguration

Flag telling if our component factory is currently configured from config admin. We are configured when configuration policy is required and we have received the config admin properties, or when configuration policy is optional or ignored.

m_changeCount

protected volatile long m_changeCount

Configuration change count (R5) or imitation (R4)

m_targetedPID

protected TargetedPID m_targetedPID

Constructor Detail

ComponentFactoryImpl

public ComponentFactoryImpl(ComponentContainer<S> container,
                            ComponentMethods componentMethods)

Method Detail

verifyDependencyManagers

protected boolean verifyDependencyManagers()

Overrides:

verifyDependencyManagers in class AbstractComponentManager<S>

isFactory

public boolean isFactory()

Overrides:

isFactory in class AbstractComponentManager<S>

newInstance

public org.osgi.service.component.ComponentInstance newInstance(java.util.Dictionary<java.lang.String,?> dictionary)

Specified by:

newInstance in interface org.osgi.service.component.ComponentFactory

equals

public boolean equals(java.lang.Object object)

Compares this ComponentFactoryImpl object to another object.

A component factory impl is considered to be equal to another component factory impl if the component names are equal(using String.equals).

Overrides:

equals in class java.lang.Object

Parameters:

object - The ComponentFactoryImpl object to be compared.

Returns:

true if object is a ComponentFactoryImpl and is equal to this object; false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

An integer which is a hash code value for this object.

deleteComponent

protected void deleteComponent(int reason)

The component factory does not have a component to delete.

But in the backwards compatible case any instances created for factory configuration instances are to disabled as a consequence of deactivating the component factory.

Specified by:

deleteComponent in class AbstractComponentManager<S>

getProvidedServices

protected java.lang.String[] getProvidedServices()

Overrides:

getProvidedServices in class AbstractComponentManager<S>

hasConfiguration

public boolean hasConfiguration()

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

For ComponentFactoryImpl, this is used only for updating targets on the dependency managers, so we don't need any other properties.

Specified by:

getProperties in interface ComponentManager<S>

Specified by:

getProperties in class AbstractComponentManager<S>

setServiceProperties

public void setServiceProperties(java.util.Dictionary<java.lang.String,?> serviceProperties)

Specified by:

setServiceProperties in class AbstractComponentManager<S>

postRegister

void postRegister()

Specified by:

postRegister in class AbstractComponentManager<S>

preDeregister

void preDeregister()

Specified by:

preDeregister in class AbstractComponentManager<S>

getServiceProperties

public java.util.Dictionary<java.lang.String,java.lang.Object> getServiceProperties()

Description copied from class: AbstractComponentManager

Returns the subset of component properties to be used as service properties. These properties are all component properties where property name does not start with dot (.), properties which are considered private.

Overrides:

getServiceProperties in class AbstractComponentManager<S>

hasInstance

boolean hasInstance()

Specified by:

hasInstance in class AbstractComponentManager<S>

collectDependencies

protected boolean collectDependencies(ComponentContextImpl<S> componentContext)

Description copied from class: AbstractComponentManager

Collect and store in m_dependencies_map all the services for dependencies, outside of any locks.

Overrides:

collectDependencies in class AbstractComponentManager<S>

Parameters:

componentContext - possible instance key for prototype scope references

Returns:

true if all references can be collected, false if some dependency is no longer available.

invokeUpdatedMethod

<T> boolean invokeUpdatedMethod(DependencyManager<S,T> dependencyManager,
                                RefPair<S,T> ref,
                                int trackingCount)

Description copied from class: AbstractComponentManager

Invoke updated method

Specified by:

invokeUpdatedMethod in class AbstractComponentManager<S>

Returns:

true if the component needs reactivation, false otherwise.

invokeBindMethod

<T> void invokeBindMethod(DependencyManager<S,T> dependencyManager,
                          RefPair<S,T> reference,
                          int trackingCount)

Specified by:

invokeBindMethod in class AbstractComponentManager<S>

invokeUnbindMethod

<T> void invokeUnbindMethod(DependencyManager<S,T> dependencyManager,
                            RefPair<S,T> oldRef,
                            int trackingCount)

Specified by:

invokeUnbindMethod in class AbstractComponentManager<S>

getComponentInstance

public org.osgi.service.component.ComponentInstance getComponentInstance()

dispose

public void dispose(int reason)

Disposes off all components ever created by this component holder. This method is called if either the Declarative Services runtime is stopping or if the owning bundle is stopped. In both cases all components created by this holder must be disposed off.

Overrides:

dispose in class AbstractComponentManager<S>

disposed

public void disposed(SingleComponentManager<S> component)

Description copied from interface: ComponentContainer

Informs the holder that the component has been disposed as a result of calling the dispose method.

Specified by:

disposed in interface ComponentContainer<S>

createComponentManager

private SingleComponentManager<S> createComponentManager()

Creates an SingleComponentManager instance with the BundleComponentActivator and ComponentMetadata of this instance. The component manager is kept in the internal set of created components. The component is neither configured nor enabled.

getComponentManagers

protected void getComponentManagers(java.util.Map<?,SingleComponentManager<S>> componentMap,
                                    java.util.List<AbstractComponentManager<S>> componentManagers)

getConfigurationTargetedPID

public TargetedPID getConfigurationTargetedPID(TargetedPID pid,
                                               TargetedPID factoryPid)

reconfigure

public void reconfigure(java.util.Map<java.lang.String,java.lang.Object> configuration,
                        boolean configurationDeleted,
                        TargetedPID factoryPid)

Specified by:

reconfigure in class AbstractComponentManager<S>

getComponentManagers

public void getComponentManagers(java.util.List<AbstractComponentManager<S>> cms)

Specified by:

getComponentManagers in class AbstractComponentManager<S>