Package com.tangosol.application

Class ContainerAdapter

java.lang.Object

com.tangosol.application.ContainerAdapter

public class ContainerAdapter
extends Object

ContainerAdapter is a facility intended for use by application servers to host Coherence applications. This facility manages the application life cycle and configuration.

The application descriptor file (coherence-application.xml) contains the location of a cache configuration file and (optionally) a POF configuration file. It may also specify the name of a ConfigurableCacheFactory class to be used to create caches instead of the system-wide default (Note that this class must implement ExtensibleConfigurableCacheFactory).

After creating an instance of ContainerAdapter. the container should call activate() to start the application and deactivate() to stop it.

Since:

Coherence 12.1.2

Author:

cf 2011.05.24

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContainerAdapter.CoherenceFactory	A factory for producing a Coherence instance.
protected class	ContainerAdapter.ContainerCacheFactoryBuilder	ContainerCacheFactoryBuilder creates a ConfigurableCacheFactory instance using the knowledge from this ContainerAdapter instance.
static class	ContainerAdapter.DefaultCoherenceFactory	A default implementation of a ContainerAdapter.CoherenceFactory.
static class	ContainerAdapter.DefaultContext	The ContainerAdapter.DefaultContext represents the context for an application.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CACHE_URI_DEFAULT	Internally used "default" URI identifier.
protected ServiceMonitor	f_serviceMonitor	The ServiceMonitor to use.
protected ContainerAdapter.ContainerCacheFactoryBuilder	m_builder	The ContainerAdapter.ContainerCacheFactoryBuilder used to create a ConfigurableCacheFactory for the application.
protected Coherence	m_coherence	The Coherence instance.
protected ContainerContext	m_containerCtx	The ContainerContext.
protected ContainerAdapter.DefaultContext	m_context	The Context for the application.
protected boolean	m_fActivated	Indicates whether the ContainerAdapter has been activated or not.
protected ExtensibleConfigurableCacheFactory	m_factory	The ConfigurableCacheFactory for the application.
protected boolean	m_fExclusiveMonitor	Indicates whether the ServiceMonitor has been exclusively created for this ContainerAdapter.
protected LifecycleListener	m_listener	The LifecycleListener used for lifecycle callbacks to the application.
protected List<LifecycleListener>	m_listLifecycleListener	The LifecycleListeners to be notified of lifecycle events for this ContainerAdapter.
protected ClassLoader	m_loader	The ClassLoader for the application.
protected ClassLoader	m_loaderCtx	The caller's thread context ClassLoader.
protected String	m_sAppDescriptorURI	The URI to the coherence-application.xml file.
protected String	m_sAppName	The name of the application.
protected XmlElement	m_xmlAppDescriptor	The XmlElement representing the application descriptor.

Constructor Summary

Constructors

Constructor	Description
ContainerAdapter(ClassLoader loader, String sAppDescriptorURI, String sAppName)	Construct the ContainerAdapter.
ContainerAdapter(ClassLoader loader, String sAppDescriptorURI, String sAppName, CacheFactoryBuilder builder, XmlElement xmlAppDescriptor, ServiceMonitor serviceMonitor)	Construct the ContainerAdapter.
ContainerAdapter(ClassLoader loader, String sAppDescriptorURI, String sAppName, XmlElement xmlAppDescriptor)	Construct the ContainerAdapter.

Method Summary

Modifier and Type	Method	Description
void	activate()	Initialize and start the application that is hosted by this ContainerAdapter.
void	associateWithClassLoader(ClassLoader[] aClassLoaders)	Associates the application hosted by this ContainerAdapter with specified ClassLoaders.
void	deactivate()	Deactivate the application hosted by this ContainerAdapter.
void	deactivate(boolean fShutdown)	Deactivate the application hosted by this ContainerAdapter.
protected void	ensureContextClassLoader()	Ensure that the thread context ClassLoader is set to the ContainerAdapter's ClassLoader; save the current thread context ClassLoader if necessary.
protected static XmlElement	extractFactoryConfig(XmlElement xmlAppDescriptor)	Extract the XmlElement representing the factory for the ConfigurableCacheFactory instance.
Context	getApplicationContext()	Return the Context for the application.
ContainerContext	getContainerContext()	Return the ContainerContext used by this ContainerAdapter.
ClassLoader	getContextClassLoader()	Return the ClassLoader used by this ContainerAdapter.
protected List<LifecycleListener>	getLifecycleListeners()	Returns an unmodifiable list of LifecycleListeners registered for this ContainerAdapter.
protected void	restoreContextClassLoader()	Restore the thread context ClassLoader for the caller.
void	setCoherenceFactory(ContainerAdapter.CoherenceFactory factory)	Set the ContainerAdapter.CoherenceFactory to use to create Coherence instances.
void	setContainerContext(ContainerContext ctx)	Set the ContainerContext associated with this ContainerAdapter instance.

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_URI_DEFAULT

protected static final String CACHE_URI_DEFAULT

Internally used "default" URI identifier.

See Also:

Constant Field Values

f_serviceMonitor

protected final ServiceMonitor f_serviceMonitor

The ServiceMonitor to use.

m_builder

protected ContainerAdapter.ContainerCacheFactoryBuilder m_builder

The ContainerAdapter.ContainerCacheFactoryBuilder used to create a ConfigurableCacheFactory for the application.

m_factory

protected ExtensibleConfigurableCacheFactory m_factory

The ConfigurableCacheFactory for the application.

m_coherence

protected Coherence m_coherence

The Coherence instance.

m_loader

protected ClassLoader m_loader

The ClassLoader for the application.

