StatisticsProvider, Stateful, EventProvider
WebSphere:*,type=SIBMessagingEngine
MBean SIBMessagingEngine
Management interface for the SIB Messaging Engine component
Attributes inherited from MBean StatisticsProvider |
---|
stats |
Attributes inherited from MBean EventProvider |
---|
eventTypes |
Operation Summary | |
---|---|
java.lang.Long | getDepth( Get the number of messages currently on the temporaryQueuePoint on ME |
boolean | isStarted() Returns whether the Messaging Engine is in the started state. |
java.lang.String | state() Returns the state of the Messaging Engine. |
java.lang.String | stateExtended() Returns the state of the Messaging Engine |
void | start() Starts a stopped or inactive Messaging Engine |
void | start( Starts a stopped or inactive Messaging Engine with the specified start mode. |
void | stop() Stops a running Messaging Engine using the default stop mode of immediate |
void | stop( Stops a running Messaging Engine with the specified stop mode. |
SIBQueuePoint[] | listQueuePoints() List all QueuePoints localized to this MessagingEngine |
SIBQueuePoint | getQueuePoint( Get information relating to a QueuePoint localized to this Messaging Engine |
SIBQueuedMessage[] | getQueuePointMessages( List information on all messages localized to a specific QueuePoint |
SIBQueuedMessage[] | getQueuePointMessages( List information on all messages localized to a specific QueuePoint |
SIBQueuedMessage | getQueuePointMessage( Get information on a specific message on a specific QueuePoint |
SIBQueuedMessageDetail | getQueuePointMessageDetail( Get detailed information on a specific message on a specific QueuePoint |
SIBQueuedMessageDetail | getQueuePointMessageDetail( Get detailed information on a specific message on a specific QueuePoint |
byte[] | getQueuePointMessageData( Return data from a specific message on a specific QueuePoint |
com.ibm.wsspi.hamanager.GroupName | getHAGroupName() Returns the GroupName of the HA Group the Messaging Engine is in. |
java.lang.String | getHealth() Returns the current Health of the Messaging Engine, as a String. |
void | injectFault( Injects a simulated fault into the Messaging Engine, causing it to fail the next health check. |
void | dump( Invoke the Messaging Engine diagnostic dump |
java.util.Collection | getPreparedTransactions() List in-doubt transactions |
void | commitPreparedTransaction( Commit the given transaction by xid |
void | rollbackPreparedTransaction( Rollback the given transaction by xid |
void | disableDataStoreLock( This method has no effect on a messaging engine. |
void | resetDestination( Resets a corrupt destination such that on restart, it is deleted and recreated. |
Notification Summary | |
---|---|
SIB.messaging.engine.start An ME is being started. | |
SIB.messaging.engine.stop An ME is being stopped. | |
SIB.security.not.authenticated The ME could not authenticate a user. | |
SIB.security.not.authorized The ME denied a user authorization to access a resource. | |
SIB.communications.connection.start An intra-bus ME to ME connection has been started. | |
SIB.communications.connection.stop An intra-bus ME to ME connection has been stopped. | |
SIB.message.exceptioned The ME exceptioned a message that could not be delivered to the intended destination. | |
SIB.client.connection.start A remote client has connected to the ME. | |
SIB.client.connection.stop A remote client has disconnected from the ME. | |
SIB.messaging.engine.starting An ME is being started. | |
SIB.messaging.engine.stopping An ME is being stopped. | |
SIB.messaging.engine.failed An ME start or stop has failed. |
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 |
Operation Detail |
---|
public java.lang.Long getDepth(
java.lang.String id
)
Get the number of messages currently on the temporaryQueuePoint on ME
id
-
The ID of the QueuePoint derived from ME
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public boolean isStarted()
Returns whether the Messaging Engine is in the started state.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String state()
Returns the state of the Messaging Engine.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String stateExtended()
Returns the state of the Messaging Engine
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void start()
Starts a stopped or inactive Messaging Engine
administrator
operator
public void start(
java.lang.String mode
)
Starts a stopped or inactive Messaging Engine with the specified start mode.
mode
-
Start mode. Valid values are 'DEFAULT' (the default) and 'FLUSH'.
administrator
operator
public void stop()
Stops a running Messaging Engine using the default stop mode of immediate
administrator
operator
public void stop(
java.lang.String mode
)
Stops a running Messaging Engine with the specified stop mode.
mode
-
Stop mode. Valid values are 'IMMEDIATE' (the default) and 'FORCE'.
administrator
operator
public SIBQueuePoint[] listQueuePoints()
List all QueuePoints localized to this MessagingEngine
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuePoint getQueuePoint(
java.lang.String id
)
Get information relating to a QueuePoint localized to this Messaging Engine
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint class
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessage[] getQueuePointMessages(
java.lang.String id
)
List information on all messages localized to a specific QueuePoint
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint class
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessage[] getQueuePointMessages(
java.lang.String id,
java.lang.Integer toIndex,
java.lang.Integer fromIndex,
java.lang.Integer totalMessagesPerPage
)
List information on all messages localized to a specific QueuePoint
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint class toIndex
-
fromIndex fromIndex
-
toIndex totalMessagesPerPage
-
totalMessagesPerPage
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessage getQueuePointMessage(
java.lang.String id,
java.lang.String messageId
)
Get information on a specific message on a specific QueuePoint
id
-
The ID of the QueuePoint as derived from the SIBQueuePoint class messageId
-
The ID of the Message as derived from the SIBQueuedMessage class
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessageDetail getQueuePointMessageDetail(
java.lang.String qpId,
java.lang.String messageId
)
Get detailed information on a specific message on a specific QueuePoint
qpId
-
The ID of the QueuePoint as derived from the SIBQueuePoint class messageId
-
The ID of the Message as derived from the SIBQueuedMessage class
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public SIBQueuedMessageDetail getQueuePointMessageDetail(
java.lang.String qpId,
java.lang.String messageId,
java.util.Locale locale
)
Get detailed information on a specific message on a specific QueuePoint
qpId
-
The ID of the QueuePoint as derived from the SIBQueuePoint class messageId
-
The ID of the Message as derived from the SIBQueuedMessage class locale
-
The locale to render exception reason messages for the SIBQueuedMessage
Since:
6.1
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public byte[] getQueuePointMessageData(
java.lang.String qpId,
java.lang.String messageId,
java.lang.Integer size
)
Return data from a specific message on a specific QueuePoint
qpId
-
The ID of the QueuePoint as derived from the SIBQueuePoint class messageId
-
The ID of the Message as derived from the SIBQueuedMessage class size
-
The number of bytes to return
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public com.ibm.wsspi.hamanager.GroupName getHAGroupName()
Returns the GroupName of the HA Group the Messaging Engine is in.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public java.lang.String getHealth()
Returns the current Health of the Messaging Engine, as a String.
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void injectFault(
java.lang.String severity
)
Injects a simulated fault into the Messaging Engine, causing it to fail the next health check.
severity
-
Error severity (LocalError or GlobalError)
administrator
operator
public void dump(
java.lang.String dumpSpec
)
Invoke the Messaging Engine diagnostic dump
dumpSpec
-
The dump specification string
administrator
operator
public java.util.Collection getPreparedTransactions()
List in-doubt transactions
administrator
operator
configurator
monitor
deployer
adminsecuritymanager
public void commitPreparedTransaction(
java.lang.String xid
)
Commit the given transaction by xid
xid
-
The xid of the transaction
administrator
operator
public void rollbackPreparedTransaction(
java.lang.String xid
)
Rollback the given transaction by xid
xid
-
The xid of the transaction
administrator
operator
public void disableDataStoreLock(
java.lang.Long period
)
This method has no effect on a messaging engine. A CWSIS1596I message is logged by the server hosting the messaging engine to indicate that this operation has been attempted. The data store exclusive lock ensures integrity of the data within the data store. If you have identified a need to disable the data store exclusive lock contact IBM Support.
period
-
The time period to disable locking for in milliseconds.
administrator
operator
public void resetDestination(
java.lang.String identifier
)
Resets a corrupt destination such that on restart, it is deleted and recreated. This permanently deletes all the messages (they cannot be moved to the exception destination). Calling this operation on a destination which is not corrupt will have no effect. It is suggested that this operation should be used with caution, and possibly on the direction of IBM Service personnel.
identifier
-
The name, or identifier, of the destination
administrator
operator
Notification Detail |
---|
An ME is being started. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## start.type (which may be start.type.warm or start.type.flush)
6
(Normal, Cleared, or Informative)
An ME is being stopped. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## stop.reason (which may be stop.reason.administrator.immediate or stop.reason.administrator.force)
6
(Normal, Cleared, or Informative)
The ME could not authenticate a user. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## operation (which may be operation.connect only), security.userid (the user identifier attempting the connection), security.reason (which may be security.reason.not.authenticated or security.reason.no.userid)
4
(Minor, Marginal, or Error)
The ME denied a user authorization to access a resource. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## operation (which may be operation.send, operation.receive, operation.browse, operation.create, operation.identity.adoption or operation.connect), security.userid (the user identifier attempting the connection), security.reason (which may be security.reason.not.authorized only), security.resource.type (which may be security.resource.type.destination or security.resource.type.bus), security.resource.name (the name of the bus or destination)
4
(Minor, Marginal, or Error)
An intra-bus ME to ME connection has been started. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## remote.messaging.engine.name, remote.messaging.engine.uuid
6
(Normal, Cleared, or Informative)
An intra-bus ME to ME connection has been stopped. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## remote.messaging.engine.name, remote.messaging.engine.uuid, stop.reason (which may be communications.terminated or local.me.shutdown)
6
(Normal, Cleared, or Informative)
The ME exceptioned a message that could not be delivered to the intended destination. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## exception.destination.name, exception.destination.UUID, intended.destination.name, intended.destination.UUID, system.message.identifier (The system id that identifies the message), message.exception.reason (The Exception reason as stored in the Message)
4
(Minor, Marginal, or Error)
A remote client has connected to the ME. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## client.userid (The user identifier of the client making the connection), fap.type (which may be JFAP only), communications.address (The network address in dotted decimal form of the client. This may not be the actual address of the client, if, for example it uses a gateway.)
6
(Normal, Cleared, or Informative)
A remote client has disconnected from the ME. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## client.userid (The user identifier of the client making the connection), stop.reason (which may be communications.terminated or communications.failure)
6
(Normal, Cleared, or Informative)
An ME is being started. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## start.type (which may be start.type.warm or start.type.flush)
6
(Normal, Cleared, or Informative)
An ME is being stopped. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## stop.reason (which may be stop.reason.administrator.immediate or stop.reason.administrator.force)
6
(Normal, Cleared, or Informative)
An ME start or stop has failed. This type of event has the following set of properties ##STANDARD## this.bus.name, this.bus.uuid, this.messaging.engine.name, this.messaging.engine.uuid ##SPECIFIC## fail.operation (which may be SIB.messaging.engine.start or SIB.messaging.engine.stop), fail.operation.type (which may be start.type.warm, start.type.flush, stop.reason.administrator.immediate or stop.reason.administrator.force)
6
(Normal, Cleared, or Informative)