javax.jbi.management
Interface LifeCycleMBean

All Known Subinterfaces:

ComponentLifeCycleMBean

public interface LifeCycleMBean

LifeCycleMBean is a base interface that defines standard life cycle controls for JBI Framework services and JBI Components (bindings and engines).

Author:

JSR208 Expert Group

Field Summary

static java.lang.String	SHUTDOWN Value returned by getCurrentState() for a shutdown component.
static java.lang.String	STARTED Value returned by getCurrentState() for a started component.
static java.lang.String	STOPPED Value returned by getCurrentState() for a stopped component.
static java.lang.String	UNKNOWN Value returned by getCurrentState() for a component in an unknown state.

Method Summary

java.lang.String	getCurrentState() Get the current state of this managed component.
void	shutDown() Shut down the item.
void	start() Start the item.
void	stop() Stop the item.

Field Detail

SHUTDOWN

static final java.lang.String SHUTDOWN

Value returned by getCurrentState() for a shutdown component.

See Also:

Constant Field Values

STARTED

static final java.lang.String STARTED

Value returned by getCurrentState() for a started component.

See Also:

Constant Field Values

STOPPED

static final java.lang.String STOPPED

Value returned by getCurrentState() for a stopped component.

See Also:

Constant Field Values

UNKNOWN

static final java.lang.String UNKNOWN

Value returned by getCurrentState() for a component in an unknown state.

See Also:

Constant Field Values

Method Detail

getCurrentState

java.lang.String getCurrentState()

Get the current state of this managed component.

Returns:

the current state of this managed component (must be one of the string constants defined by this interface)

shutDown

void shutDown()
              throws JBIException

Shut down the item. This releases resources, returning the item to an unitialized state.

Throws:

JBIException - if the item fails to shut down

start

void start()
           throws JBIException

Start the item.

Throws:

JBIException - if the item fails to start

stop

void stop()
          throws JBIException

Stop the item. This suspends current messaging activities.

Throws:

JBIException - if the item fails to stop