WSRMApplicationMBean MBean

Partial ObjectName:
WebSphere:*,type=WSRMApplicationMBean


MBean WSRMApplicationMBean

Management interface for a WS-ReliableMessaging enabled application


Operation Summary
java.lang.StringgetMBeanID()
           Get the ID String used to identify this MBean
com.ibm.ws.websvcs.rm.mbeans.dao.StorageManagerDetailgetStorageManagerDetails()
           Deprecated v7.
com.ibm.ws.websvcs.rm.mbeans.dao.StorageManagerDetailgetStorageManagerDetails(java.util.Locale data)
           Deprecated v7.
com.ibm.websphere.websvcs.rm.StorageManagerDetailgetStorageManagerDetail(java.util.Locale data)
           Returns information about the StorageManager being controlled in the specified locale.
java.lang.BooleanhasProblemInboundSequences()
           Returns true if there are any inbound WS-ReliableMessaging sequences that require user attention.
java.lang.BooleanhasWarningInboundSequences()
           Returns true if there are any inbound WS-ReliableMessaging sequences that might require user attention.
java.lang.BooleanhasProblemOutboundSequences()
           Returns true if there are any outbound WS-ReliableMessaging sequences that require user attention.
java.lang.BooleanhasWarningOutboundSequences()
           Returns true if there are any outbound WS-ReliableMessaging sequences that might require user attention.
java.util.CollectiongetAllProblemInboundSequences()
           Returns a collection that contains an instance of com.
java.util.CollectiongetAllWarningInboundSequences()
           Returns a collection that contains an instance of com.
java.util.CollectiongetAllProblemOutboundSequences()
           Returns a collection that contains an instance of com.
java.util.CollectiongetAllWarningOutboundSequences()
           Returns a collection that contains an instance of com.
java.util.CollectiongetAllInboundSequences()
           Returns a collection that contains an instance of com.
java.util.CollectiongetAllOutboundSequences()
           Returns a collection that contains an instance of com.
java.util.CollectiongetAllOutboundMessagesOnSequence(com.ibm.ws.websvcs.rm.mbeans.dao.OutboundSequenceData data)
           Deprecated v7.
java.util.CollectiongetAllOutboundMessagesOnSequence(com.ibm.websphere.websvcs.rm.OutboundSequenceData data)
           Returns a collection that contains an instance of com.
java.util.CollectiongetAllInboundMessagesOnSequence(com.ibm.ws.websvcs.rm.mbeans.dao.InboundSequenceData data)
           Deprecated v7.
java.util.CollectiongetAllInboundMessagesOnSequence(com.ibm.websphere.websvcs.rm.InboundSequenceData data)
           Returns a collection that contains an instance of com.
com.ibm.ws.websvcs.rm.mbeans.dao.SequenceDatarefreshSequenceData(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData data)
           Deprecated v7.
com.ibm.websphere.websvcs.rm.SequenceDatarefreshSequenceData(com.ibm.websphere.websvcs.rm.SequenceData data)
           Refreshes the data for a particular sequence.
voidreallocateMessagesOnOutboundSequence(com.ibm.ws.websvcs.rm.mbeans.dao.OutboundSequenceData data, java.lang.String newDestinationAddress)
           Deprecated v7.
voidreallocateMessagesOnOutboundSequence(com.ibm.websphere.websvcs.rm.OutboundSequenceData data, java.lang.String newDestinationAddress)
           Reallocate all messages on the outbound WS-ReliableMessaging sequence on to a different sequence.
voidforceDispatchOfMessagesOnInboundSequence(com.ibm.ws.websvcs.rm.mbeans.dao.InboundSequenceData sequenceData)
           Deprecated v7.
voidforceDispatchOfMessagesOnInboundSequence(com.ibm.websphere.websvcs.rm.InboundSequenceData sequenceData)
           Dispatch all messages on the inbound WS-ReliableMessaging sequence to the application.
