SIBMediationPoint MBean

All Parent MBeans:
SIBMessagePoint

Partial ObjectName:
WebSphere:*,type=SIBMediationPoint


MBean SIBMediationPoint

Management interface for a SIBMediationPoint


Attribute Summary
java.lang.StringcurrentState
           The current, effective, state of the MediationPoint
java.lang.Longdepth
           The number of messages queued on this MediationPoint
java.lang.StringmediationName
           The name of the mediation associated with this MediationPoint

Attributes inherited from MBean SIBMessagePoint
id, identifier, highMessageThreshold, sendAllowed

Operation Summary
voidstop()
           Stop the MediationPoint
java.lang.StringgetReason()
           Get the reason why the mediation is the current state
java.lang.StringgetReason(java.util.Locale locale)
           Get the reason why the mediation is the current state
voidstart()
           Start the MediationPoint
com.ibm.websphere.sib.admin.SIBQueuedMessage[]getQueuedMessages()
           List information on all messages localized to this MediationPoint
com.ibm.websphere.sib.admin.SIBQueuedMessagegetQueuedMessage(java.lang.String messageId)
           Get information on a specific message on this MediationPoint
com.ibm.websphere.sib.admin.SIBQueuedMessageDetailgetQueuedMessageDetail(java.lang.String messageId)
           Get detailed information on a specific message on this MediationPoint
com.ibm.websphere.sib.admin.SIBQueuedMessageDetailgetQueuedMessageDetail(java.lang.String messageId, java.util.Locale locale)
           Get detailed information on a specific message on this QueuePoint
byte[]getMessageData(java.lang.String messageId, java.lang.Integer size)
           Return data from a specific message on a specific Mediation Point
voiddeleteQueuedMessage(java.lang.String messageId, java.lang.Boolean move)
           Delete a specific message on this QueuePoint

Notification Summary
SIB.mediation.new.state
           The Mediation Point has changed to a new state.

Notifications inherited from MBean SIBMessagePoint
SIB.messagepoint.send.allowed.state, SIB.messagepoint.receive.allowed.state, SIB.messagepoint.depth.threshold.reached

Attribute Detail

currentState

public java.lang.String currentState
The current, effective, state of the MediationPoint
Since:
6.0
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

depth

public java.lang.Long depth
The number of messages queued on this MediationPoint
Since:
6.0.2
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

mediationName

public java.lang.String mediationName
The name of the mediation associated with this MediationPoint
Since:
6.1
Security Roles:
Getter:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

Operation Detail

stop

public void stop()
Stop the MediationPoint
Security Roles:
administrator
operator

getReason

public java.lang.String getReason()
Get the reason why the mediation is the current state
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getReason

public java.lang.String getReason(java.util.Locale locale)
Get the reason why the mediation is the current state
Parameters:
locale - The locale in which the reason string should be returned
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

start

public void start()
Start the MediationPoint
Security Roles:
administrator
operator

getQueuedMessages

public com.ibm.websphere.sib.admin.SIBQueuedMessage[] getQueuedMessages()
List information on all messages localized to this MediationPoint
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getQueuedMessage

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

getQueuedMessageDetail

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

getQueuedMessageDetail

public com.ibm.websphere.sib.admin.SIBQueuedMessageDetail getQueuedMessageDetail(java.lang.String messageId, java.util.Locale locale)
Get detailed information on a specific message on this QueuePoint
Parameters:
messageId - The ID of the Message as derived from the SIBQueuedMessage class
locale - The Locale for which to return any exception messages
Since:
6.1
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getMessageData

public byte[] getMessageData(java.lang.String messageId, java.lang.Integer size)
Return data from a specific message on a specific Mediation Point
Parameters:
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

deleteQueuedMessage

public void deleteQueuedMessage(java.lang.String messageId, java.lang.Boolean move)
Delete a specific message on this QueuePoint
Parameters:
messageId - The ID of the Message as derived from the SIBQueuedMessage class
move - Whether the message should be moved to the Exception Destination rather than discarded
Security Roles:
administrator
operator

Notification Detail

SIB.mediation.new.state

The Mediation Point has changed to a new state. 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## destination.name, destination.UUID, mediation.name, mediation.state (which may be mediation.state.started, mediation.state.stopping, mediation.state.stopped, mediation.state.deleting or mediation.state.waiting), mediation.state.reason (A stop reason, if available)
Severity:
6  (Normal, Cleared, or Informative)

Copyright IBM Corp. 1996-2005