org.eclipse.gemini.blueprint.extender.internal.support

Class ExtenderConfiguration

java.lang.Object

org.eclipse.gemini.blueprint.extender.internal.support.ExtenderConfiguration

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean

Direct Known Subclasses:

BlueprintExtenderConfiguration

public class ExtenderConfiguration
extends java.lang.Object
implements org.springframework.beans.factory.DisposableBean

Configuration class for the extender. Takes care of locating the extender specific configurations and merging the results with the defaults.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ANNOTATION_DEPENDENCY_FACTORY
private static java.lang.String	APPLICATION_EVENT_MULTICASTER_BEAN_NAME
private static java.lang.String	AUTO_ANNOTATION_PROCESSING annotation processing system property (kept for backwards compatibility)
private java.lang.ClassLoader	classLoader bundle wrapped class loader
private static java.lang.String	CONTEXT_CREATOR_NAME
private static java.lang.String	CONTEXT_LISTENER_NAME
private OsgiApplicationContextCreator	contextCreator
private OsgiBundleApplicationContextListener	contextEventListener
private static long	DEFAULT_DEP_WAIT
private static boolean	DEFAULT_NS_BUNDLE_STATE
private static boolean	DEFAULT_PROCESS_ANNOTATION
private static long	DEFAULT_SHUTDOWN_WAIT
private java.util.List<OsgiServiceDependencyFactory>	dependencyFactories List of service dependency factories
private long	dependencyWaitTime
private OsgiBundleApplicationContextEventMulticaster	eventMulticaster
private static java.lang.String	EXTENDER_CFG_LOCATION
private ConfigurableOsgiBundleApplicationContext	extenderConfiguration
private boolean	forceThreadShutdown
private boolean	isMulticasterManagedInternally
private boolean	isShutdownTaskExecutorManagedInternally
private boolean	isTaskExecutorManagedInternally
private java.lang.Object	lock
private org.apache.commons.logging.Log	log logger
private boolean	nsBundledResolved
private java.util.List<OsgiBeanFactoryPostProcessor>	postProcessors List of context post processors
private static java.lang.String	PROCESS_ANNOTATIONS_KEY
private boolean	processAnnotation
private static java.lang.String	PROPERTIES_NAME
private static java.lang.String	SHUTDOWN_TASK_EXECUTOR_NAME
private static java.lang.String	SHUTDOWN_WAIT_KEY
private org.springframework.core.task.TaskExecutor	shutdownTaskExecutor
private long	shutdownWaitTime
private static java.lang.String	TASK_EXECUTOR_NAME
private org.springframework.core.task.TaskExecutor	taskExecutor
private static java.lang.String	WAIT_FOR_DEPS_TIMEOUT_KEY
private static java.lang.String	XML_PATTERN

Constructor Summary

Constructors

Constructor and Description
ExtenderConfiguration(org.osgi.framework.BundleContext bundleContext, org.apache.commons.logging.Log log) Constructs a new ExtenderConfiguration instance.

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultDependencyFactories()
private java.lang.String[]	copyEnumerationToList(java.util.Enumeration<?> enm) Copies the URLs returned by the given enumeration and returns them as an array of Strings for consumption by the application context.
private OsgiApplicationContextCreator	createDefaultApplicationContextCreator()
private OsgiBundleApplicationContextListener	createDefaultApplicationContextListener()
private OsgiBundleApplicationContextEventMulticaster	createDefaultEventMulticaster()
private java.util.Properties	createDefaultProperties()
private org.springframework.core.task.TaskExecutor	createDefaultShutdownTaskExecutor()
private org.springframework.core.task.TaskExecutor	createDefaultTaskExecutor()
void	destroy() Cleanup the configuration items.
java.lang.ClassLoader	getClassLoader() Returns the class loader wrapped around the extender bundle.
OsgiApplicationContextCreator	getContextCreator() Returns the contextCreator.
OsgiBundleApplicationContextListener	getContextEventListener() Returns the contextEventListener.
java.util.List<OsgiServiceDependencyFactory>	getDependencyFactories() Returns the dependencies factories declared by the extender configuration.
long	getDependencyWaitTime() Returns the dependencyWaitTime.
private long	getDependencyWaitTime(java.util.Properties properties)
OsgiBundleApplicationContextEventMulticaster	getEventMulticaster() Returns the eventMulticaster.
java.util.List<OsgiBeanFactoryPostProcessor>	getPostProcessors() Returns the postProcessors.
private boolean	getProcessAnnotations(java.util.Properties properties)
org.springframework.core.task.TaskExecutor	getShutdownTaskExecutor() Returns the shutdown task executor.
long	getShutdownWaitTime() Returns the shutdownWaitTime.
private long	getShutdownWaitTime(java.util.Properties properties)
org.springframework.core.task.TaskExecutor	getTaskExecutor() Returns the taskExecutor.
protected OsgiApplicationContextCreator	postProcess(OsgiApplicationContextCreator contextCreator) Allows post processing of the context creator.
void	setForceThreadShutdown(boolean forceThreadShutdown) Sets the flag to force the taskExtender to close up in case of runaway threads - this applies *only* if the taskExecutor has been created internally.
boolean	shouldProcessAnnotation() Indicates if the process annotation is enabled or not.

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.apache.commons.logging.Log log

