org.jboss.dashboard.factory
Class BasicFactoryElement

java.lang.Object
  org.jboss.dashboard.factory.BasicFactoryElement

All Implemented Interfaces:

Serializable, FactoryLifecycle

Direct Known Subclasses:

CacheConfigurationGenerator, CacheConfigurationManager, CacheElement, CacheFactory, CacheOptions, ErrorReport, MultiCacheManager

public abstract class BasicFactoryElement
extends Object
implements FactoryLifecycle, Serializable

Base class that any Factory bean must extends.

See Also:

Serialized Form

Constructor Summary

BasicFactoryElement()

Method Summary

protected void	addPeriodicTask(Method m, long sleepInterval)
protected void	addPeriodicTask(String methodName, long sleepInterval)
Object	factoryLookup(String path)
String	getComponentAlias()
String	getComponentDescription()
String	getComponentName()
String	getComponentScope()
void	init() Called after constructing the instance and before setting the default properties
void	setComponentAlias(String alias)
void	shutdown() Called when the Factory is going down, to allow the release of resources.
void	start() Called after constructing the instance and setting the default properties.
void	stop() Called by the factory before setting a group of properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicFactoryElement

public BasicFactoryElement()

Method Detail

init

public void init()
          throws Exception

Called after constructing the instance and before setting the default properties

Specified by:

init in interface FactoryLifecycle

Throws:

Exception

start

public void start()
           throws Exception

Called after constructing the instance and setting the default properties. When the Factory is about to set a group of properties, it calls stop, sets the properties and then calls start.

Specified by:

start in interface FactoryLifecycle

Throws:

Exception

stop

public void stop()
          throws Exception

Called by the factory before setting a group of properties. This way the component can simulate a transactional behaviour.

Specified by:

stop in interface FactoryLifecycle

Throws:

Exception

shutdown

public void shutdown()
              throws Exception

Called when the Factory is going down, to allow the release of resources.

Specified by:

shutdown in interface FactoryLifecycle

Throws:

Exception

getComponentName

public final String getComponentName()

Returns:

The name inside the Factory tree where this component is being held.

getComponentScope

public final String getComponentScope()

Returns:

The scope inside the Factory tree where this component is being held.

getComponentDescription

public final String getComponentDescription()

Returns:

The description inside the Factory tree where this component is being held.

factoryLookup

public Object factoryLookup(String path)

setComponentAlias

public void setComponentAlias(String alias)

getComponentAlias

public String getComponentAlias()

addPeriodicTask

protected void addPeriodicTask(String methodName,
                               long sleepInterval)

addPeriodicTask

protected void addPeriodicTask(Method m,
                               long sleepInterval)