SIBMessagingEngine MBean

All Parent MBeans:
StatisticsProvider, Stateful, EventProvider

Partial ObjectName:
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.LonggetDepth(java.lang.String id)
           Get the number of messages currently on the temporaryQueuePoint on ME
booleanisStarted()
           Returns whether the Messaging Engine is in the started state.
java.lang.Stringstate()
           Returns the state of the Messaging Engine.
java.lang.StringstateExtended()
           Returns the state of the Messaging Engine
voidstart()
           Starts a stopped or inactive Messaging Engine
voidstart(java.lang.String mode)
           Starts a stopped or inactive Messaging Engine with the specified start mode.
voidstop()
           Stops a running Messaging Engine using the default stop mode of immediate
voidstop(java.lang.String mode)
           Stops a running Messaging Engine with the specified stop mode.
com.ibm.websphere.sib.admin.SIBQueuePoint[]listQueuePoints()
           List all QueuePoints localized to this MessagingEngine
com.ibm.websphere.sib.admin.SIBQueuePointgetQueuePoint(java.lang.String id)
           Get information relating to a QueuePoint localized to this Messaging Engine
com.ibm.websphere.sib.admin.SIBQueuedMessage[]getQueuePointMessages(java.lang.String id)
           List information on all messages localized to a specific QueuePoint
com.ibm.websphere.sib.admin.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
com.ibm.websphere.sib.admin.SIBQueuedMessagegetQueuePointMessage(java.lang.String id, java.lang.String messageId)
           Get information on a specific message on a specific QueuePoint
com.ibm.websphere.sib.admin.SIBQueuedMessageDetailgetQueuePointMessageDetail(java.lang.String qpId, java.lang.String messageId)
           Get detailed information on a specific message on a specific QueuePoint
com.ibm.websphere.sib.admin.SIBQueuedMessageDetailgetQueuePointMessageDetail(java.lang.String qpId, java.lang.String messageId, java.util.Locale locale)
           Get detailed information on a specific message on a specific QueuePoint
byte[]getQueuePointMessageData(java.lang.String qpId, java.lang.String messageId, java.lang.Integer size)
           Return data from a specific message on a specific QueuePoint
com.ibm.wsspi.hamanager.GroupNamegetHAGroupName()
           Returns the GroupName of the HA Group the Messaging Engine is in.
java.lang.StringgetHealth()
           Returns the current Health of the Messaging Engine, as a String.
voidinjectFault(java.lang.String severity)
           Injects a simulated fault into the Messaging Engine, causing it to fail the next health check.
voiddump(java.lang.String dumpSpec)
           Invoke the Messaging Engine diagnostic dump
java.util.CollectiongetPreparedTransactions()
           List in-doubt transactions
voidcommitPreparedTransaction(java.lang.String xid)
           Commit the given transaction by xid
voidrollbackPreparedTransaction(java.lang.String xid)
           Rollback the given transaction by xid
voiddisableDataStoreLock(java.lang.Long period)
           This method has no effect on a messaging engine.
voidresetDestination(java.lang.String identifier)
           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

getDepth

public java.lang.Long getDepth(java.lang.String id)
Get the number of messages currently on the temporaryQueuePoint on ME
Parameters:
id - The ID of the QueuePoint derived from ME
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

isStarted

public boolean isStarted()
Returns whether the Messaging Engine is in the started state.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

state

public java.lang.String state()
Returns the state of the Messaging Engine.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

stateExtended

public java.lang.String stateExtended()
Returns the state of the Messaging Engine
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

start

public void start()
Starts a stopped or inactive Messaging Engine
Security Roles:
administrator
operator

start

public void start(java.lang.String mode)
Starts a stopped or inactive Messaging Engine with the specified start mode.
Parameters:
mode - Start mode. Valid values are 'DEFAULT' (the default) and 'FLUSH'.
Security Roles:
administrator
operator

stop

public void stop()
Stops a running Messaging Engine using the default stop mode of immediate
Security Roles:
administrator
operator

stop

public void stop(java.lang.String mode)
Stops a running Messaging Engine with the specified stop mode.
Parameters:
mode - Stop mode. Valid values are 'IMMEDIATE' (the default) and 'FORCE'.
Security Roles:
administrator
operator

listQueuePoints

public com.ibm.websphere.sib.admin.SIBQueuePoint[] listQueuePoints()
List all QueuePoints localized to this MessagingEngine
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuePoint

