StateManageable MBean

All Parent MBeans:
Stateful, EventProvider

Partial ObjectName:
WebSphere:*,type=StateManageable


MBean StateManageable

The StateManageable model specifies the operations and attributes that must be implemented by a managed object that supports state management. A managed object that implements the StateManageable model is termed a State Manageable Object (SMO). An SMO generates events when its state changes.

Since:
6.0

Attribute Summary
intstate
           The current state of this SMO.
longstartTime
           The time that the managed object was started (i.

Attributes inherited from MBean EventProvider
eventTypes

Operation Summary
voidstart()
           Starts the SMO.
voidstartRecursive()
           Starts the SMO.
voidstop()
           Stops the SMO.

Notifications inherited from MBean Stateful
j2ee.state.starting, j2ee.state.running, j2ee.state.stopping, j2ee.state.stopped, j2ee.state.failed

Attributes inherited from MBean EventProvider
j2ee.attribute.changed

Attribute Detail

state

public int state
The current state of this SMO.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

startTime

public long startTime
The time that the managed object was started (i.e. entered the RUNNING state) represented as a long, which value is the number of milliseconds since January 1, 1970, 00:00:00.
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Operation Detail

start

public void start()
Starts the SMO. This operation can be invoked only when the SMO is in the STOPPED or FAILED state. It causes the SMO to go into the STARTING state initially, and if it completes successfully, the SMO will be in the RUNNING state. Note that start() is not called on any of the child SMOs that are registered with this SMO; it is the responsibility of the calling application to start the child SMO if this is required.
Security Roles:
administrator
operator

startRecursive

public void startRecursive()
Starts the SMO. This operation can only be invoked when the SMO is in the STOPPED or FAILED state. It causes the SMO to go into the STARTING state initially, and if it completes successfully, the SMO will be in the RUNNING state. The operation startRecursive() is called on all the child SMOs registered with this SMO that are in the STOPPED or FAILED state.
Security Roles:
administrator
operator

stop

public void stop()
Stops the SMO. This operation can only be invoked when the SMO is in the RUNNING or STARTING state. It causes stop() to be called on all the child SMOs registered with this SMO that are in the RUNNING or STARTING state. It is mandatory if an SMO is in the STOPPED or FAILED state, that all its child SMOs must also be in the STOPPED or FAILED state, therefore there is no stopRecursive() operation. Invoking stop() causes the SMO to go into the STOPPING state initially, and if it completes successfully, the SMO and all the child SMOs will be in the STOPPED state.
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005