Class SingleComponentManager<S>

java.lang.Object

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

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

All Implemented Interfaces:

ComponentManager<S>, org.osgi.framework.ServiceFactory<S>

Direct Known Subclasses:

ServiceFactoryComponentManager

public class SingleComponentManager<S>
extends AbstractComponentManager<S>
implements org.osgi.framework.ServiceFactory<S>

The default ComponentManager. Objects of this class are responsible for managing implementation object's lifecycle.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	SingleComponentManager.SetImplementationObject<S>	The SetImplementationObject interface provides an API for component managers to setup the implementation object and potentially other parts as part of the createImplementationObject(Bundle, SingleComponentManager.SetImplementationObject, ComponentContextImpl) method processing.

Nested classes/interfaces inherited from class AbstractComponentManager

AbstractComponentManager.State

Field Summary

Fields

Modifier and Type	Field	Description
private ComponentContextImpl<S>	m_componentContext
private Map<String,Object>	m_configurationProperties
private Map<String,Object>	m_factoryProperties
private Map<String,Object>	m_properties
private Dictionary<String,Object>	m_serviceProperties
private final AtomicInteger	m_useCount

Fields inherited from class AbstractComponentManager

m_activationLock, m_container, m_factoryInstance, REASONS, registrationManager

Fields inherited from interface ComponentManager

STATE_ACTIVE, STATE_DISPOSED, STATE_SATISFIED, STATE_UNSATISFIED_CONFIGURATION, STATE_UNSATISFIED_REFERENCE

Constructor Summary

Constructors

Constructor	Description
SingleComponentManager(ComponentContainer<S> container, ComponentMethods<S> componentMethods)	The constructor receives both the activator and the metadata
SingleComponentManager(ComponentContainer<S> container, ComponentMethods<S> componentMethods, boolean factoryInstance)

Method Summary

Modifier and Type	Method	Description
(package private) void	clear()
(package private) void	clearServiceProperties()
private boolean	createComponent(ComponentContextImpl<S> componentContext)
protected S	createImplementationObject(org.osgi.framework.Bundle usingBundle, SingleComponentManager.SetImplementationObject<S> setter, ComponentContextImpl<S> componentContext)
protected void	deleteComponent(int reason)
protected void	disposeImplementationObject(ComponentContextImpl<S> componentContext, int reason)
org.osgi.service.component.ComponentInstance<S>	getComponentInstance()
void	getComponentManagers(List<AbstractComponentManager<S>> cms)
private S	getInstance()	Get the object that is implementing this descriptor
Map<String,Object>	getProperties()	Returns the (private copy) of the Component properties to be used for the ComponentContext as well as eventual service registration.
private S	getService(ComponentContextImpl<S> componentContext)
S	getService(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceRegistration<S> serviceRegistration)
(package private) boolean	getServiceInternal(org.osgi.framework.ServiceRegistration<S> serviceRegistration)
Dictionary<String,Object>	getServiceProperties()	Returns the subset of component properties to be used as service properties.
(package private) final org.osgi.framework.ServiceReference<S>	getServiceReference()
protected org.osgi.framework.ServiceRegistration<S>	getServiceRegistration()
(package private) <T> void	invokeBindMethod(DependencyManager<S,T> dependencyManager, RefPair<S,T> refPair, int trackingCount)
protected MethodResult	invokeModifiedMethod()
(package private) <T> void	invokeUnbindMethod(DependencyManager<S,T> dependencyManager, RefPair<S,T> oldRefPair, int trackingCount)
(package private) <T> boolean	invokeUpdatedMethod(DependencyManager<S,T> dependencyManager, RefPair<S,T> refPair, int trackingCount)	Invoke updated method
private boolean	keepInstances()
private boolean	modify(boolean configurationDeleted)
(package private) void	postRegister()
(package private) void	preDeregister()
(package private) void	reconfigure(boolean configurationDeleted)
void	reconfigure(Map<String,Object> configuration, boolean configurationDeleted, TargetedPID factoryPid)	Called by the Configuration Admin Service to update the component with Configuration properties.
(package private) void	registerComponentId()
private boolean	servicePropertiesMatches(org.osgi.framework.ServiceRegistration<S> reg, Dictionary<String,Object> props)	Checks if the given service registration properties matches another set of properties.
protected void	setFactoryProperties(Dictionary<String,?> dictionary)
void	setServiceProperties(Dictionary<String,?> serviceProperties)
void	ungetService(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceRegistration<S> serviceRegistration, S o)
(package private) void	unregisterComponentId()
private void	updateServiceRegistration()

Methods inherited from class AbstractComponentManager

activateInternal, collectDependencies, copyTo, copyToDictionary, copyToMap, deactivateInternal, disable, disableInternal, dispose, dispose, dumpThreads, enable, enableInternal, enableLatchWait, getActivator, getBundle, getBundleContext, getComponentMetadata, getComponentMethods, getDependencyManager, getDependencyManagers, getFailureReason, getId, getLockTimeout, getLogger, getProvidedServices, getReferenceManagers, getRegisteredServiceReference, getReversedDependencyManagers, getSpecState, getState, getTrackingCount, isFactory, isImmediate, isStateLocked, notifyWaiters, obtainActivationReadLock, obtainActivationWriteLock, obtainStateLock, registerMissingDependency, registerService, releaseActivationReadLock, releaseActivationWriteeLock, releaseStateLock, setFailureReason, setServiceProperties, setState, toString, tracked, unregisterService, updateTargets, verifyDependencyManagers, waitForTracked