m_sAppDescriptorURI

protected String m_sAppDescriptorURI

The URI to the coherence-application.xml file.

m_xmlAppDescriptor

protected XmlElement m_xmlAppDescriptor

The XmlElement representing the application descriptor.

m_sAppName

protected String m_sAppName

The name of the application.

m_containerCtx

protected ContainerContext m_containerCtx

The ContainerContext.

m_listener

protected LifecycleListener m_listener

The LifecycleListener used for lifecycle callbacks to the application.

m_listLifecycleListener

protected List<LifecycleListener> m_listLifecycleListener

The LifecycleListeners to be notified of lifecycle events for this ContainerAdapter.

The LifecycleListeners will be discovered and loaded using the ServiceLoader.

m_context

protected ContainerAdapter.DefaultContext m_context

The Context for the application.

m_loaderCtx

protected ClassLoader m_loaderCtx

The caller's thread context ClassLoader.

m_fActivated

protected boolean m_fActivated

Indicates whether the ContainerAdapter has been activated or not.

m_fExclusiveMonitor

protected boolean m_fExclusiveMonitor

Indicates whether the ServiceMonitor has been exclusively created for this ContainerAdapter.

Constructor Detail

ContainerAdapter

public ContainerAdapter(ClassLoader loader,
                        String sAppDescriptorURI,
                        String sAppName)

Construct the ContainerAdapter.

Parameters:

loader - the ClassLoader for the application

sAppDescriptorURI - the URI to coherence-application.xml

sAppName - the name of the application

ContainerAdapter

public ContainerAdapter(ClassLoader loader,
                        String sAppDescriptorURI,
                        String sAppName,
                        XmlElement xmlAppDescriptor)

Construct the ContainerAdapter.

Parameters:

loader - the ClassLoader for the application

sAppDescriptorURI - the URI to coherence-application.xml

sAppName - the name of the application

xmlAppDescriptor - the XmlElement containing the application descriptor; if not null it will be used instead of the configuration specified by sAppDescriptorURI

ContainerAdapter

public ContainerAdapter(ClassLoader loader,
                        String sAppDescriptorURI,
                        String sAppName,
                        CacheFactoryBuilder builder,
                        XmlElement xmlAppDescriptor,
                        ServiceMonitor serviceMonitor)

Construct the ContainerAdapter.

Parameters:

loader - the ClassLoader for the application

sAppDescriptorURI - the URI to the application configuration descriptor

sAppName - the name of the application

builder - the CacheFactoryBuilder to use

xmlAppDescriptor - the XmlElement containing the application descriptor; if not null it will be used instead of the configuration specified by sAppDescriptorURI

serviceMonitor - the ServiceMonitor to use for the application

Method Detail

setContainerContext

public void setContainerContext(ContainerContext ctx)

Set the ContainerContext associated with this ContainerAdapter instance.

This method must be called before the adapter is activated.

Parameters:

ctx - the ContainerContext reference

activate

public void activate()

Initialize and start the application that is hosted by this ContainerAdapter.

If this method throws an exception, the caller is NOT required to call deactivate().

Throws:

IllegalStateException - if the application has already been activated

deactivate

public void deactivate()

Deactivate the application hosted by this ContainerAdapter. This method will shut down any resources / Coherence services that were used by the application.

Throws:

IllegalStateException - if the application is not active

deactivate

public void deactivate(boolean fShutdown)

Deactivate the application hosted by this ContainerAdapter. If fShutdown is true shutdown any resources / Coherence services that were used by the application otherwise clear local references.

Parameters:

fShutdown - whether to shut down the resources, incl. any services, that were started as a part of this application

Throws:

IllegalStateException - if the application is not active

associateWithClassLoader

public void associateWithClassLoader(ClassLoader[] aClassLoaders)

Associates the application hosted by this ContainerAdapter with specified ClassLoaders.

Parameters:

aClassLoaders - an array of ClassLoaders to associate this adapter with

getContextClassLoader

public ClassLoader getContextClassLoader()

Return the ClassLoader used by this ContainerAdapter.

Returns:

the ClassLoader used by this ContainerAdapter

getApplicationContext

public Context getApplicationContext()

Return the Context for the application.

Returns:

the Context for the application

getContainerContext

public ContainerContext getContainerContext()

Return the ContainerContext used by this ContainerAdapter.

Returns:

the ContainerContext used by this ContainerAdapter.

setCoherenceFactory

public void setCoherenceFactory(ContainerAdapter.CoherenceFactory factory)

Set the ContainerAdapter.CoherenceFactory to use to create Coherence instances.

Parameters:

factory - the ContainerAdapter.CoherenceFactory to use to create Coherence instances

getLifecycleListeners

protected List<LifecycleListener> getLifecycleListeners()

Returns an unmodifiable list of LifecycleListeners registered for this ContainerAdapter.

If the list of listeners does not yet exist it will be created and initially populated using the ServiceLoader to discover and load listeners.

Returns:

the list of LifecycleListeners registered for this ContainerAdapter

extractFactoryConfig

protected static XmlElement extractFactoryConfig(XmlElement xmlAppDescriptor)

Extract the XmlElement representing the factory for the ConfigurableCacheFactory instance.

Parameters:

xmlAppDescriptor - the application descriptor XML element

Returns:

the XmlElement representing the factory or null if no element exists.

ensureContextClassLoader

protected void ensureContextClassLoader()

Ensure that the thread context ClassLoader is set to the ContainerAdapter's ClassLoader; save the current thread context ClassLoader if necessary.

restoreContextClassLoader

protected void restoreContextClassLoader()

Restore the thread context ClassLoader for the caller.