logger

TASK_EXECUTOR_NAME

private static final java.lang.String TASK_EXECUTOR_NAME

See Also:

Constant Field Values

SHUTDOWN_TASK_EXECUTOR_NAME

private static final java.lang.String SHUTDOWN_TASK_EXECUTOR_NAME

See Also:

Constant Field Values

CONTEXT_CREATOR_NAME

private static final java.lang.String CONTEXT_CREATOR_NAME

See Also:

Constant Field Values

APPLICATION_EVENT_MULTICASTER_BEAN_NAME

private static final java.lang.String APPLICATION_EVENT_MULTICASTER_BEAN_NAME

See Also:

Constant Field Values

CONTEXT_LISTENER_NAME

private static final java.lang.String CONTEXT_LISTENER_NAME

See Also:

Constant Field Values

PROPERTIES_NAME

private static final java.lang.String PROPERTIES_NAME

See Also:

Constant Field Values

SHUTDOWN_WAIT_KEY

private static final java.lang.String SHUTDOWN_WAIT_KEY

See Also:

Constant Field Values

PROCESS_ANNOTATIONS_KEY

private static final java.lang.String PROCESS_ANNOTATIONS_KEY

See Also:

Constant Field Values

WAIT_FOR_DEPS_TIMEOUT_KEY

private static final java.lang.String WAIT_FOR_DEPS_TIMEOUT_KEY

See Also:

Constant Field Values

EXTENDER_CFG_LOCATION

private static final java.lang.String EXTENDER_CFG_LOCATION

See Also:

Constant Field Values

XML_PATTERN

private static final java.lang.String XML_PATTERN

See Also:

Constant Field Values

ANNOTATION_DEPENDENCY_FACTORY

private static final java.lang.String ANNOTATION_DEPENDENCY_FACTORY

See Also:

Constant Field Values

AUTO_ANNOTATION_PROCESSING

private static final java.lang.String AUTO_ANNOTATION_PROCESSING

annotation processing system property (kept for backwards compatibility)

See Also:

Constant Field Values

DEFAULT_DEP_WAIT

private static final long DEFAULT_DEP_WAIT

See Also:

Constant Field Values

DEFAULT_NS_BUNDLE_STATE

private static final boolean DEFAULT_NS_BUNDLE_STATE

See Also:

Constant Field Values

DEFAULT_SHUTDOWN_WAIT

private static final long DEFAULT_SHUTDOWN_WAIT

See Also:

Constant Field Values

DEFAULT_PROCESS_ANNOTATION

private static final boolean DEFAULT_PROCESS_ANNOTATION

See Also:

Constant Field Values

extenderConfiguration

private ConfigurableOsgiBundleApplicationContext extenderConfiguration

taskExecutor

private org.springframework.core.task.TaskExecutor taskExecutor

shutdownTaskExecutor

private org.springframework.core.task.TaskExecutor shutdownTaskExecutor

isTaskExecutorManagedInternally

private boolean isTaskExecutorManagedInternally

isShutdownTaskExecutorManagedInternally

private boolean isShutdownTaskExecutorManagedInternally

isMulticasterManagedInternally

private boolean isMulticasterManagedInternally

shutdownWaitTime

private long shutdownWaitTime

dependencyWaitTime

private long dependencyWaitTime

processAnnotation

private boolean processAnnotation

nsBundledResolved

private boolean nsBundledResolved

eventMulticaster

private OsgiBundleApplicationContextEventMulticaster eventMulticaster

contextEventListener

private OsgiBundleApplicationContextListener contextEventListener

forceThreadShutdown

