org.apache.felix.scr.impl

Class BundleComponentActivator

java.lang.Object

org.apache.felix.scr.impl.BundleComponentActivator

All Implemented Interfaces:

Logger, ComponentActivator, ExtendedServiceListenerContext<ExtendedServiceEvent>

public class BundleComponentActivator
extends java.lang.Object
implements ComponentActivator

The BundleComponentActivator is helper class to load and unload Components of a single bundle. It will read information from the metadata.xml file descriptors and create the corresponding managers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	BundleComponentActivator.ListenerInfo

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigAdminTracker	configAdminTracker
private java.util.Map<java.lang.String,BundleComponentActivator.ListenerInfo>	listenerMap
private java.util.concurrent.atomic.AtomicBoolean	m_active
private org.osgi.framework.Bundle	m_bundle
private java.util.concurrent.CountDownLatch	m_closeLatch
private ComponentActorThread	m_componentActor
private ComponentRegistry	m_componentRegistry
private ScrConfiguration	m_configuration
private org.osgi.framework.BundleContext	m_context
private java.util.List<ComponentHolder<?>>	m_holders
private SimpleLogger	m_logger
private org.osgi.util.tracker.ServiceTracker<org.osgi.service.log.LogService,org.osgi.service.log.LogService>	m_logService

Constructor Summary

Constructors

Constructor and Description
BundleComponentActivator(SimpleLogger logger, ComponentRegistry componentRegistry, ComponentActorThread componentActor, org.osgi.framework.BundleContext context, ScrConfiguration configuration) Called upon starting of the bundle.

Method Summary

Modifier and Type	Method and Description
void	addServiceListener(java.lang.String classNameFilter, org.osgi.framework.Filter eventFilter, ExtendedServiceListener<ExtendedServiceEvent> listener)
void	disableComponent(java.lang.String name) Implements the ComponentContext.disableComponent(String) method by first finding the component(s) for the name and disabling them.
(package private) void	dispose(int reason) Dispose of this component activator instance and all the component managers.
void	enableComponent(java.lang.String name) Implements the ComponentContext.enableComponent(String) method by first finding the component(s) for the name and enabling them.
<T> boolean	enterCreate(org.osgi.framework.ServiceReference<T> serviceReference)
(package private) static java.net.URL[]	findDescriptors(org.osgi.framework.Bundle bundle, java.lang.String descriptorLocation) Finds component descriptors based on descriptor location.
org.osgi.framework.BundleContext	getBundleContext() Returns the BundleContext
ScrConfiguration	getConfiguration()
private java.util.List<ComponentHolder<?>>	getSelectedComponents(java.lang.String name) Returns an array of ComponentHolder instances which match the name.
(package private) void	initialEnable() Called outside the constructor so that the m_managers field is completely initialized.
protected void	initialize(java.lang.String descriptorLocations) Gets the MetaData location, parses the meta data and requests the processing of binder instances
boolean	isActive() Returns if this instance is active, that is if components may be activated for this component.
boolean	isLogEnabled(int level) Returns true if logging for the given level is enabled.
<T> void	leaveCreate(org.osgi.framework.ServiceReference<T> serviceReference)
private void	loadDescriptor(java.net.URL descriptorURL)
void	log(int level, java.lang.String message, ComponentMetadata metadata, java.lang.Long componentId, java.lang.Throwable ex) Method to actually emit the log message.
void	log(int level, java.lang.String pattern, java.lang.Object[] arguments, ComponentMetadata metadata, java.lang.Long componentId, java.lang.Throwable ex) Method to actually emit the log message.
<T> void	missingServicePresent(org.osgi.framework.ServiceReference<T> serviceReference)
long	registerComponentId(AbstractComponentManager<?> componentManager)
<S,T> void	registerMissingDependency(DependencyManager<S,T> dependencyManager, org.osgi.framework.ServiceReference<T> serviceReference, int trackingCount)
void	removeServiceListener(java.lang.String className, org.osgi.framework.Filter filter, ExtendedServiceListener<ExtendedServiceEvent> listener)
void	schedule(java.lang.Runnable task) Schedules the given task for asynchrounous execution or synchronously runs the task if the thread is not running.
RegionConfigurationSupport	setRegionConfigurationSupport(org.osgi.framework.ServiceReference<org.osgi.service.cm.ConfigurationAdmin> reference)
void	unregisterComponentId(AbstractComponentManager<?> componentManager)
void	unsetRegionConfigurationSupport(RegionConfigurationSupport rcs)

