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 implementation services (which are implementation-specific), and JBI components (bindings and engines).

Author:

JSR208 Expert Group

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHUTDOWN Value returned by getCurrentState() for a shutdown component.
static String	STARTED Value returned by getCurrentState() for a running component.
static String	STOPPED Value returned by getCurrentState() for a stopped component.
static String	UNKNOWN Value returned by getCurrentState() for a component in an unknown state.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCurrentState() Get the current state of this managed compononent.
void	shutDown() Shut down the item.
void	start() Start the item.
void	stop() Stop the item.

Field Detail

SHUTDOWN

static final String SHUTDOWN

Value returned by getCurrentState() for a shutdown component.

See Also:

Constant Field Values

STOPPED

static final String STOPPED

Value returned by getCurrentState() for a stopped component.

See Also:

Constant Field Values

STARTED

static final String STARTED

Value returned by getCurrentState() for a running component.

See Also:

Constant Field Values

UNKNOWN

static final String UNKNOWN

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

See Also:

Constant Field Values

Method Detail

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.

shutDown

void shutDown()
              throws JBIException

Shut down the item. This releases resources and returns the item to an uninitialized state.

Throws:

JBIException - if the item fails to shut down.

getCurrentState

String getCurrentState()

Get the current state of this managed compononent.

Returns:

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