byte[][]writeMessagesToDisk(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
           Deprecated - use method taking parameter com.
byte[][]writeMessagesToDisk(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
           Write all outstanding messages on the WS-ReliableMessaging sequence to bytes.
voidcloseSequence(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
           Deprecated v7.
voidcloseSequence(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
           Close the WS-ReliableMessaging sequence so that it will not accept any new messages.
voidterminateSequence(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
           Deprecated v7.
voidterminateSequence(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
           Terminate the WS-ReliableMessaging sequence.
voiddeleteMessage(com.ibm.ws.websvcs.rm.mbeans.dao.MessageData messageData)
           Deprecated v7.
voiddeleteMessage(com.ibm.websphere.websvcs.rm.MessageData messageData)
           Deletes the message from the store.
voiddeleteSequence(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
           Deprecated v7.
voiddeleteSequence(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
           Deletes all sequence data from the store without any terminate or close operations.

Operation Detail

getMBeanID

public java.lang.String getMBeanID()
Get the ID String used to identify this MBean
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getStorageManagerDetails

public com.ibm.ws.websvcs.rm.mbeans.dao.StorageManagerDetail getStorageManagerDetails()
Deprecated v7.0 - use getStorageManagerDetail.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getStorageManagerDetails

public com.ibm.ws.websvcs.rm.mbeans.dao.StorageManagerDetail getStorageManagerDetails(java.util.Locale data)
Deprecated v7.0 - use getStorageManagerDetail.
Parameters:
data - The locale to obtain data with
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getStorageManagerDetail

public com.ibm.websphere.websvcs.rm.StorageManagerDetail getStorageManagerDetail(java.util.Locale data)
Returns information about the StorageManager being controlled in the specified locale.
Parameters:
data - The locale to obtain data with
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

hasProblemInboundSequences

public java.lang.Boolean hasProblemInboundSequences()
Returns true if there are any inbound WS-ReliableMessaging sequences that require user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

hasWarningInboundSequences

public java.lang.Boolean hasWarningInboundSequences()
Returns true if there are any inbound WS-ReliableMessaging sequences that might require user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

hasProblemOutboundSequences

public java.lang.Boolean hasProblemOutboundSequences()
Returns true if there are any outbound WS-ReliableMessaging sequences that require user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

hasWarningOutboundSequences

public java.lang.Boolean hasWarningOutboundSequences()
Returns true if there are any outbound WS-ReliableMessaging sequences that might require user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllProblemInboundSequences

public java.util.Collection getAllProblemInboundSequences()
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.InboundSequenceData for each inbound WS-ReliableMessaging sequence that requires user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllWarningInboundSequences

public java.util.Collection getAllWarningInboundSequences()
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.InboundSequenceData for each inbound WS-ReliableMessaging sequence that might require user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllProblemOutboundSequences

public java.util.Collection getAllProblemOutboundSequences()
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.OutboundSequenceData for each outbound WS-ReliableMessaging sequence that requires user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllWarningOutboundSequences

public java.util.Collection getAllWarningOutboundSequences()
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.OutboundSequenceData for each outbound WS-ReliableMessaging sequence that might require user attention.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllInboundSequences

public java.util.Collection getAllInboundSequences()
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.InboundSequenceData for each inbound WS-ReliableMessaging sequence.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllOutboundSequences

public java.util.Collection getAllOutboundSequences()
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.OutboundSequenceData for each outbound WS-ReliableMessaging sequence.
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllOutboundMessagesOnSequence

public java.util.Collection getAllOutboundMessagesOnSequence(com.ibm.ws.websvcs.rm.mbeans.dao.OutboundSequenceData data)
Deprecated v7.0 - Use method taking parameter com.ibm.websphere.websvcs.rm.OutboundSequenceData.
Parameters:
data - The outbound sequence
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllOutboundMessagesOnSequence

public java.util.Collection getAllOutboundMessagesOnSequence(com.ibm.websphere.websvcs.rm.OutboundSequenceData data)
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.OutboundMessageData for each WS-ReliableMessaging message on the outbound WS-ReliableMessaging sequence.
Parameters:
data - The outbound sequence
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllInboundMessagesOnSequence

public java.util.Collection getAllInboundMessagesOnSequence(com.ibm.ws.websvcs.rm.mbeans.dao.InboundSequenceData data)
Deprecated v7.0 - Use method taking parameter com.ibm.websphere.websvcs.rm.InboundSequenceData
Parameters:
data - The inbound sequence
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

getAllInboundMessagesOnSequence

public java.util.Collection getAllInboundMessagesOnSequence(com.ibm.websphere.websvcs.rm.InboundSequenceData data)
Returns a collection that contains an instance of com.ibm.websphere.websvcs.rm.InboundMessageData for each WS-ReliableMessaging message on the inbound WS-ReliableMessaging sequence.
Parameters:
data - The inbound sequence
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

refreshSequenceData

public com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData refreshSequenceData(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData data)
Deprecated v7.0 - use method with com.ibm.websphere.websvcs.rm.SequenceData instead.
Parameters:
data - The sequence to be refreshed.
Since:
6.1
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

refreshSequenceData

public com.ibm.websphere.websvcs.rm.SequenceData refreshSequenceData(com.ibm.websphere.websvcs.rm.SequenceData data)
Refreshes the data for a particular sequence.
Parameters:
data - The sequence to be refreshed.
Since:
7.0
Security Roles:
administrator
operator
configurator
monitor
deployer
adminsecuritymanager

reallocateMessagesOnOutboundSequence

public void reallocateMessagesOnOutboundSequence(com.ibm.ws.websvcs.rm.mbeans.dao.OutboundSequenceData data, java.lang.String newDestinationAddress)
Deprecated v7.0 - use method with com.ibm.websphere.websvcs.rm.OutboundSequenceData
Parameters:
data - The sequence to be reallocated
newDestinationAddress - The new destination EPR. If null then a new sequence is created to the existing destination EPR.
Since:
6.1
Security Roles:
administrator
operator

reallocateMessagesOnOutboundSequence

public void reallocateMessagesOnOutboundSequence(com.ibm.websphere.websvcs.rm.OutboundSequenceData data, java.lang.String newDestinationAddress)
Reallocate all messages on the outbound WS-ReliableMessaging sequence on to a different sequence. NOTE: this may result in messages being delivered more than once and may break message ordering.
Parameters:
data - The sequence to be reallocated
newDestinationAddress - The new destination EPR. If null then a new sequence is created to the existing destination EPR.
Since:
7.0
Security Roles:
administrator
operator

forceDispatchOfMessagesOnInboundSequence

public void forceDispatchOfMessagesOnInboundSequence(com.ibm.ws.websvcs.rm.mbeans.dao.InboundSequenceData sequenceData)
Deprecated v7.0 - use method taking parameter com.ibm.websphere.websvcs.rm.InboundSequenceData.
Parameters:
sequenceData - The sequence whose messages should be dispatched.
Since:
6.1
Security Roles:
administrator
operator

forceDispatchOfMessagesOnInboundSequence

public void forceDispatchOfMessagesOnInboundSequence(com.ibm.websphere.websvcs.rm.InboundSequenceData sequenceData)
Dispatch all messages on the inbound WS-ReliableMessaging sequence to the application. NOTE: this may result in lost messages and may break message ordering.
Parameters:
sequenceData - The sequence whose messages should be dispatched.
Since:
7.0
Security Roles:
administrator
operator

writeMessagesToDisk

public byte[][] writeMessagesToDisk(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
Deprecated - use method taking parameter com.ibm.websphere.websvcs.rm.SequenceData
Parameters:
sequenceData - The sequence whose messages should be written to disk.
Since:
6.1
Security Roles:
administrator
operator

writeMessagesToDisk

public byte[][] writeMessagesToDisk(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
Write all outstanding messages on the WS-ReliableMessaging sequence to bytes.
Parameters:
sequenceData - The sequence whose messages should be written to disk.
Since:
7.0
Security Roles:
administrator
operator

closeSequence

public void closeSequence(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
Deprecated v7.0 use method taking com.ibm.websphere.websvcs.rm.SequenceData as parameter
Parameters:
sequenceData - The sequence to be closed.
Since:
6.1
Security Roles:
administrator
operator

closeSequence

public void closeSequence(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
Close the WS-ReliableMessaging sequence so that it will not accept any new messages.
Parameters:
sequenceData - The sequence to be closed.
Since:
7.0
Security Roles:
administrator
operator

terminateSequence

public void terminateSequence(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
Deprecated v7.0 use method taking com.ibm.websphere.websvcs.rm.SequenceData as parameter.
Parameters:
sequenceData - The sequence to be terminated.
Since:
6.1
Security Roles:
administrator
operator

terminateSequence

public void terminateSequence(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
Terminate the WS-ReliableMessaging sequence.
Parameters:
sequenceData - The sequence to be terminated.
Since:
7.0
Security Roles:
administrator
operator

deleteMessage

public void deleteMessage(com.ibm.ws.websvcs.rm.mbeans.dao.MessageData messageData)
Deprecated v7.0 use method taking com.ibm.websphere.websvcs.rm.SequenceData as parameter.
Parameters:
messageData - The message to be deleted.
Since:
6.1
Security Roles:
administrator
operator

deleteMessage

public void deleteMessage(com.ibm.websphere.websvcs.rm.MessageData messageData)
Deletes the message from the store. NOTE: may break msg ordering.
Parameters:
messageData - The message to be deleted.
Since:
7.0
Security Roles:
administrator
operator

deleteSequence

public void deleteSequence(com.ibm.ws.websvcs.rm.mbeans.dao.SequenceData sequenceData)
Deprecated v7.0 use method taking com.ibm.websphere.websvcs.rm.SequenceData as parameter
Parameters:
sequenceData - The sequence to be deleted.
Since:
6.1
Security Roles:
administrator
operator

deleteSequence

public void deleteSequence(com.ibm.websphere.websvcs.rm.SequenceData sequenceData)
Deletes all sequence data from the store without any terminate or close operations.
Parameters:
sequenceData - The sequence to be deleted.
Since:
7.0
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2005