org.apache.fulcrum.yaafi.framework.component

Class ServiceComponentImpl

java.lang.Object

org.apache.fulcrum.yaafi.framework.component.ServiceComponentImpl

All Implemented Interfaces:

ServiceComponent, ServiceComponentLifecycle

Direct Known Subclasses:

AvalonServiceComponentImpl

public abstract class ServiceComponentImpl
extends java.lang.Object
implements ServiceComponent

This class implements am abstract base service component singleton with an arbitrary lifecycle.

Author:

Siegfried Goeschl

Constructor Summary

Constructors

Constructor and Description
ServiceComponentImpl(RoleEntry roleEntry, org.apache.avalon.framework.logger.Logger parentLogger, org.apache.avalon.framework.logger.Logger logger, ReadWriteLock readWriteLock) Constructor to parse the configuration.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	createInstance() Create an instance of the service component implementation class
void	decommision() Decommisions a service component instance.
void	dispose() Dispose a service component instance.
org.apache.avalon.framework.configuration.Configuration	getConfiguration()
org.apache.avalon.framework.context.Context	getContext()
java.lang.Class	getImplementationClazz()
java.lang.Object	getInstance()
org.apache.avalon.framework.logger.Logger	getLogger()
java.lang.String	getName() Get the unique name of the service component instance.
org.apache.avalon.framework.parameters.Parameters	getParamaters()
org.apache.avalon.framework.logger.Logger	getParentLogger()
protected java.lang.Object	getRawInstance(boolean useProxy) Get either the original service object or the dynamic proxy
protected ReadWriteLock	getReadWriteLock()
RoleEntry	getRoleEntry() Returns the associates role entry parsed from the role configuration file.
org.apache.avalon.framework.service.ServiceManager	getServiceManager()
java.lang.String	getShorthand() Get the shorthand of the service component instance.
void	incarnate() Incarnates a service component instance.
protected abstract void	incarnateInstance()
boolean	isEarlyInit()
protected boolean	isInstantiated()
void	loadImplemtationClass(java.lang.ClassLoader classLoader) Loads the implementaion class.
abstract void	reconfigure() Reconfigures a service component instance
void	setConfiguration(org.apache.avalon.framework.configuration.Configuration configuration) Sets the Configuration to be used by this component.
void	setContext(org.apache.avalon.framework.context.Context context) Sets the Context to be used by this component.
void	setLogger(org.apache.avalon.framework.logger.Logger logger) Sets the logger to be used by this component.
void	setParameters(org.apache.avalon.framework.parameters.Parameters parameters) Sets the Parameters to be used by this component.
protected void	setProxyInstance(java.lang.Object proxy)
void	setServiceManager(org.apache.avalon.framework.service.ServiceManager serviceManager) Sets the ServiceManager to be used by this component.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceComponentImpl

public ServiceComponentImpl(RoleEntry roleEntry,
                    org.apache.avalon.framework.logger.Logger parentLogger,
                    org.apache.avalon.framework.logger.Logger logger,
                    ReadWriteLock readWriteLock)

Constructor to parse the configuration.

Parameters:

roleEntry - The information extracted from the role configuration file

parentLogger - the logger of the service container

logger - The logger for the service instance

readWriteLock - the read/write lock to synchronize access to services

Method Detail

loadImplemtationClass

public void loadImplemtationClass(java.lang.ClassLoader classLoader)
                           throws java.lang.ClassNotFoundException

Description copied from interface: ServiceComponentLifecycle

Loads the implementaion class.

Specified by:

loadImplemtationClass in interface ServiceComponentLifecycle

Parameters:

classLoader - the classloader to use for loading the implementation class

Throws:

java.lang.ClassNotFoundException - loading of the class failed

See Also:

ServiceComponentLifecycle.loadImplemtationClass(java.lang.ClassLoader)

getInstance

public java.lang.Object getInstance()
                             throws java.lang.Exception

Specified by:

getInstance in interface ServiceComponentLifecycle

Returns:

Returns the instance of the singleton

Throws:

java.lang.Exception - the operation failed

See Also:

ServiceComponentLifecycle.getInstance()

incarnate

public void incarnate()
               throws java.lang.Exception

Description copied from interface: ServiceComponentLifecycle

Incarnates a service component instance.

Specified by:

incarnate in interface ServiceComponentLifecycle

Throws:

java.lang.Exception - the operation failed

See Also:

ServiceComponentLifecycle.incarnate()

reconfigure

public abstract void reconfigure()
                          throws java.lang.Exception

Description copied from interface: ServiceComponentLifecycle

Reconfigures a service component instance

Specified by:

reconfigure in interface ServiceComponentLifecycle

Throws:

java.lang.Exception - the operation failed