public com.ibm.websphere.sib.admin.SIBQueuePoint getQueuePoint(java.lang.String id)
Get information relating to a QueuePoint localized to this Messaging Engine
Parameters:
id - The ID of the QueuePoint as derived from the SIBQueuePoint class
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuePointMessages

public com.ibm.websphere.sib.admin.SIBQueuedMessage[] getQueuePointMessages(java.lang.String id)
List information on all messages localized to a specific QueuePoint
Parameters:
id - The ID of the QueuePoint as derived from the SIBQueuePoint class
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuePointMessages

public com.ibm.websphere.sib.admin.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
Parameters:
id - The ID of the QueuePoint as derived from the SIBQueuePoint class
toIndex - fromIndex
fromIndex - toIndex
totalMessagesPerPage - totalMessagesPerPage
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuePointMessage

public com.ibm.websphere.sib.admin.SIBQueuedMessage getQueuePointMessage(java.lang.String id, java.lang.String messageId)
Get information on a specific message on a specific QueuePoint
Parameters:
id - The ID of the QueuePoint as derived from the SIBQueuePoint class
messageId - The ID of the Message as derived from the SIBQueuedMessage class
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuePointMessageDetail

public com.ibm.websphere.sib.admin.SIBQueuedMessageDetail getQueuePointMessageDetail(java.lang.String qpId, java.lang.String messageId)
Get detailed information on a specific message on a specific QueuePoint
Parameters:
qpId - The ID of the QueuePoint as derived from the SIBQueuePoint class
messageId - The ID of the Message as derived from the SIBQueuedMessage class
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuePointMessageDetail

public com.ibm.websphere.sib.admin.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
Parameters:
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
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuePointMessageData

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
Parameters:
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
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getHAGroupName

public com.ibm.wsspi.hamanager.GroupName getHAGroupName()
Returns the GroupName of the HA Group the Messaging Engine is in.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getHealth

public java.lang.String getHealth()
Returns the current Health of the Messaging Engine, as a String.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

injectFault

public void injectFault(java.lang.String severity)
Injects a simulated fault into the Messaging Engine, causing it to fail the next health check.
Parameters:
severity - Error severity (LocalError or GlobalError)
Security Roles:
administrator
operator

dump

public void dump(java.lang.String dumpSpec)
Invoke the Messaging Engine diagnostic dump
Parameters:
dumpSpec - The dump specification string
Security Roles:
administrator
operator

getPreparedTransactions

public java.util.Collection getPreparedTransactions()
List in-doubt transactions
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

commitPreparedTransaction

public void commitPreparedTransaction(java.lang.String xid)
Commit the given transaction by xid
Parameters:
xid - The xid of the transaction
Security Roles:
administrator
operator

rollbackPreparedTransaction

public void rollbackPreparedTransaction(java.lang.String xid)
Rollback the given transaction by xid
Parameters:
xid - The xid of the transaction
Security Roles:
administrator
operator

disableDataStoreLock

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.
Parameters:
period - The time period to disable locking for in milliseconds.
Security Roles:
administrator
operator

resetDestination

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.
Parameters:
identifier - The name, or identifier, of the destination
Security Roles:
administrator
operator

Notification Detail

SIB.messaging.engine.start

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)
Severity:
6  (Normal, Cleared, or Informative)

SIB.messaging.engine.stop

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)
Severity:
6  (Normal, Cleared, or Informative)

SIB.security.not.authenticated

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)
Severity:
4  (Minor, Marginal, or Error)

SIB.security.not.authorized

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)
Severity:
4  (Minor, Marginal, or Error)

SIB.communications.connection.start

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
Severity:
6  (Normal, Cleared, or Informative)

SIB.communications.connection.stop

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)
Severity:
6  (Normal, Cleared, or Informative)

SIB.message.exceptioned

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)
Severity:
4  (Minor, Marginal, or Error)

SIB.client.connection.start

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.)
Severity:
6  (Normal, Cleared, or Informative)

SIB.client.connection.stop

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)
Severity:
6  (Normal, Cleared, or Informative)

SIB.messaging.engine.starting

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)
Severity:
6  (Normal, Cleared, or Informative)

SIB.messaging.engine.stopping

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)
Severity:
6  (Normal, Cleared, or Informative)

SIB.messaging.engine.failed

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)
Severity:
6  (Normal, Cleared, or Informative)

Copyright IBM Corp. 1996-2005