private boolean forceThreadShutdown

contextCreator

private OsgiApplicationContextCreator contextCreator

classLoader

private final java.lang.ClassLoader classLoader

bundle wrapped class loader

postProcessors

private final java.util.List<OsgiBeanFactoryPostProcessor> postProcessors

List of context post processors

dependencyFactories

private final java.util.List<OsgiServiceDependencyFactory> dependencyFactories

List of service dependency factories

lock

private final java.lang.Object lock

Constructor Detail

ExtenderConfiguration

public ExtenderConfiguration(org.osgi.framework.BundleContext bundleContext,
                             org.apache.commons.logging.Log log)

Constructs a new ExtenderConfiguration instance. Locates the extender configuration, creates an application context which will returned the extender items.

Parameters:

bundleContext - extender OSGi bundle context

Method Detail

postProcess

protected OsgiApplicationContextCreator postProcess(OsgiApplicationContextCreator contextCreator)

Allows post processing of the context creator.

Parameters:

contextCreator -

Returns:

destroy

public void destroy()

Cleanup the configuration items.

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

copyEnumerationToList

private java.lang.String[] copyEnumerationToList(java.util.Enumeration<?> enm)

Copies the URLs returned by the given enumeration and returns them as an array of Strings for consumption by the application context.

Parameters:

enm -

Returns:

createDefaultProperties

private java.util.Properties createDefaultProperties()

addDefaultDependencyFactories

protected void addDefaultDependencyFactories()

createDefaultTaskExecutor

private org.springframework.core.task.TaskExecutor createDefaultTaskExecutor()

createDefaultShutdownTaskExecutor

private org.springframework.core.task.TaskExecutor createDefaultShutdownTaskExecutor()

createDefaultEventMulticaster

private OsgiBundleApplicationContextEventMulticaster createDefaultEventMulticaster()

createDefaultApplicationContextCreator

private OsgiApplicationContextCreator createDefaultApplicationContextCreator()

createDefaultApplicationContextListener

private OsgiBundleApplicationContextListener createDefaultApplicationContextListener()

getShutdownWaitTime

private long getShutdownWaitTime(java.util.Properties properties)

getDependencyWaitTime

private long getDependencyWaitTime(java.util.Properties properties)

getProcessAnnotations

private boolean getProcessAnnotations(java.util.Properties properties)

getTaskExecutor

public org.springframework.core.task.TaskExecutor getTaskExecutor()

Returns the taskExecutor.

Returns:

Returns the taskExecutor

getShutdownTaskExecutor

public org.springframework.core.task.TaskExecutor getShutdownTaskExecutor()

Returns the shutdown task executor.

Returns:

Returns the shutdown task executor

getContextEventListener

public OsgiBundleApplicationContextListener getContextEventListener()

Returns the contextEventListener.

Returns:

Returns the contextEventListener

getShutdownWaitTime

public long getShutdownWaitTime()

Returns the shutdownWaitTime.

Returns:

Returns the shutdownWaitTime

shouldProcessAnnotation

public boolean shouldProcessAnnotation()

Indicates if the process annotation is enabled or not.

Returns:

Returns true if the annotation should be processed or not otherwise.

getDependencyWaitTime

public long getDependencyWaitTime()

Returns the dependencyWaitTime.

Returns:

Returns the dependencyWaitTime

getEventMulticaster

public OsgiBundleApplicationContextEventMulticaster getEventMulticaster()

Returns the eventMulticaster.

Returns:

Returns the eventMulticaster

setForceThreadShutdown

public void setForceThreadShutdown(boolean forceThreadShutdown)

Sets the flag to force the taskExtender to close up in case of runaway threads - this applies *only* if the taskExecutor has been created internally.

The flag will cause a best attempt to shutdown the threads.

Parameters:

forceThreadShutdown - The forceThreadShutdown to set.

getContextCreator

public OsgiApplicationContextCreator getContextCreator()

Returns the contextCreator.

Returns:

Returns the contextCreator

getPostProcessors

public java.util.List<OsgiBeanFactoryPostProcessor> getPostProcessors()

Returns the postProcessors.

Returns:

Returns the postProcessors

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns the class loader wrapped around the extender bundle.

Returns:

extender bundle class loader

getDependencyFactories

public java.util.List<OsgiServiceDependencyFactory> getDependencyFactories()

Returns the dependencies factories declared by the extender configuration. The list automatically contains the default listeners (such as the annotation one).

Returns:

list of dependency factories