Package com.newstep.solid.management.runtime
This provides an interface for a single default mbean server
for a Runtime system, that provides registration components
and subsystems beyond regular registration of an mbean server.
The connection may be local or it may exist remotely.
It resides over a single domain and takes responsibility
for administering it.
It is up to the implementors of ActiveAgent to determine
what access points are given to the ActiveAgent.
See com.newstep.solid.management.runtime.component.ComponentEnvironment
Author:
msimonsen
| Operation Summary |
| register | This will create an instance of the mbean on the server, |
| register | This will create an instance of the mbean on the server, |
| unRegister | De registers a registered mbean in the server. |
Generates a name based on the managed domain.
Parameters:
obj
Return:
A generated object name.
Abstract.
Throws:
MalformedObjectNameException
An handle to the mbean server.
Return:
The default MBean server connection.
Abstract.
The domain of management.
Return:
The managed domain of this active agent.
Abstract.
This will create an instance of the mbean on the server,
Parameters:
mbean
name - The object name
Abstract.
Throws:
InstanceAlreadyExistsException,MBeanRegistrationException,NotCompliantMBeanException,ReflectionException,MBeanException,IOException
This will create an instance of the mbean on the server,
Parameters:
mbean
Abstract.
Throws:
InstanceAlreadyExistsException,MBeanRegistrationException,NotCompliantMBeanException,ReflectionException,MBeanException,IOException,MalformedObjectNameException
De registers a registered mbean in the server.
Parameters:
name
Abstract.
Throws:
InstanceNotFoundException,MBeanRegistrationException,IOException
Represents the possible states for an executable entity. The states include
the base
IDLE: initial state
RUNNING: accepting new requests, processing requests
SUSPENDED: not accepting new requests, not processing pending requests
along with the transitional states
STARTING: may accept requests, may process requests
SUSPENDING: may not accept requests, may process pending requests
RESUMING: may accept reqeusts, may process pending requests
SHUTTINGDOWN: not accepting requests, processing pending requests
STOPPING: not accepting requests, not processing pending requests
DONE: not accepting requests, not processing requests
ERROR: not accepting requests, not processing requests
Full name:
com.newstep.solid.management.runtime.ExecState
Public.
Visibility:
public
| Enumeration Literal Summary |
Visibility:
package
Visibility:
package
Visibility:
package
Visibility:
package
Visibility:
package
Visibility:
package
Visibility:
package
Visibility:
package
Visibility:
package
Visibility:
package
Provides a contract for controlling an entitie's execution state.
The ManagedExecutable construct supports asynchronous executables which
transition to their destination states through a transient intermediate
states (e.g. from RUNNING to STOPPING to IDLE).
NOTE: it is possible for an executable to passthrough the intermediate
state immediately and end in the stable transition state on the return from
the invoking function. For example a synchronous version of ManagedExecutable
may be in the RUNNING state on return from start() whereas an
asynchronous version may return from start() in the STARTING
state.
| Operation Summary |
| addListener | adds the specified ManagedExecutableListener |
| resume | initiates the transition SUSPENDED to RUNNING. On successful return the
executable will be in one of RESUMING or RUNNING states. If an error
occurs the executable will be in the ERROR state.
If the entity is asynchronous, it may be RESUMING on return.
If the entity is synchronous, it will be RUNNING on return.
<P>
resume may only be invoked on executables that are in the SUSPENDED state. |
| shutdown | initiates the transition from RUNNING to SHUTTINGDOWN (which transitions
to DONE). On successful return the executable will be in the SHUTTINGDOWN
state. If an error occurs during the shutdown the executable will be in
the ERROR state.
<P>
shutdown may be invoked on executables in the RUNNING state |
| start | initiates the transition from IDLE to RUNNING. On successful return the
executable will be in one of STARTING or RUNNING states. If an error
occurs while starting the component will be in the ERROR state on return.
If the executable is asynchronous, it may be STARTING on return.
If the executable is synchronous, it will be RUNNING on return.
<P>
start may only be invoked on ManagedExecutables that are in the IDLE state. |
| stop | initiates the transition to the DONE state. On successful return
the executable will be in one of STOPPING or DONE states. If an error
occurs while stopping the executable will be in the ERROR state.
If the executable is asynchronous, it may STOPPING on return.
If the executable is synchronous, it will be DONE on return.
<P>
stop may be invoked from RUNNING, SUSPENDED, or SHUTTINGDOWN |
| suspend | initiates the transition from RUNNING to SUSPENDED. On successful return,
the executable will be in one of SUSPENDING or SUSPENDED states. If an
error occurs while suspending the executable will be in the ERROR state.
If the executable is asynchronous, it may be SUSPENDING on return.
If the executable is synchronous, it will be SUSPENDED on return.
<P>
suspend may only be invoked on executables that are in the RUNNING state. |
adds the specified ManagedExecutableListener
Parameters:
listener the ManagedExecutable listener to inform of state updates
Abstract.
Return:
retrieves the current state of the ManagedExecutable
Abstract.
removes the specified ManagedExecutableListener
Parameters:
listener the ManagedExecutable listener which will no longer be
informed of state updates
Abstract.
initiates the transition SUSPENDED to RUNNING. On successful return the
executable will be in one of RESUMING or RUNNING states. If an error
occurs the executable will be in the ERROR state.
If the entity is asynchronous, it may be RESUMING on return.
If the entity is synchronous, it will be RUNNING on return.
resume may only be invoked on executables that are in the SUSPENDED state.
Abstract.
Throws:
ExecutableException
initiates the transition from RUNNING to SHUTTINGDOWN (which transitions
to DONE). On successful return the executable will be in the SHUTTINGDOWN
state. If an error occurs during the shutdown the executable will be in
the ERROR state.
shutdown may be invoked on executables in the RUNNING state
Abstract.
Throws:
ExecutableException
initiates the transition from IDLE to RUNNING. On successful return the
executable will be in one of STARTING or RUNNING states. If an error
occurs while starting the component will be in the ERROR state on return.
If the executable is asynchronous, it may be STARTING on return.
If the executable is synchronous, it will be RUNNING on return.
start may only be invoked on ManagedExecutables that are in the IDLE state.
Abstract.
Throws:
ExecutableException
initiates the transition to the DONE state. On successful return
the executable will be in one of STOPPING or DONE states. If an error
occurs while stopping the executable will be in the ERROR state.
If the executable is asynchronous, it may STOPPING on return.
If the executable is synchronous, it will be DONE on return.
stop may be invoked from RUNNING, SUSPENDED, or SHUTTINGDOWN
Abstract.
Throws:
ExecutableException
initiates the transition from RUNNING to SUSPENDED. On successful return,
the executable will be in one of SUSPENDING or SUSPENDED states. If an
error occurs while suspending the executable will be in the ERROR state.
If the executable is asynchronous, it may be SUSPENDING on return.
If the executable is synchronous, it will be SUSPENDED on return.
suspend may only be invoked on executables that are in the RUNNING state.
Abstract.
Throws:
ExecutableException
ManagedExecutableListener
implementing ManagedExecutableListener allows an entity to receive
notifications of state changes within a ManagedExecutable
| Operation Summary |
| done | indicates the specified ManagedExecutable has reached the DONE state |
| error | indicates the specified ManagedExecutable has reached the ERROR state |
| idle | indicates the specified ManagedExecutable has reached the IDLE state |
| resuming | indicates the specified ManagedExecutable has reached the RESUMING state |
| running | indicates the specified ManagedExecutable has reached the RUNNING state |
| shuttingDown | indicates the specified ManagedExecutable has reached the SHUTTINGDOWN state |
| starting | indicates the specified ManagedExecutable has reached the STARTING state |
| stopping | indicates the specified ManagedExecutable has reached the STOPPING state |
| suspended | indicates the specified ManagedExecutable has reached the SUSPENDED state |
| suspending | indicates the specified ManagedExecutable has reached the SUSPENDING state |
indicates the specified ManagedExecutable has reached the DONE state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the ERROR state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the IDLE state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the RESUMING state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the RUNNING state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the SHUTTINGDOWN state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the STARTING state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the STOPPING state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the SUSPENDED state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
indicates the specified ManagedExecutable has reached the SUSPENDING state
Parameters:
executable the ManagedExecutable whose state has changed
Abstract.
Note text:
Consider Enum here
Links:
Note Link [Note Link: [Note1] -> [DONE]]
to Enumeration Literal DONE
[Note Link: [Note1] -> [DONE]]