| org.apache.turbine.services.Initable
All known Subclasses: org.apache.turbine.services.BaseInitable,
| Initable | | public interface Initable (Code) | | Classes that implement this interface need initialization before
they can work.
These classes rely also on an InitableBroker that
ensures that there is only one instance of the class in the system,
and handles dependencies between Initables.
author:
Kevin Burton
author:
Rafal Krzewski
version:
$Id: Initable.java 534527 2007-05-02 16:10:59Z tv $ |
| Method Summary | |
| boolean | getInit()
Returns initialization status of an Initable. | | void | init(Object data)
Performs early initailization of an Initable
During the startup of the system, different objects may be
passed to your class using this method. | | void | init()
Performs late initialization of an Initable. | | void | setInitableBroker(InitableBroker broker)
Provides an Initable with a reference to the InitableBroker
that instantiated this object, so that it can access other
Initables. | | void | shutdown()
Returns an Initable to an uninitialized state.
This method must release all resources allocated by the
Initable implementation, and resetting its internal state.
You may chose to implement this operation or not. |
| getInit | | boolean getInit()(Code) | | Returns initialization status of an Initable.
Initialization status of an Initable. |
| init | | void init(Object data) throws InitializationException(Code) | | Performs early initailization of an Initable
During the startup of the system, different objects may be
passed to your class using this method. It should ignore any
objects that it doesn't need or understand.
After the class changes its internal state so that getInit()
returns true, this method will be called no more, and late
initialization will not be performed.
If your class relies on early initialization, and the object it
expects was not received, you can use late initialization to
throw an exception and complain.
Parameters:
data - An Object to use for initialization activities.
exception:
InitializationException - if initilaization of thisclass was not successful. |
| init | | void init() throws InitializationException(Code) | | Performs late initialization of an Initable.
When your class is being requested from an InitableBroker, it
will call getInit(), and if it returns false, this method will
be invoked.
exception:
InitializationException - if initialization of thisclass was not successful. |
| setInitableBroker | | void setInitableBroker(InitableBroker broker)(Code) | | Provides an Initable with a reference to the InitableBroker
that instantiated this object, so that it can access other
Initables.
Parameters:
broker - The InitableBroker that instantiated this object. |
| shutdown | | void shutdown()(Code) | | Returns an Initable to an uninitialized state.
This method must release all resources allocated by the
Initable implementation, and resetting its internal state.
You may chose to implement this operation or not. If you support
this operation, getInit() should return false after successful
shutdown of the service.
|
|
|