Methods inherited from class java.lang.Object

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

Field Detail

m_componentRegistry

private final ComponentRegistry m_componentRegistry

m_bundle

private final org.osgi.framework.Bundle m_bundle

m_context

private final org.osgi.framework.BundleContext m_context

m_holders

private final java.util.List<ComponentHolder<?>> m_holders

m_logService

private final org.osgi.util.tracker.ServiceTracker<org.osgi.service.log.LogService,org.osgi.service.log.LogService> m_logService

m_componentActor

private final ComponentActorThread m_componentActor

m_active

private final java.util.concurrent.atomic.AtomicBoolean m_active

m_closeLatch

private final java.util.concurrent.CountDownLatch m_closeLatch

m_configuration

private final ScrConfiguration m_configuration

configAdminTracker

private final ConfigAdminTracker configAdminTracker

listenerMap

private final java.util.Map<java.lang.String,BundleComponentActivator.ListenerInfo> listenerMap

m_logger

private final SimpleLogger m_logger

Constructor Detail

BundleComponentActivator

public BundleComponentActivator(SimpleLogger logger,
                                ComponentRegistry componentRegistry,
                                ComponentActorThread componentActor,
                                org.osgi.framework.BundleContext context,
                                ScrConfiguration configuration)
                         throws org.osgi.service.component.ComponentException

Called upon starting of the bundle. This method invokes initialize() which parses the metadata and creates the holders

Parameters:

componentRegistry - The ComponentRegistry used to register components with to ensure uniqueness of component names and to ensure configuration updates.

context - The bundle context owning the components

Throws:

org.osgi.service.component.ComponentException - if any error occurrs initializing this class

Method Detail

addServiceListener

public void addServiceListener(java.lang.String classNameFilter,
                               org.osgi.framework.Filter eventFilter,
                               ExtendedServiceListener<ExtendedServiceEvent> listener)

Specified by:

addServiceListener in interface ExtendedServiceListenerContext<ExtendedServiceEvent>

removeServiceListener

public void removeServiceListener(java.lang.String className,
                                  org.osgi.framework.Filter filter,
                                  ExtendedServiceListener<ExtendedServiceEvent> listener)

Specified by:

removeServiceListener in interface ExtendedServiceListenerContext<ExtendedServiceEvent>

initialize

protected void initialize(java.lang.String descriptorLocations)

Gets the MetaData location, parses the meta data and requests the processing of binder instances

Parameters:

descriptorLocations - A comma separated list of locations of component descriptors. This must not be null.

Throws:

java.lang.IllegalStateException - If the bundle has already been uninstalled.

initialEnable

void initialEnable()

Called outside the constructor so that the m_managers field is completely initialized. A component might possibly start a thread to enable other components, which could access m_managers

findDescriptors

static java.net.URL[] findDescriptors(org.osgi.framework.Bundle bundle,
                                      java.lang.String descriptorLocation)

Finds component descriptors based on descriptor location.

Parameters:

bundle - bundle to search for descriptor files

descriptorLocation - descriptor location

Returns:

array of descriptors or empty array if none found

loadDescriptor

private void loadDescriptor(java.net.URL descriptorURL)

dispose

void dispose(int reason)

Dispose of this component activator instance and all the component managers.

isActive

public boolean isActive()

Returns if this instance is active, that is if components may be activated for this component. The active flag is set early in the constructor indicating the activator is basically active (not fully setup, though) and reset early in the process of disposing this instance.

Specified by:

isActive in interface ComponentActivator

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()

Returns the BundleContext

Specified by:

getBundleContext in interface ComponentActivator

Returns:

the BundleContext

getConfiguration

public ScrConfiguration getConfiguration()

Specified by:

getConfiguration in interface ComponentActivator

enableComponent

public void enableComponent(java.lang.String name)

Implements the ComponentContext.enableComponent(String) method by first finding the component(s) for the name and enabling them. The enable method will schedule activation.