Methods inherited from class Object

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

Field Details

m_useCount

private final AtomicInteger m_useCount

m_componentContext

private volatile ComponentContextImpl<S> m_componentContext

m_configurationProperties

private Map<String,Object> m_configurationProperties

m_factoryProperties

private Map<String,Object> m_factoryProperties

m_properties

private Map<String,Object> m_properties

m_serviceProperties

private Dictionary<String,Object> m_serviceProperties

Constructor Details

SingleComponentManager

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

The constructor receives both the activator and the metadata

Parameters:

componentMethods -

SingleComponentManager

public SingleComponentManager(ComponentContainer<S> container,
 ComponentMethods<S> componentMethods,
 boolean factoryInstance)

Method Details

clear

void clear()

Overrides:

clear in class AbstractComponentManager<S>

createComponent

private boolean createComponent(ComponentContextImpl<S> componentContext)

deleteComponent

protected void deleteComponent(int reason)

Specified by:

deleteComponent in class AbstractComponentManager<S>

clearServiceProperties

void clearServiceProperties()

getComponentInstance

public org.osgi.service.component.ComponentInstance<S> getComponentInstance()

getInstance

private S getInstance()

Get the object that is implementing this descriptor

Returns:

the object that implements the services

createImplementationObject

protected S createImplementationObject(org.osgi.framework.Bundle usingBundle,
 SingleComponentManager.SetImplementationObject<S> setter,
 ComponentContextImpl<S> componentContext)

disposeImplementationObject

protected void disposeImplementationObject(ComponentContextImpl<S> componentContext,
 int reason)

invokeBindMethod

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

Specified by:

invokeBindMethod in class AbstractComponentManager<S>

invokeUpdatedMethod

<T> boolean invokeUpdatedMethod(DependencyManager<S,T> dependencyManager,
 RefPair<S,T> refPair,
 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.

invokeUnbindMethod

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

Specified by:

invokeUnbindMethod in class AbstractComponentManager<S>

setFactoryProperties

protected void setFactoryProperties(Dictionary<String,?> dictionary)

registerComponentId

void registerComponentId()

Overrides:

registerComponentId in class AbstractComponentManager<S>

unregisterComponentId

void unregisterComponentId()

Overrides:

unregisterComponentId in class AbstractComponentManager<S>

getProperties

public Map<String,Object> getProperties()

Returns the (private copy) of the Component properties to be used for the ComponentContext as well as eventual service registration.

Method implements the Component Properties provisioning as described in 112.6, Component Properties.

Specified by:

getProperties in interface ComponentManager<S>

Specified by:

getProperties in class AbstractComponentManager<S>

Returns:

a private map of component properties

setServiceProperties

public void setServiceProperties(Dictionary<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 Dictionary<String,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>

getServiceReference

final org.osgi.framework.ServiceReference<S> getServiceReference()

getServiceRegistration

protected org.osgi.framework.ServiceRegistration<S> getServiceRegistration()

Overrides:

getServiceRegistration in class AbstractComponentManager<S>

updateServiceRegistration

private void updateServiceRegistration()

reconfigure

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

Called by the Configuration Admin Service to update the component with Configuration properties.

This causes the component to be reactivated with the new configuration unless no configuration has ever been set on this component and the configuration parameter is null. In this case nothing is to be done. If a configuration has previously been set and now the configuration is deleted, the configuration parameter is null and the component has to be reactivated with the default configuration.

Specified by:

reconfigure in class AbstractComponentManager<S>

Parameters:

configuration - The configuration properties for the component from the Configuration Admin Service or null if there is no configuration or if the configuration has just been deleted.

configurationDeleted - TODO

factoryPid - TODO

reconfigure

void reconfigure(boolean configurationDeleted)

modify

private boolean modify(boolean configurationDeleted)

invokeModifiedMethod

protected MethodResult invokeModifiedMethod()

servicePropertiesMatches

private boolean servicePropertiesMatches(org.osgi.framework.ServiceRegistration<S> reg,
 Dictionary<String,Object> props)

Checks if the given service registration properties matches another set of properties.

Parameters:

reg - the service registration whose service properties will be compared to the props parameter

props - the properties to be compared with the registration service properties.

Returns:

true if the registration service properties equals the prop properties, false if not.

getService

public S getService(org.osgi.framework.Bundle bundle,
 org.osgi.framework.ServiceRegistration<S> serviceRegistration)

Specified by:

getService in interface org.osgi.framework.ServiceFactory<S>

getServiceInternal

boolean getServiceInternal(org.osgi.framework.ServiceRegistration<S> serviceRegistration)

Overrides:

getServiceInternal in class AbstractComponentManager<S>

getService

private S getService(ComponentContextImpl<S> componentContext)

ungetService

public void ungetService(org.osgi.framework.Bundle bundle,
 org.osgi.framework.ServiceRegistration<S> serviceRegistration,
 S o)

Specified by:

ungetService in interface org.osgi.framework.ServiceFactory<S>

keepInstances

private boolean keepInstances()

getComponentManagers

public void getComponentManagers(List<AbstractComponentManager<S>> cms)

Specified by:

getComponentManagers in class AbstractComponentManager<S>