See Also:

ServiceComponentLifecycle.reconfigure()

decommision

public void decommision()
                 throws java.lang.Exception

Description copied from interface: ServiceComponentLifecycle

Decommisions a service component instance.

Specified by:

decommision in interface ServiceComponentLifecycle

Throws:

java.lang.Exception - the operation failed

See Also:

ServiceComponentLifecycle.decommision()

dispose

public void dispose()

Description copied from interface: ServiceComponentLifecycle

Dispose a service component instance.

Specified by:

dispose in interface ServiceComponentLifecycle

See Also:

ServiceComponentLifecycle.dispose()

setLogger

public void setLogger(org.apache.avalon.framework.logger.Logger logger)

Description copied from interface: ServiceComponentLifecycle

Sets the logger to be used by this component.

Specified by:

setLogger in interface ServiceComponentLifecycle

Parameters:

logger - The logger to set.

setContext

public void setContext(org.apache.avalon.framework.context.Context context)

Description copied from interface: ServiceComponentLifecycle

Sets the Context to be used by this component.

Specified by:

setContext in interface ServiceComponentLifecycle

Parameters:

context - The context to set.

setServiceManager

public void setServiceManager(org.apache.avalon.framework.service.ServiceManager serviceManager)

Description copied from interface: ServiceComponentLifecycle

Sets the ServiceManager to be used by this component.

Specified by:

setServiceManager in interface ServiceComponentLifecycle

Parameters:

serviceManager - The serviceManager to set.

setConfiguration

public void setConfiguration(org.apache.avalon.framework.configuration.Configuration configuration)

Description copied from interface: ServiceComponentLifecycle

Sets the Configuration to be used by this component.

Specified by:

setConfiguration in interface ServiceComponentLifecycle

Parameters:

configuration - The configuration to set.

setParameters

public void setParameters(org.apache.avalon.framework.parameters.Parameters parameters)

Description copied from interface: ServiceComponentLifecycle

Sets the Parameters to be used by this component.

Specified by:

setParameters in interface ServiceComponentLifecycle

Parameters:

parameters - The parameters to set.

isEarlyInit

public boolean isEarlyInit()

Returns:

Return true if the service is created on startup

getName

public java.lang.String getName()

Description copied from interface: ServiceComponent

Get the unique name of the service component instance.

Specified by:

getName in interface ServiceComponent

Returns:

the name of the service component

See Also:

ServiceComponent.getName()

getRoleEntry

public RoleEntry getRoleEntry()

Description copied from interface: ServiceComponent

Returns the associates role entry parsed from the role configuration file.

Specified by:

getRoleEntry in interface ServiceComponent

Returns:

Returns the roleEntry.

getLogger

public org.apache.avalon.framework.logger.Logger getLogger()

Returns:

Returns the logger.

getParentLogger

public org.apache.avalon.framework.logger.Logger getParentLogger()

Returns:

Returns the parentLogger.

getImplementationClazz

public java.lang.Class getImplementationClazz()

Returns:

Returns the implementationClazz.

getConfiguration

public org.apache.avalon.framework.configuration.Configuration getConfiguration()

Returns:

Returns the configuration.

getContext

public org.apache.avalon.framework.context.Context getContext()

Returns:

Returns the context.

getParamaters

public org.apache.avalon.framework.parameters.Parameters getParamaters()

Returns:

Returns the paramaters.

getServiceManager

public org.apache.avalon.framework.service.ServiceManager getServiceManager()

Returns:

Returns the serviceManager.

getShorthand

public java.lang.String getShorthand()

Description copied from interface: ServiceComponent

Get the shorthand of the service component instance. The shorthand is usually used to lookup the configuration entries.

Specified by:

getShorthand in interface ServiceComponent

Returns:

the shorthand of the service

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

isInstantiated

protected final boolean isInstantiated()

Returns:

Returns true if the service instance was already instantiated.

createInstance

protected java.lang.Object createInstance()
                                   throws java.lang.InstantiationException,
                                          java.lang.IllegalAccessException

Create an instance of the service component implementation class

Throws:

java.lang.InstantiationException - th

java.lang.IllegalAccessException

incarnateInstance

protected abstract void incarnateInstance()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

See Also:

ServiceComponentLifecycle.incarnate()

getRawInstance

protected java.lang.Object getRawInstance(boolean useProxy)

Get either the original service object or the dynamic proxy

Returns:

Returns the raw instance, i.e. does not incarnate the instance.

setProxyInstance

protected void setProxyInstance(java.lang.Object proxy)

Parameters:

proxy - the service proxy instance

getReadWriteLock

protected final ReadWriteLock getReadWriteLock()

Returns:

Returns the readWriteLock.