org.apache.geronimo.kernel.management
Interface StateManageable

public interface StateManageable

A Java interface the meets the J2EE Management specification for a state manageable object.

Version:

$Rev: 355877 $ $Date: 2005-12-11 03:48:27 +0100 (Sun, 11 Dec 2005) $

Method Summary

long	getStartTime() Gets the start time of this component
int	getState() Gets the state of this component as an int.
State	getStateInstance() Gets the state of this component as a State instance.
void	start() Transitions the component to the starting state.
void	startRecursive() Transitions the component to the starting state.
void	stop() Transitions the component to the stopping state.

Method Detail

getState

public int getState()

Gets the state of this component as an int. The int return is required by the JSR77 specification.

Returns:

the current state of this component

See Also:

to obtain the State instance

getStateInstance

public State getStateInstance()

Gets the state of this component as a State instance.

Returns:

the current state of this component

getStartTime

public long getStartTime()

Gets the start time of this component

Returns:

time in milliseonds since epoch that this component was started.

start

public void start()
           throws Exception,
                  IllegalStateException

Transitions the component to the starting state. This method has access to the container.

Normally a component uses this to cache data from other components. The other components will have been created at this stage, but not necessairly started and may not be ready to have methods invoked on them.

Throws:

Exception - if a problem occurs during the transition

IllegalStateException - if this interceptor is not in the stopped or failed state

startRecursive

public void startRecursive()
                    throws Exception,
                           IllegalStateException

Transitions the component to the starting state. This method has access to the container.

If this Component is a Container, then startRecursive is called on all child Components that are in the STOPPED or FAILED state. Normally a component uses this to cache data from other components. The other components will have been created at this stage, but not necessairly started and may not be ready to have methods invoked on them.

Throws:

Exception - if a problem occurs during the transition

IllegalStateException - if this interceptor is not in the STOPPED or FAILED state

stop

public void stop()
          throws Exception,
                 IllegalStateException

Transitions the component to the stopping state. This method has access to the container.

If this is Component is a Container, then all its child components must be in the STOPPED or FAILED State.

Normally a component uses this to drop references to data cached in the start method. The other components will not necessairly have been stopped at this stage and may not be ready to have methods invoked on them.

Throws:

Exception - if a problem occurs during the transition

IllegalStateException - if this interceptor is not in the STOPPED or FAILED state