Specified by:

enableComponent in interface ComponentActivator

Parameters:

name - The name of the component to enable or null to enable all components.

disableComponent

public void disableComponent(java.lang.String name)

Implements the ComponentContext.disableComponent(String) method by first finding the component(s) for the name and disabling them. The disable method will schedule deactivation

Specified by:

disableComponent in interface ComponentActivator

Parameters:

name - The name of the component to disable or null to disable all components.

getSelectedComponents

private java.util.List<ComponentHolder<?>> getSelectedComponents(java.lang.String name)

Returns an array of ComponentHolder instances which match the name. If the name is null an array of all currently known component managers is returned. Otherwise an array containing a single component manager matching the name is returned if one is registered. Finally, if no component manager with the given name is registered, null is returned.

Parameters:

name - The name of the component manager to return or null to return an array of all component managers.

Returns:

An array containing one or more component managers according to the name parameter or null if no component manager with the given name is currently registered.

registerComponentId

public long registerComponentId(AbstractComponentManager<?> componentManager)

Specified by:

registerComponentId in interface ComponentActivator

unregisterComponentId

public void unregisterComponentId(AbstractComponentManager<?> componentManager)

Specified by:

unregisterComponentId in interface ComponentActivator

schedule

public void schedule(java.lang.Runnable task)

Schedules the given task for asynchrounous execution or synchronously runs the task if the thread is not running. If this instance is not active, the task is not executed.

Specified by:

schedule in interface ComponentActivator

Parameters:

task - The component task to execute

isLogEnabled

public boolean isLogEnabled(int level)

Returns true if logging for the given level is enabled.

Specified by:

isLogEnabled in interface Logger

log

public void log(int level,
                java.lang.String pattern,
                java.lang.Object[] arguments,
                ComponentMetadata metadata,
                java.lang.Long componentId,
                java.lang.Throwable ex)

Method to actually emit the log message. If the LogService is available, the message will be logged through the LogService. Otherwise the message is logged to stdout (or stderr in case of LOG_ERROR level messages),

Specified by:

log in interface Logger

Parameters:

level - The log level to log the message at

pattern - The java.text.MessageFormat message format string for preparing the message

arguments - The format arguments for the pattern string.

componentId -

ex - An optional Throwable whose stack trace is written,

metadata - component metadata if known

log

public void log(int level,
                java.lang.String message,
                ComponentMetadata metadata,
                java.lang.Long componentId,
                java.lang.Throwable ex)

Method to actually emit the log message. If the LogService is available, the message will be logged through the LogService. Otherwise the message is logged to stdout (or stderr in case of LOG_ERROR level messages),

Specified by:

log in interface Logger

Parameters:

level - The log level to log the message at

message - The message to log

componentId -

ex - An optional Throwable whose stack trace is written,

metadata - The ComponentMetadata whose processing caused the message. This may be null if the component metadata is not known or applicable.

enterCreate

public <T> boolean enterCreate(org.osgi.framework.ServiceReference<T> serviceReference)

Specified by:

enterCreate in interface ComponentActivator

leaveCreate

public <T> void leaveCreate(org.osgi.framework.ServiceReference<T> serviceReference)

Specified by:

leaveCreate in interface ComponentActivator

missingServicePresent

public <T> void missingServicePresent(org.osgi.framework.ServiceReference<T> serviceReference)

Specified by:

missingServicePresent in interface ComponentActivator

registerMissingDependency

public <S,T> void registerMissingDependency(DependencyManager<S,T> dependencyManager,
                                            org.osgi.framework.ServiceReference<T> serviceReference,
                                            int trackingCount)

Specified by:

registerMissingDependency in interface ComponentActivator

setRegionConfigurationSupport

public RegionConfigurationSupport setRegionConfigurationSupport(org.osgi.framework.ServiceReference<org.osgi.service.cm.ConfigurationAdmin> reference)

Specified by:

setRegionConfigurationSupport in interface ComponentActivator

unsetRegionConfigurationSupport

public void unsetRegionConfigurationSupport(RegionConfigurationSupport rcs)

Specified by:

unsetRegionConfigurationSupport in interface ComponentActivator