IBrokerProxy (Management Application API)

Overview

Package

Class

Tree

Index

Help

Sonic Management API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sonicsw.mq.mgmtapi.runtime
Interface IBrokerProxy

public interface IBrokerProxy

Remote interface to a runtime instance of a Broker.

Management attributes and operations are documented in this interface.

An implementation of this interface can be created using the MQProxyFactory class. Each implementation instance is valid for the life of the provided JMS/JMX Connector and MBean ObjectName. The implementation is built using remote JMX MBeanServer calls.

For each JMX MBean attribute, this interface provides an associated get method (for readable attributes) and/or a set method (for writable attributes).

For each JMX MBean operation, this interface provides an associated method with a signature as described by the MBean's operation meta-data. Each JMX MBean operation has an associated impact:

ACTION - Indicates that the operation is a write-like, and would modify the MBean in some way, typically by writing some value or changing a configuration.
INFO - Indicates that the operation is read-like, it basically returns information.
ACTION/INFO - Indicates that the operation is both read-like and write-like.
UNKNOWN - Indicates that the operation has an "unknown" nature.

All exceptions emitted by implementations are wrapped as a ProxyRuntimeException.

See Also:: Broker Notifications, Broker Metrics

Field Summary
`static java.lang.String`	`APPLICATION_ALERT_BROKER_BYTES_TOPICDBSIZE_NOTIFICATION_ID` Notification type constant for the notification application.alert.broker.bytes.TopicDBSize.
`static java.lang.String`	`APPLICATION_ALERT_BROKER_CONNECTIONS_REJECTEDPERMINUTE_NOTIFICATION_ID` Notification type constant for the notification application.alert.broker.connections.RejectedPerMinute.
`static java.lang.String`	`APPLICATION_ALERT_CONNECTION_BYTES_DELIVEREDPERSECOND_NOTIFICATION_ID` Notification type constant for the notification application.alert.connection.bytes.DeliveredPerSecond.
`static java.lang.String`	`APPLICATION_ALERT_CONNECTION_BYTES_RECEIVEDPERSECOND_NOTIFICATION_ID` Notification type constant for the notification application.alert.connection.bytes.ReceivedPerSecond.
`static java.lang.String`	`APPLICATION_ALERT_CONNECTION_MESSAGES_DELIVEREDPERSECOND_NOTIFICATION_ID` Notification type constant for the notification application.alert.connection.messages.DeliveredPerSecond.
`static java.lang.String`	`APPLICATION_ALERT_CONNECTION_MESSAGES_RECEIVEDPERSECOND_NOTIFICATION_ID` Notification type constant for the notification application.alert.connection.messages.ReceivedPerSecond.
`static java.lang.String`	`APPLICATION_ALERT_QUEUE_MESSAGES_COUNT_NOTIFICATION_ID` Notification type constant for the notification application.alert.queue.messages.Count.
`static java.lang.String`	`APPLICATION_ALERT_QUEUE_MESSAGES_SIZE_NOTIFICATION_ID` Notification type constant for the notification application.alert.queue.messages.Size.
`static java.lang.String`	`APPLICATION_CONNECTION_CONNECT_NOTIFICATION_ID` Notification type constant for the notification application.connection.Connect.
`static java.lang.String`	`APPLICATION_CONNECTION_DISCONNECT_NOTIFICATION_ID` Notification type constant for the notification application.connection.Disconnect.
`static java.lang.String`	`APPLICATION_CONNECTION_DROP_NOTIFICATION_ID` Notification type constant for the notification application.connection.Drop.
`static java.lang.String`	`APPLICATION_CONNECTION_RECONNECT_NOTIFICATION_ID` Notification type constant for the notification application.connection.Reconnect.
`static java.lang.String`	`APPLICATION_CONNECTION_REDIRECT_NOTIFICATION_ID` Notification type constant for the notification application.connection.Redirect.
`static java.lang.String`	`APPLICATION_CONNECTION_REJECT_NOTIFICATION_ID` Notification type constant for the notification application.connection.Reject.
`static java.lang.String`	`APPLICATION_CONNECTION_REPLICATIONCONNECT_NOTIFICATION_ID` Notification type constant for the notification application.connection.ReplicationConnect.
`static java.lang.String`	`APPLICATION_CONNECTION_REPLICATIONDISCONNECT_NOTIFICATION_ID` Notification type constant for the notification application.connection.ReplicationDisconnect.
`static java.lang.String`	`APPLICATION_CONNECTION_REPLICATIONRETRY_NOTIFICATION_ID` Notification type constant for the notification application.connection.ReplicationRetry.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONPAUSE_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.ClusterConnectionPause.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONRESUME_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.ClusterConnectionResume.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_ENDFLOWTODISK_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.EndFlowToDisk.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_PUBPAUSE_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.PubPause.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_PUBRESUME_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.PubResume.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_RMREORDERBUFFERAVAILABLE_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.RMReorderBufferAvailable.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_RMREORDERBUFFERFULL_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.RMReorderBufferFull.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_SENDPAUSE_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.SendPause.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_SENDRESUME_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.SendResume.
`static java.lang.String`	`APPLICATION_FLOWCONTROL_STARTFLOWTODISK_NOTIFICATION_ID` Notification type constant for the notification application.flowcontrol.StartFlowToDisk.
`static java.lang.String`	`APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIBEFAILURE_NOTIFICATION_ID` Notification type constant for the notification application.globalSubscriptions.SubscribeFailure.
`static java.lang.String`	`APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONDELETED_NOTIFICATION_ID` Notification type constant for the notification application.globalSubscriptions.SubscriptionDeleted.
`static java.lang.String`	`APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONEXPIRED_NOTIFICATION_ID` Notification type constant for the notification application.globalSubscriptions.SubscriptionExpired.
`static java.lang.String`	`APPLICATION_MESSAGE_UNDELIVERED_NOTIFICATION_ID` Notification type constant for the notification application.message.Undelivered.
`static java.lang.String`	`APPLICATION_SESSION_ACKNOWLEDGEMENTPAUSE_NOTIFICATION_ID` Notification type constant for the notification application.session.AcknowledgementPause.
`static java.lang.String`	`APPLICATION_SESSION_ENDRECEIVE_NOTIFICATION_ID` Notification type constant for the notification application.session.EndReceive.
`static java.lang.String`	`APPLICATION_SESSION_STARTRECEIVE_NOTIFICATION_ID` Notification type constant for the notification application.session.StartReceive.
`static java.lang.String`	`APPLICATION_SESSION_SUBSCRIBE_NOTIFICATION_ID` Notification type constant for the notification application.session.Subscribe.
`static java.lang.String`	`APPLICATION_SESSION_SUBSCRIBERPAUSE_NOTIFICATION_ID` Notification type constant for the notification application.session.SubscriberPause.
`static java.lang.String`	`APPLICATION_SESSION_SUBSCRIBERRESUME_NOTIFICATION_ID` Notification type constant for the notification application.session.SubscriberResume.
`static java.lang.String`	`APPLICATION_SESSION_SUBSCRIPTIONMESSAGESTRIMMEDFROMDB_NOTIFICATION_ID` Notification type constant for the notification application.session.SubscriptionMessagesTrimmedFromDB.
`static java.lang.String`	`APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCANCELLED_NOTIFICATION_ID` Notification type constant for the notification application.session.SubscriptionTrimInvocationCancelled.
`static java.lang.String`	`APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCOMPLETED_NOTIFICATION_ID` Notification type constant for the notification application.session.SubscriptionTrimInvocationCompleted.
`static java.lang.String`	`APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONINITIATED_NOTIFICATION_ID` Notification type constant for the notification application.session.SubscriptionTrimInvocationInitiated.
`static java.lang.String`	`APPLICATION_SESSION_UNSUBSCRIBE_NOTIFICATION_ID` Notification type constant for the notification application.session.Unsubscribe.
`static java.lang.String`	`APPLICATION_STATE_ACCEPTORSTATUS_NOTIFICATION_ID` Notification type constant for the notification application.state.AcceptorStatus.
`static java.lang.String`	`APPLICATION_STATE_DBCOMPACT_NOTIFICATION_ID` Notification type constant for the notification application.state.DbCompact.
`static java.lang.String`	`APPLICATION_STATE_DMQCAPACITY_NOTIFICATION_ID` Notification type constant for the notification application.state.DmqCapacity.
`static java.lang.String`	`APPLICATION_STATE_LOGCAPACITY_NOTIFICATION_ID` Notification type constant for the notification application.state.LogCapacity.
`static java.lang.String`	`APPLICATION_STATE_PRIMARYACCEPTORSTATUS_NOTIFICATION_ID` Notification type constant for the notification application.state.PrimaryAcceptorStatus.
`static java.lang.String`	`APPLICATION_STATE_REPLICATIONACTIVATE_NOTIFICATION_ID` Notification type constant for the notification application.state.ReplicationActivate.
`static java.lang.String`	`APPLICATION_STATE_REPLICATIONCHANNELSWITCH_NOTIFICATION_ID` Notification type constant for the notification application.state.ReplicationChannelSwitch.
`static java.lang.String`	`APPLICATION_STATE_REPLICATIONSTATECHANGE_NOTIFICATION_ID` Notification type constant for the notification application.state.ReplicationStateChange.
`static IMetricIdentity`	`BROKER_BYTES_DELIVEREDPERSECOND_METRIC_ID` Metric identity constant for the metric broker.bytes.DeliveredPerSecond.
`static IMetricIdentity`	`BROKER_BYTES_RECEIVEDPERSECOND_METRIC_ID` Metric identity constant for the metric broker.bytes.ReceivedPerSecond.
`static IMetricIdentity`	`BROKER_BYTES_TOPICDBSIZE_METRIC_ID` Metric identity constant for the metric broker.bytes.TopicDBSize.
`static IMetricIdentity`	`BROKER_CONNECTIONS_COUNT_METRIC_ID` Metric identity constant for the metric broker.connections.Count.
`static IMetricIdentity`	`BROKER_CONNECTIONS_REJECTEDPERMINUTE_METRIC_ID` Metric identity constant for the metric broker.connections.RejectedPerMinute.
`static IMetricIdentity`	`BROKER_MESSAGES_DELIVERED_METRIC_ID` Metric identity constant for the metric broker.messages.Delivered.
`static IMetricIdentity`	`BROKER_MESSAGES_DELIVEREDPERSECOND_METRIC_ID` Metric identity constant for the metric broker.messages.DeliveredPerSecond.
`static IMetricIdentity`	`BROKER_MESSAGES_RECEIVED_METRIC_ID` Metric identity constant for the metric broker.messages.Received.
`static IMetricIdentity`	`BROKER_MESSAGES_RECEIVEDPERSECOND_METRIC_ID` Metric identity constant for the metric broker.messages.ReceivedPerSecond.
`static IMetricIdentity`	`CONNECTION_BYTES_DELIVERED_METRIC_ID` Parent metric identity constant for the instance metric connection.bytes.Delivered.
`static IMetricIdentity`	`CONNECTION_BYTES_DELIVEREDPERSECOND_METRIC_ID` Parent metric identity constant for the instance metric connection.bytes.DeliveredPerSecond.
`static IMetricIdentity`	`CONNECTION_BYTES_RECEIVED_METRIC_ID` Parent metric identity constant for the instance metric connection.bytes.Received.
`static IMetricIdentity`	`CONNECTION_BYTES_RECEIVEDPERSECOND_METRIC_ID` Parent metric identity constant for the instance metric connection.bytes.ReceivedPerSecond.
`static IMetricIdentity`	`CONNECTION_MESSAGES_DELIVERED_METRIC_ID` Parent metric identity constant for the instance metric connection.messages.Delivered.
`static IMetricIdentity`	`CONNECTION_MESSAGES_DELIVEREDPERSECOND_METRIC_ID` Parent metric identity constant for the instance metric connection.messages.DeliveredPerSecond.
`static IMetricIdentity`	`CONNECTION_MESSAGES_RECEIVED_METRIC_ID` Parent metric identity constant for the instance metric connection.messages.Received.
`static IMetricIdentity`	`CONNECTION_MESSAGES_RECEIVEDPERSECOND_METRIC_ID` Parent metric identity constant for the instance metric connection.messages.ReceivedPerSecond.
`static IMetricIdentity`	`QUEUE_MESSAGES_COUNT_METRIC_ID` Parent metric identity constant for the instance metric queue.messages.Count.
`static IMetricIdentity`	`QUEUE_MESSAGES_DELIVEREDPERSECOND_METRIC_ID` Parent metric identity constant for the instance metric queue.messages.DeliveredPerSecond.
`static IMetricIdentity`	`QUEUE_MESSAGES_MAXDEPTH_METRIC_ID` Parent metric identity constant for the instance metric queue.messages.MaxDepth.
`static IMetricIdentity`	`QUEUE_MESSAGES_RECEIVEDPERSECOND_METRIC_ID` Parent metric identity constant for the instance metric queue.messages.ReceivedPerSecond.
`static IMetricIdentity`	`QUEUE_MESSAGES_SIZE_METRIC_ID` Parent metric identity constant for the instance metric queue.messages.Size.
`static java.lang.String`	`SYSTEM_STATE_OFFLINE_NOTIFICATION_ID` Notification type constant for the notification system.state.Offline.
`static java.lang.String`	`SYSTEM_STATE_ONLINE_NOTIFICATION_ID` Notification type constant for the notification system.state.Online.

Method Summary
`void`	`activateWaitingBroker()` Invokes the activateWaitingBroker operation.
`void`	`addNotificationListener(NotificationListener listener, NotificationFilter filter, java.lang.Object handback)` Adds a notification listener.
`void`	`cancelReliableSequences(java.util.ArrayList ids)` Invokes the cancelReliableSequences operation.
`void`	`clearDuplicateDetectionData()` Invokes the clearDuplicateDetectionData operation.
`void`	`clearError()` Invokes the clearError operation.
`void`	`closeBrowser(IBrowseToken token)` Invokes the closeBrowser operation.
`void`	`commitPreparedXABranches(java.lang.Integer[] tIDs)` Invokes the commitPreparedXABranches operation.
`IBrowseToken`	`createDurableBrowseToken(java.lang.String userId, java.lang.String jmsClientId, java.lang.String uniqueName, java.lang.Boolean isConnectionConsumer, java.lang.Boolean local)` Invokes the createDurableBrowseToken operation.
`IBrowseToken`	`createDurableBrowseTokenFromDSD(IDurableSubscriptionData dsd, java.lang.Boolean isLocal)` Invokes the createDurableBrowseTokenFromDSD operation.
`IMessageHeaderToken`	`createDurableMessageHeaderToken(java.lang.String userId, java.lang.String jmsClientId, java.lang.String uniqueName, java.lang.Boolean isConnectionConsumer, java.lang.String messageId)` Invokes the createDurableMessageHeaderToken operation.
`IMessageHeaderToken`	`createDurableMessageHeaderTokenDSD(IDurableSubscriptionData dsd, java.lang.String messageId)` Invokes the createDurableMessageHeaderTokenDSD operation.
`void`	`deleteDurableSubscriptions(java.lang.String user, java.util.ArrayList subscriptions)` Invokes the deleteDurableSubscriptions operation.
`void`	`deleteGlobalQueueAdvertisements(java.util.ArrayList advertisements)` Invokes the deleteGlobalQueueAdvertisements operation.
`void`	`deleteQueueMessages(java.util.ArrayList queues)` Invokes the deleteQueueMessages operation.
`void`	`deleteRemoteSubscriptions(java.util.ArrayList remoteNodes)` Invokes the deleteRemoteSubscriptions operation.
`void`	`disableAlerts(IAlert[] alerts)` Invokes the disableAlerts operation.
`void`	`disableMetrics(IMetricIdentity[] ids)` Invokes the disableMetrics operation.
`void`	`dropConnections(java.util.ArrayList connections)` Invokes the dropConnections operation.
`void`	`enableAlerts(IAlert[] alerts)` Invokes the enableAlerts operation.
`void`	`enableMetrics(IMetricIdentity[] ids)` Invokes the enableMetrics operation.
`void`	`forceCRLUpdate(java.lang.String distributionPoint)` Invokes the forceCRLUpdate operation.
`IMetricIdentity[]`	`getActiveMetrics(IMetricIdentity[] ids)` Invokes the getActiveMetrics operation.
`AttributeList`	`getAttributes(java.lang.String[] attributeNames)` Gets the values of several attributes of a Broker component.
`java.lang.String`	`getBrokerName()` Gets the value of the BrokerName attribute.
`java.util.ArrayList`	`getBrowseMessages(IBrowseToken ibt, java.lang.Integer maxMessages)` Invokes the getBrowseMessages operation.
`java.lang.String`	`getClassname()` Gets the value of the Classname attribute.
`java.lang.String`	`getClasspath()` Gets the value of the Classpath attribute.
`java.lang.String`	`getClusterName()` Gets the value of the ClusterName attribute.
`java.lang.String`	`getConfigID()` Gets the value of the ConfigID attribute.
`java.util.ArrayList`	`getConnectionMemberDetails(java.util.ArrayList refs)` Invokes the getConnectionMemberDetails operation.
`IConnectionMemberDetails`	`getConnectionMemberDetails(java.lang.Long ref)` Invokes the getConnectionMemberDetails operation.
`java.util.ArrayList`	`getConnections(java.lang.String prefix)` Invokes the getConnections operation.
`java.util.ArrayList`	`getConnectionTree(java.util.ArrayList nodes, java.lang.Integer depth)` Invokes the getConnectionTree operation.
`java.lang.String[]`	`getCRLList()` Invokes the getCRLList operation.
`java.lang.Integer`	`getDBCompactState()` Gets the value of the DBCompactState attribute.
`java.lang.String`	`getDBCompactStateString()` Gets the value of the DBCompactStateString attribute.
`java.util.ArrayList`	`getDurableSubscriptions(java.lang.String user)` Invokes the getDurableSubscriptions operation.
`IAlert[]`	`getEnabledAlerts(IMetricIdentity[] ids)` Invokes the getEnabledAlerts operation.
`IMetricIdentity[]`	`getEnabledMetrics(IMetricIdentity[] ids)` Invokes the getEnabledMetrics operation.
`java.lang.String[]`	`getExternalUsers(java.lang.String prefix)` Invokes the getExternalUsers operation.
`java.util.ArrayList`	`getGlobalQueueAdvertisements(java.lang.String prefix)` Invokes the getGlobalQueueAdvertisements operation.
`java.lang.String[]`	`getInstanceMetricNames(IMetricIdentity id)` Invokes the getInstanceMetricNames operation.
`java.lang.String`	`getLastError()` Gets the value of the LastError attribute.
`java.lang.Integer`	`getLastErrorLevel()` Gets the value of the LastErrorLevel attribute.
`java.lang.String`	`getLastErrorLevelString()` Gets the value of the LastErrorLevelString attribute.
`IMessage`	`getMessage(IMessageHeaderToken ht)` Invokes the getMessage operation.
`java.lang.Integer`	`getMetricsCollectionInterval()` Gets the value of the MetricsCollectionInterval attribute.
`IMetricsData`	`getMetricsData(IMetricIdentity[] ids, java.lang.Boolean returnTriggeredAlerts)` Invokes the getMetricsData operation.
`IMetricInfo[]`	`getMetricsInfo()` Invokes the getMetricsInfo operation.
`java.lang.Integer`	`getMetricsRefreshInterval()` Gets the value of the MetricsRefreshInterval attribute.
`java.util.ArrayList`	`getPreparedXABranches()` Invokes the getPreparedXABranches operation.
`java.util.ArrayList`	`getQueues(java.lang.String prefix)` Invokes the getQueues operation.
`java.lang.String`	`getReleaseVersion()` Gets the value of the ReleaseVersion attribute.
`java.util.ArrayList`	`getReliableReceiveSequences()` Invokes the getReliableReceiveSequences operation.
`java.util.ArrayList`	`getReliableSendSequences()` Invokes the getReliableSendSequences operation.
`java.util.ArrayList`	`getRemoteSubscriptionSummary(java.lang.String nodePattern)` Invokes the getRemoteSubscriptionSummary operation.
`java.util.ArrayList`	`getRemoteSubscriptionSummary(java.lang.String nodePattern, java.lang.Boolean getAllNodes)` Invokes the getRemoteSubscriptionSummary operation.
`java.util.ArrayList`	`getRemoteSubscriptionTopics(java.lang.String node, java.lang.String topicPattern)` Invokes the getRemoteSubscriptionTopics operation.
`java.lang.String[]`	`getReplicationConnections()` Invokes the getReplicationConnections operation.
`java.lang.Integer`	`getReplicationConnectionState(java.lang.String name)` Invokes the getReplicationConnectionState operation.
`java.lang.String`	`getReplicationConnectionStateString(java.lang.String name)` Invokes the getReplicationConnectionStateString operation.
`java.lang.Integer`	`getReplicationState()` Gets the value of the ReplicationState attribute.
`java.lang.String`	`getReplicationStateString()` Gets the value of the ReplicationStateString attribute.
`java.lang.String`	`getReplicationType()` Gets the value of the ReplicationType attribute.
`java.lang.String`	`getRoutingNodeName()` Gets the value of the RoutingNodeName attribute.
`java.util.ArrayList`	`getRoutingStatistics(java.lang.String prefix)` Invokes the getRoutingStatistics operation.
`java.lang.Boolean`	`getSecurityEnabled()` Gets the value of the SecurityEnabled attribute.
`java.lang.Short`	`getState()` Gets the value of the State attribute.
`java.lang.String`	`getStateString()` Gets the value of the StateString attribute.
`java.util.ArrayList`	`getSubscribers(java.util.ArrayList refs)` Invokes the getSubscribers operation.
`java.util.ArrayList`	`getSubscribers(java.lang.Long ref)` Invokes the getSubscribers operation.
`java.util.ArrayList`	`getSubscribers(java.lang.String connectId, java.lang.String userId)` Invokes the getSubscribers operation.
`java.lang.Integer`	`getTraceMask()` Gets the value of the TraceMask attribute.
`java.lang.String`	`getTraceMaskValues()` Gets the value of the TraceMaskValues attribute.
`java.lang.Long`	`getUptime()` Gets the value of the Uptime attribute.
`java.util.ArrayList`	`getUsersWithDurableSubscriptions(java.lang.String prefix)` Invokes the getUsersWithDurableSubscriptions operation.
`void`	`initDuplicateDetectionStore(java.lang.Short action)` Invokes the initDuplicateDetectionStore operation.
`void`	`initMessageStore(java.lang.Short action)` Invokes the initMessageStore operation.
`void`	`reconcileRemoteSubscriptions(java.util.ArrayList remoteNodes)` Invokes the reconcileRemoteSubscriptions operation.
`java.lang.Boolean`	`refreshSecurity(java.lang.String prefix)` Invokes the refreshSecurity operation.
`void`	`reload()` Invokes the reload operation.
`void`	`removeMessage(IMessageHeaderToken ht)` Invokes the removeMessage operation.
`void`	`removeNotificationListener(NotificationListener listener)` Removes a notification listener.
`void`	`resetMetrics()` Invokes the resetMetrics operation.
`void`	`rollbackPreparedXABranches(java.lang.Integer[] tids)` Invokes the rollbackPreparedXABranches operation.
`IMessageHeader`	`searchMessage(IMessageHeaderToken ht)` Invokes the searchMessage operation.
`AttributeList`	`setAttributes(AttributeList attributes)` Sets the values of several attributes of a Broker component.
`void`	`setBrowseInactiveTimeout(IBrowseToken bt, java.lang.Integer timeout)` Invokes the setBrowseInactiveTimeout operation.
`void`	`setMetricsCollectionInterval(java.lang.Integer value)` Sets the value of the MetricsCollectionInterval attribute.
`void`	`setMetricsRefreshInterval(java.lang.Integer value)` Sets the value of the MetricsRefreshInterval attribute.
`void`	`setTraceMask(java.lang.Integer value)` Sets the value of the TraceMask attribute.
`void`	`start()` Invokes the start operation.
`void`	`startDBCompact()` Invokes the startDBCompact operation.
`void`	`startDBCompactWorkdir(java.lang.String workdir)` Invokes the startDBCompactWorkdir operation.
`void`	`stop()` Invokes the stop operation.
`void`	`stopDBCompact()` Invokes the stopDBCompact operation.
`void`	`syncMessageStore(java.lang.String sourceWorkingDir)` Invokes the syncMessageStore operation.
`void`	`trimMessages(IBrowseToken ibt, java.lang.Long dateTime)` Invokes the trimMessages operation.

Field Detail

APPLICATION_ALERT_BROKER_BYTES_TOPICDBSIZE_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_BROKER_BYTES_TOPICDBSIZE_NOTIFICATION_ID

Notification type constant for the notification application.alert.broker.bytes.TopicDBSize.

Description: Alert for metric broker.bytes.TopicDBSize

See Also:: application.alert.broker.bytes.TopicDBSize

See Also:: Constant Field Values

APPLICATION_ALERT_BROKER_CONNECTIONS_REJECTEDPERMINUTE_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_BROKER_CONNECTIONS_REJECTEDPERMINUTE_NOTIFICATION_ID

Notification type constant for the notification application.alert.broker.connections.RejectedPerMinute.

Description: Alert for metric broker.connections.RejectedPerMinute

See Also:: application.alert.broker.connections.RejectedPerMinute

See Also:: Constant Field Values

APPLICATION_ALERT_CONNECTION_BYTES_DELIVEREDPERSECOND_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_CONNECTION_BYTES_DELIVEREDPERSECOND_NOTIFICATION_ID

Notification type constant for the notification application.alert.connection.bytes.DeliveredPerSecond.

Description: Alert for metric connection.bytes.DeliveredPerSecond

See Also:: application.alert.connection.bytes.DeliveredPerSecond

See Also:: Constant Field Values

APPLICATION_ALERT_CONNECTION_BYTES_RECEIVEDPERSECOND_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_CONNECTION_BYTES_RECEIVEDPERSECOND_NOTIFICATION_ID

Notification type constant for the notification application.alert.connection.bytes.ReceivedPerSecond.

Description: Alert for metric connection.bytes.ReceivedPerSecond

See Also:: application.alert.connection.bytes.ReceivedPerSecond

See Also:: Constant Field Values

APPLICATION_ALERT_CONNECTION_MESSAGES_DELIVEREDPERSECOND_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_CONNECTION_MESSAGES_DELIVEREDPERSECOND_NOTIFICATION_ID

Notification type constant for the notification application.alert.connection.messages.DeliveredPerSecond.

Description: Alert for metric connection.messages.DeliveredPerSecond

See Also:: application.alert.connection.messages.DeliveredPerSecond

See Also:: Constant Field Values

APPLICATION_ALERT_CONNECTION_MESSAGES_RECEIVEDPERSECOND_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_CONNECTION_MESSAGES_RECEIVEDPERSECOND_NOTIFICATION_ID

Notification type constant for the notification application.alert.connection.messages.ReceivedPerSecond.

Description: Alert for metric connection.messages.ReceivedPerSecond

See Also:: application.alert.connection.messages.ReceivedPerSecond

See Also:: Constant Field Values

APPLICATION_ALERT_QUEUE_MESSAGES_COUNT_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_QUEUE_MESSAGES_COUNT_NOTIFICATION_ID

Notification type constant for the notification application.alert.queue.messages.Count.

Description: Alert for metric queue.messages.Count

See Also:: application.alert.queue.messages.Count

See Also:: Constant Field Values

APPLICATION_ALERT_QUEUE_MESSAGES_SIZE_NOTIFICATION_ID

static final java.lang.String APPLICATION_ALERT_QUEUE_MESSAGES_SIZE_NOTIFICATION_ID

Notification type constant for the notification application.alert.queue.messages.Size.

Description: Alert for metric queue.messages.Size

See Also:: application.alert.queue.messages.Size

See Also:: Constant Field Values

APPLICATION_CONNECTION_CONNECT_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_CONNECT_NOTIFICATION_ID

Notification type constant for the notification application.connection.Connect.

Description: Connection connect.

See Also:: application.connection.Connect

See Also:: Constant Field Values

APPLICATION_CONNECTION_DISCONNECT_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_DISCONNECT_NOTIFICATION_ID

Notification type constant for the notification application.connection.Disconnect.

Description: Connection disconnect.

See Also:: application.connection.Disconnect

See Also:: Constant Field Values

APPLICATION_CONNECTION_DROP_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_DROP_NOTIFICATION_ID

Notification type constant for the notification application.connection.Drop.

Description: Connection dropped/aborted.

See Also:: application.connection.Drop

See Also:: Constant Field Values

APPLICATION_CONNECTION_RECONNECT_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_RECONNECT_NOTIFICATION_ID

Notification type constant for the notification application.connection.Reconnect.

Description: Connection reconnect.

See Also:: application.connection.Reconnect

See Also:: Constant Field Values

APPLICATION_CONNECTION_REDIRECT_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_REDIRECT_NOTIFICATION_ID

Notification type constant for the notification application.connection.Redirect.

Description: Connection redirected to another broker.

See Also:: application.connection.Redirect

See Also:: Constant Field Values

APPLICATION_CONNECTION_REJECT_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_REJECT_NOTIFICATION_ID

Notification type constant for the notification application.connection.Reject.

Description: Connection attempt rejected.

See Also:: application.connection.Reject

See Also:: Constant Field Values

APPLICATION_CONNECTION_REPLICATIONCONNECT_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_REPLICATIONCONNECT_NOTIFICATION_ID

Notification type constant for the notification application.connection.ReplicationConnect.

Description: Replication connection connect.

See Also:: application.connection.ReplicationConnect

See Also:: Constant Field Values

APPLICATION_CONNECTION_REPLICATIONDISCONNECT_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_REPLICATIONDISCONNECT_NOTIFICATION_ID

Notification type constant for the notification application.connection.ReplicationDisconnect.

Description: Replication connection disconnect.

See Also:: application.connection.ReplicationDisconnect

See Also:: Constant Field Values

APPLICATION_CONNECTION_REPLICATIONRETRY_NOTIFICATION_ID

static final java.lang.String APPLICATION_CONNECTION_REPLICATIONRETRY_NOTIFICATION_ID

Notification type constant for the notification application.connection.ReplicationRetry.

Description: Replication connection retry.

See Also:: application.connection.ReplicationRetry

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONPAUSE_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONPAUSE_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.ClusterConnectionPause.

Description: Cluster connection paused due to flow control.

See Also:: application.flowcontrol.ClusterConnectionPause

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONRESUME_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONRESUME_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.ClusterConnectionResume.

Description: Cluster connection resumed due to flow control.

See Also:: application.flowcontrol.ClusterConnectionResume

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_ENDFLOWTODISK_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_ENDFLOWTODISK_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.EndFlowToDisk.

Description: Subscriber has stopped flowing messages to disk.

See Also:: application.flowcontrol.EndFlowToDisk

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_PUBPAUSE_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_PUBPAUSE_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.PubPause.

Description: Publisher paused due to flow control.

See Also:: application.flowcontrol.PubPause

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_PUBRESUME_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_PUBRESUME_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.PubResume.

Description: Publisher resumed after flow control.

See Also:: application.flowcontrol.PubResume

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_RMREORDERBUFFERAVAILABLE_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_RMREORDERBUFFERAVAILABLE_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.RMReorderBufferAvailable.

Description: Reliable Message Re-order Buffer Available.

See Also:: application.flowcontrol.RMReorderBufferAvailable

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_RMREORDERBUFFERFULL_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_RMREORDERBUFFERFULL_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.RMReorderBufferFull.

Description: Reliable Message Re-order Buffer Full.

See Also:: application.flowcontrol.RMReorderBufferFull

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_SENDPAUSE_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_SENDPAUSE_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.SendPause.

Description: Sender paused due to flow control.

See Also:: application.flowcontrol.SendPause

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_SENDRESUME_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_SENDRESUME_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.SendResume.

Description: Sender resumed after flow control.

See Also:: application.flowcontrol.SendResume

See Also:: Constant Field Values

APPLICATION_FLOWCONTROL_STARTFLOWTODISK_NOTIFICATION_ID

static final java.lang.String APPLICATION_FLOWCONTROL_STARTFLOWTODISK_NOTIFICATION_ID

Notification type constant for the notification application.flowcontrol.StartFlowToDisk.

Description: Subscriber has started flowing messages to disk.

See Also:: application.flowcontrol.StartFlowToDisk

See Also:: Constant Field Values

APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIBEFAILURE_NOTIFICATION_ID

static final java.lang.String APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIBEFAILURE_NOTIFICATION_ID

Notification type constant for the notification application.globalSubscriptions.SubscribeFailure.

Description: Subscription undelivered to requested remote node.

See Also:: application.globalSubscriptions.SubscribeFailure

See Also:: Constant Field Values

APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONDELETED_NOTIFICATION_ID

static final java.lang.String APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONDELETED_NOTIFICATION_ID

Notification type constant for the notification application.globalSubscriptions.SubscriptionDeleted.

Description: Remote subscription manually deleted.

See Also:: application.globalSubscriptions.SubscriptionDeleted

See Also:: Constant Field Values

APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONEXPIRED_NOTIFICATION_ID

static final java.lang.String APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONEXPIRED_NOTIFICATION_ID

Notification type constant for the notification application.globalSubscriptions.SubscriptionExpired.

Description: Remote subscription has expired.

See Also:: application.globalSubscriptions.SubscriptionExpired

See Also:: Constant Field Values

APPLICATION_MESSAGE_UNDELIVERED_NOTIFICATION_ID

static final java.lang.String APPLICATION_MESSAGE_UNDELIVERED_NOTIFICATION_ID

Notification type constant for the notification application.message.Undelivered.

Description: Message undelivered to requested destination.

See Also:: application.message.Undelivered

See Also:: Constant Field Values

APPLICATION_SESSION_ACKNOWLEDGEMENTPAUSE_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_ACKNOWLEDGEMENTPAUSE_NOTIFICATION_ID

Notification type constant for the notification application.session.AcknowledgementPause.

Description: Durable subscriber paused acknowledging messages (while acknowledgement monitoring is enabled).

See Also:: application.session.AcknowledgementPause

See Also:: Constant Field Values

APPLICATION_SESSION_ENDRECEIVE_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_ENDRECEIVE_NOTIFICATION_ID

Notification type constant for the notification application.session.EndReceive.

Description: Close queue receiver.

See Also:: application.session.EndReceive

See Also:: Constant Field Values

APPLICATION_SESSION_STARTRECEIVE_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_STARTRECEIVE_NOTIFICATION_ID

Notification type constant for the notification application.session.StartReceive.

Description: Open queue receiver.

See Also:: application.session.StartReceive

See Also:: Constant Field Values

APPLICATION_SESSION_SUBSCRIBE_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_SUBSCRIBE_NOTIFICATION_ID

Notification type constant for the notification application.session.Subscribe.

Description: Client subscription.

See Also:: application.session.Subscribe

See Also:: Constant Field Values

APPLICATION_SESSION_SUBSCRIBERPAUSE_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_SUBSCRIBERPAUSE_NOTIFICATION_ID

Notification type constant for the notification application.session.SubscriberPause.

Description: Durable subscription pause.

See Also:: application.session.SubscriberPause

See Also:: Constant Field Values

APPLICATION_SESSION_SUBSCRIBERRESUME_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_SUBSCRIBERRESUME_NOTIFICATION_ID

Notification type constant for the notification application.session.SubscriberResume.

Description: Durable subscription resumption.

See Also:: application.session.SubscriberResume

See Also:: Constant Field Values

APPLICATION_SESSION_SUBSCRIPTIONMESSAGESTRIMMEDFROMDB_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_SUBSCRIPTIONMESSAGESTRIMMEDFROMDB_NOTIFICATION_ID

Notification type constant for the notification application.session.SubscriptionMessagesTrimmedFromDB.

Description: Durable Subscription Trim Operation completed message deletions from DB.

See Also:: application.session.SubscriptionMessagesTrimmedFromDB

See Also:: Constant Field Values

APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCANCELLED_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCANCELLED_NOTIFICATION_ID

Notification type constant for the notification application.session.SubscriptionTrimInvocationCancelled.

Description: Durable Subscription Trim Operation cancelled.

See Also:: application.session.SubscriptionTrimInvocationCancelled

See Also:: Constant Field Values

APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCOMPLETED_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCOMPLETED_NOTIFICATION_ID

Notification type constant for the notification application.session.SubscriptionTrimInvocationCompleted.

Description: Durable Subscription Trim Operation returned.

See Also:: application.session.SubscriptionTrimInvocationCompleted

See Also:: Constant Field Values

APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONINITIATED_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONINITIATED_NOTIFICATION_ID

Notification type constant for the notification application.session.SubscriptionTrimInvocationInitiated.

Description: Durable Subscription Trim Operation invoked.

See Also:: application.session.SubscriptionTrimInvocationInitiated

See Also:: Constant Field Values

APPLICATION_SESSION_UNSUBSCRIBE_NOTIFICATION_ID

static final java.lang.String APPLICATION_SESSION_UNSUBSCRIBE_NOTIFICATION_ID

Notification type constant for the notification application.session.Unsubscribe.

Description: Client unsubscribe.

See Also:: application.session.Unsubscribe

See Also:: Constant Field Values

APPLICATION_STATE_ACCEPTORSTATUS_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_ACCEPTORSTATUS_NOTIFICATION_ID

Notification type constant for the notification application.state.AcceptorStatus.

Description: An acceptor failed to successufly be started

See Also:: application.state.AcceptorStatus

See Also:: Constant Field Values

APPLICATION_STATE_DBCOMPACT_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_DBCOMPACT_NOTIFICATION_ID

Notification type constant for the notification application.state.DbCompact.

Description: A change has occured in the database compaction state.

See Also:: application.state.DbCompact

See Also:: Constant Field Values

APPLICATION_STATE_DMQCAPACITY_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_DMQCAPACITY_NOTIFICATION_ID

Notification type constant for the notification application.state.DmqCapacity.

Description: Dead Message Queue capacity warning.

See Also:: application.state.DmqCapacity

See Also:: Constant Field Values

APPLICATION_STATE_LOGCAPACITY_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_LOGCAPACITY_NOTIFICATION_ID

Notification type constant for the notification application.state.LogCapacity.

Description: Recovery log capacity warning.

See Also:: application.state.LogCapacity

See Also:: Constant Field Values

APPLICATION_STATE_PRIMARYACCEPTORSTATUS_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_PRIMARYACCEPTORSTATUS_NOTIFICATION_ID

Notification type constant for the notification application.state.PrimaryAcceptorStatus.

Description: The primary acceptor failed to successufly be started

See Also:: application.state.PrimaryAcceptorStatus

See Also:: Constant Field Values

APPLICATION_STATE_REPLICATIONACTIVATE_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_REPLICATIONACTIVATE_NOTIFICATION_ID

Notification type constant for the notification application.state.ReplicationActivate.

Description: Replication connection activation.

See Also:: application.state.ReplicationActivate

See Also:: Constant Field Values

APPLICATION_STATE_REPLICATIONCHANNELSWITCH_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_REPLICATIONCHANNELSWITCH_NOTIFICATION_ID

Notification type constant for the notification application.state.ReplicationChannelSwitch.

Description: Replication channel switch.

See Also:: application.state.ReplicationChannelSwitch

See Also:: Constant Field Values

APPLICATION_STATE_REPLICATIONSTATECHANGE_NOTIFICATION_ID

static final java.lang.String APPLICATION_STATE_REPLICATIONSTATECHANGE_NOTIFICATION_ID

Notification type constant for the notification application.state.ReplicationStateChange.

Description: Replication state change.

See Also:: application.state.ReplicationStateChange

See Also:: Constant Field Values

BROKER_BYTES_DELIVEREDPERSECOND_METRIC_ID

static final IMetricIdentity BROKER_BYTES_DELIVEREDPERSECOND_METRIC_ID

Metric identity constant for the metric broker.bytes.DeliveredPerSecond.

Description: Broker wide bytes delivered/sec (includes internal/management messages).

See Also:: broker.bytes.DeliveredPerSecond

BROKER_BYTES_RECEIVEDPERSECOND_METRIC_ID

static final IMetricIdentity BROKER_BYTES_RECEIVEDPERSECOND_METRIC_ID

Metric identity constant for the metric broker.bytes.ReceivedPerSecond.

Description: Broker wide bytes received/sec (includes internal/management messages).

See Also:: broker.bytes.ReceivedPerSecond

BROKER_BYTES_TOPICDBSIZE_METRIC_ID

static final IMetricIdentity BROKER_BYTES_TOPICDBSIZE_METRIC_ID

Metric identity constant for the metric broker.bytes.TopicDBSize.

Description: Total size in bytes of topic message store.

See Also:: broker.bytes.TopicDBSize

BROKER_CONNECTIONS_COUNT_METRIC_ID

static final IMetricIdentity BROKER_CONNECTIONS_COUNT_METRIC_ID

Metric identity constant for the metric broker.connections.Count.

Description: Inbound connection count to broker.

See Also:: broker.connections.Count

BROKER_CONNECTIONS_REJECTEDPERMINUTE_METRIC_ID

static final IMetricIdentity BROKER_CONNECTIONS_REJECTEDPERMINUTE_METRIC_ID

Metric identity constant for the metric broker.connections.RejectedPerMinute.

Description: Rejected connect attempts per minute.

See Also:: broker.connections.RejectedPerMinute

BROKER_MESSAGES_DELIVERED_METRIC_ID

static final IMetricIdentity BROKER_MESSAGES_DELIVERED_METRIC_ID

Metric identity constant for the metric broker.messages.Delivered.

Description: Application messages delivered since start/reset (excludes internal/management messages).

See Also:: broker.messages.Delivered

BROKER_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

static final IMetricIdentity BROKER_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

Metric identity constant for the metric broker.messages.DeliveredPerSecond.

Description: Application messages delivered/sec (excludes internal/management messages).

See Also:: broker.messages.DeliveredPerSecond

BROKER_MESSAGES_RECEIVED_METRIC_ID

static final IMetricIdentity BROKER_MESSAGES_RECEIVED_METRIC_ID

Metric identity constant for the metric broker.messages.Received.

Description: Application messages received since start/reset (excludes internal/management messages).

See Also:: broker.messages.Received

BROKER_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

static final IMetricIdentity BROKER_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

Metric identity constant for the metric broker.messages.ReceivedPerSecond.

Description: Application messages received/sec (excludes internal/management messages).

See Also:: broker.messages.ReceivedPerSecond

CONNECTION_BYTES_DELIVERED_METRIC_ID

static final IMetricIdentity CONNECTION_BYTES_DELIVERED_METRIC_ID

Parent metric identity constant for the instance metric connection.bytes.Delivered.

Description: Bytes delivered to a connection (includes internal/management messages).

See Also:: connection.bytes.Delivered

CONNECTION_BYTES_DELIVEREDPERSECOND_METRIC_ID

static final IMetricIdentity CONNECTION_BYTES_DELIVEREDPERSECOND_METRIC_ID

Parent metric identity constant for the instance metric connection.bytes.DeliveredPerSecond.

Description: Bytes delivered to a connection/sec (includes internal/management messages).

See Also:: connection.bytes.DeliveredPerSecond

CONNECTION_BYTES_RECEIVED_METRIC_ID

static final IMetricIdentity CONNECTION_BYTES_RECEIVED_METRIC_ID

Parent metric identity constant for the instance metric connection.bytes.Received.

Description: Bytes received by a connection (includes internal/management messages).

See Also:: connection.bytes.Received

CONNECTION_BYTES_RECEIVEDPERSECOND_METRIC_ID

static final IMetricIdentity CONNECTION_BYTES_RECEIVEDPERSECOND_METRIC_ID

Parent metric identity constant for the instance metric connection.bytes.ReceivedPerSecond.

Description: Bytes received by a connection/sec (includes internal/management messages).

See Also:: connection.bytes.ReceivedPerSecond

CONNECTION_MESSAGES_DELIVERED_METRIC_ID

static final IMetricIdentity CONNECTION_MESSAGES_DELIVERED_METRIC_ID

Parent metric identity constant for the instance metric connection.messages.Delivered.

Description: Messages delivered to a connection (excludes internal/management messages).

See Also:: connection.messages.Delivered

CONNECTION_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

static final IMetricIdentity CONNECTION_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

Parent metric identity constant for the instance metric connection.messages.DeliveredPerSecond.

Description: Messages delivered to a connection/sec (excludes internal/management messages).

See Also:: connection.messages.DeliveredPerSecond

CONNECTION_MESSAGES_RECEIVED_METRIC_ID

static final IMetricIdentity CONNECTION_MESSAGES_RECEIVED_METRIC_ID

Parent metric identity constant for the instance metric connection.messages.Received.

Description: Messages received by a connection (excludes internal/management messages).

See Also:: connection.messages.Received

CONNECTION_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

static final IMetricIdentity CONNECTION_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

Parent metric identity constant for the instance metric connection.messages.ReceivedPerSecond.

Description: Messages received by a connection/sec (excludes internal/management messages).

See Also:: connection.messages.ReceivedPerSecond

QUEUE_MESSAGES_COUNT_METRIC_ID

static final IMetricIdentity QUEUE_MESSAGES_COUNT_METRIC_ID

Parent metric identity constant for the instance metric queue.messages.Count.

Description: Number of messages in a queue.

See Also:: queue.messages.Count

QUEUE_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

static final IMetricIdentity QUEUE_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

Parent metric identity constant for the instance metric queue.messages.DeliveredPerSecond.

Description: Messages delivered to a queue/sec (including rejected messages).

See Also:: queue.messages.DeliveredPerSecond

QUEUE_MESSAGES_MAXDEPTH_METRIC_ID

static final IMetricIdentity QUEUE_MESSAGES_MAXDEPTH_METRIC_ID

Parent metric identity constant for the instance metric queue.messages.MaxDepth.

Description: Maximum number of messages in a queue during a collection interval.

See Also:: queue.messages.MaxDepth

QUEUE_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

static final IMetricIdentity QUEUE_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

Parent metric identity constant for the instance metric queue.messages.ReceivedPerSecond.

Description: Messages received by a queue/sec.

See Also:: queue.messages.ReceivedPerSecond

QUEUE_MESSAGES_SIZE_METRIC_ID

static final IMetricIdentity QUEUE_MESSAGES_SIZE_METRIC_ID

Parent metric identity constant for the instance metric queue.messages.Size.

Description: Size of messages in a queue.

See Also:: queue.messages.Size

SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

Notification type constant for the notification system.state.Offline.

Description: Component stop complete.

See Also:: system.state.Offline

See Also:: Constant Field Values

SYSTEM_STATE_ONLINE_NOTIFICATION_ID

static final java.lang.String SYSTEM_STATE_ONLINE_NOTIFICATION_ID

Notification type constant for the notification system.state.Online.

Description: Component start complete.

See Also:: system.state.Online

See Also:: Constant Field Values

Method Detail

activateWaitingBroker

void activateWaitingBroker()

Invokes the activateWaitingBroker operation.

Activate a broker in the WAITING state.

Impact: ACTION

addNotificationListener

void addNotificationListener(NotificationListener listener,
                             NotificationFilter filter,
                             java.lang.Object handback)

Adds a notification listener.

A Broker component publishes the following notifications:

Parameters:: listener - The listener object which will handle the notifications emitted component.; filter - The filter object. If filter is null, no filtering will be performed before handling notifications.; handback - The context to be sent to the listener when a notification is emitted.
See Also:: removeNotificationListener(javax.management.NotificationListener)

cancelReliableSequences

void cancelReliableSequences(java.util.ArrayList ids)

Invokes the cancelReliableSequences operation.

Management operation that supports cancelling of Web Service Reliable Messaging sequences.

Reliable sequences are identified by a universally unique identifier(UUID). A UUID identifies either a reliable send sequence or a receive receive sequence.

Cancelling a send sequence includes standard JMS undelivered message processing for messages that have been produced by Sonic JMS clients for Web Service transmission and that are pending acknowledgement by the remote RM Destination.

If a JMS client sends messages after a send sequence has been cancelled, the fault 'Sequence terminated' or 'Unknown sequence' may be generated and standard JMS undelivered message processing applied.

Cancelling a receive sequence causes a Web Service Reliable Messaging sequence fault, 'Sequence terminated', to be sent to the remote RM Source; if additional messages are received from the RM Source, these will be faulted with 'Unknown sequence'.

Impact: ACTION

Parameters:: ids - ArrayList of String sequence identifiers that identify reliable sequences to be cancelled.
See Also:: ReliableSequenceHelper.getReliableSendSequences(), ReliableSequenceHelper.getReliableReceiveSequences()

clearDuplicateDetectionData

void clearDuplicateDetectionData()

Invokes the clearDuplicateDetectionData operation.

Remove the duplicate detection data from the duplicate detection store

Impact: ACTION

clearError

void clearError()

Invokes the clearError operation.

Clear existing error condition.

Impact: ACTION

See Also:: getLastErrorLevel()

closeBrowser

void closeBrowser(IBrowseToken token)

Invokes the closeBrowser operation.

Cleanup all state information associated with the given IBrowseToken.

Impact: INFO

Parameters:: token - The browse token representing a browser.
Throws:: ProxyRuntimeException - If the browse token does not exist within the local broker. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: createDurableBrowseToken(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean), ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException

commitPreparedXABranches

void commitPreparedXABranches(java.lang.Integer[] tIDs)

Invokes the commitPreparedXABranches operation.

Commit the given set of prepared XA branches.

Impact: ACTION

Parameters:: tIDs - The internal TIDs of the branches to commit.
See Also:: getPreparedXABranches(), rollbackPreparedXABranches(java.lang.Integer[])

createDurableBrowseToken

IBrowseToken createDurableBrowseToken(java.lang.String userId,
                                      java.lang.String jmsClientId,
                                      java.lang.String uniqueName,
                                      java.lang.Boolean isConnectionConsumer,
                                      java.lang.Boolean local)

Invokes the createDurableBrowseToken operation.

Create a durable browse token for durable operations.

Impact: INFO

Parameters:: userId - The user that created the durable subscriber.; jmsClientId - The JMS Client ID of the durable subscriber.; uniqueName - The name used to identify this subscription.; isConnectionConsumer - True if this durable subscription is in use for a Connection Consumer.; local - True if this durable browser should only browse information on the local broker. False if this durable browser should browse all message for this durable subscription across the cluster.
Returns:: A IBrowseToken that can be utilized for durable browsing.
Throws:: ProxyRuntimeException - If there is an error creating the IBrowseToken. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: createDurableBrowseToken(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean), ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException, getBrowseMessages(com.sonicsw.mq.common.runtime.IBrowseToken, java.lang.Integer)

createDurableBrowseTokenFromDSD

IBrowseToken createDurableBrowseTokenFromDSD(IDurableSubscriptionData dsd,
                                             java.lang.Boolean isLocal)

Invokes the createDurableBrowseTokenFromDSD operation.

Create a durable browse token for durable operations from a IDurableSubscriptionData.

Impact: INFO

Parameters:: dsd - A reference to the IDurableSubscriptionData to be browsed.; isLocal - True if this durable browser should only browse information on the local broker. False if this durable browser should browse all message for this durable subscription across the cluster.
Returns:: A IBrowseToken that can be utilized for durable browsing.
Throws:: ProxyRuntimeException - If there is an error creating the IBrowseToken. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: getBrowseMessages(com.sonicsw.mq.common.runtime.IBrowseToken, java.lang.Integer), getDurableSubscriptions(java.lang.String), ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException

createDurableMessageHeaderToken

IMessageHeaderToken createDurableMessageHeaderToken(java.lang.String userId,
                                                    java.lang.String jmsClientId,
                                                    java.lang.String uniqueName,
                                                    java.lang.Boolean isConnectionConsumer,
                                                    java.lang.String messageId)

Invokes the createDurableMessageHeaderToken operation.

Create a message header token for use in other operations. A message header token represents a message in a specific durable subscription.

Impact: INFO

Parameters:: userId - The user that created the durable subscriber.; jmsClientId - The JMS Client ID of the durable subscriber.; uniqueName - The name used to identify this subscription.; isConnectionConsumer - True if this durable subscription is in use for a Connection Consumer.; messageId - The JMS MessageID of the message.
Returns:: A IMessageHeaderToken representing the JMSMessage in the broker.
Throws:: ProxyRuntimeException - If there is an error creating the IBrowseToken. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: getMessage(com.sonicsw.mq.common.runtime.IMessageHeaderToken), searchMessage(com.sonicsw.mq.common.runtime.IMessageHeaderToken), IMessageHeaderToken, ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException

createDurableMessageHeaderTokenDSD

IMessageHeaderToken createDurableMessageHeaderTokenDSD(IDurableSubscriptionData dsd,
                                                       java.lang.String messageId)

Invokes the createDurableMessageHeaderTokenDSD operation.

Create a message header token for use in other operations from a IDurableSubscriptionData

Impact: INFO

Parameters:: dsd - A reference to the IDurableSubscriptionData to be browsed.; messageId - The JMS MessageID of the message.
Returns:: A IMessageHeaderToken representing the javax.jms.Message in the broker.
Throws:: ProxyRuntimeException - If there is an error creating the IMessageHeaderToken. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException, getMessage(com.sonicsw.mq.common.runtime.IMessageHeaderToken), searchMessage(com.sonicsw.mq.common.runtime.IMessageHeaderToken), getDurableSubscriptions(java.lang.String), IMessageHeaderToken

deleteDurableSubscriptions

void deleteDurableSubscriptions(java.lang.String user,
                                java.util.ArrayList subscriptions)

Invokes the deleteDurableSubscriptions operation.

Deletes the subscriptions for the given a user and a list of durable subscriptions. If the user is currently connected and applicable durable subscriptions are active, then the operation will fail (return an exception) after having deleted inactive subscriptions for that user.

The broker must be in an online state in order to invoke this operation.

Impact: ACTION

Parameters:: user - The user for which applicable durable subscriptions will be deleted.; subscriptions - A list of IDurableSubscriptionData objects describing the user subscriptions to delete. IDurableSubscriptionData objects are initially obtained by invoking getDurableSubscriptions(String) on this component. If no list is provided (null), then all durable subscriptions for the given user will be deleted.
See Also:: IDurableSubscriptionData, getUsersWithDurableSubscriptions(java.lang.String), getDurableSubscriptions(java.lang.String)

deleteGlobalQueueAdvertisements

void deleteGlobalQueueAdvertisements(java.util.ArrayList advertisements)

Invokes the deleteGlobalQueueAdvertisements operation.

Deletes the given set of global queue advertisements known by this broker.

The broker must be in an online state in order to invoke this operation.

Impact: ACTION

Parameters:: advertisements - A list of IGlobalQueueRouteData objects describing the advertisements to delete. IGlobalQueueRouteData objects are initially obtained by invoking getGlobalQueueAdvertisements(String) on this component.
See Also:: IGlobalQueueRouteData, getGlobalQueueAdvertisements(java.lang.String)

deleteQueueMessages

void deleteQueueMessages(java.util.ArrayList queues)

Invokes the deleteQueueMessages operation.

Deletes all messages from the given list of queues currently managed by the broker.

The broker must be in an online state in order to invoke this operation.

If there are active senders to an applicable queue, then it is possble that calling getQueues(String) immediately after invoking this operation will not yield a message count of 0 (since further messages may have arrived).

Impact: ACTION

Parameters:: queues - A list of queue names describing the queues to have their messages deleted.
See Also:: getQueues(java.lang.String)

deleteRemoteSubscriptions

void deleteRemoteSubscriptions(java.util.ArrayList remoteNodes)

Invokes the deleteRemoteSubscriptions operation.

Deletes remote subscriptions propagated by given remote nodes.

Deletes propagated remote subscriptions within the routing node to which this broker is a member. Remote subscriptions propagated by specified remote routing nodes are deleted.

Impact: ACTION

Parameters:: remoteNodes - An array list of java.lang.String objects supplying names of remote routing nodes which are propagating subscriptions and for which propagated remote subscriptions deletion is required.

disableAlerts

void disableAlerts(IAlert[] alerts)

Invokes the disableAlerts operation.

Disable threshold alerts on a metric.

Impact: ACTION

Metrics that allow alert thresholds to be specified are:

Parameters:: alerts - A list of alerts to disable.
See Also:: enableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])

disableMetrics

void disableMetrics(IMetricIdentity[] ids)

Invokes the disableMetrics operation.

Disable the given set of dynamic metrics.

Impact: ACTION

Dynamic metrics are:

Parameters:: ids - A list of metrics identity patterns.
See Also:: enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

dropConnections

void dropConnections(java.util.ArrayList connections)

Invokes the dropConnections operation.

Drops the given set of connections to this broker. Cluster connections are ignored.

The broker must be in an online state in order to invoke this operation.

Impact: ACTION

Parameters:: connections - A list of Long (connectionMemberRef) or IConnectionData objects identifying the client connections to drop. IConnectionData objects are initially obtained by invoking getConnections(String) on this component. If the broker supports connectionMemberRef's (i.e. IConnectionData.getConnectionMemberRef() returns non-null) these Long values provide a more efficient means of identifying the connections.
See Also:: IConnectionData, getConnections(java.lang.String)

enableAlerts

void enableAlerts(IAlert[] alerts)

Invokes the enableAlerts operation.

Enable threshold alerts on a metric.

Impact: ACTION

Metrics that allow alert thresholds to be specified are:

Parameters:: alerts - A list of alerts to enable.
See Also:: disableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), getEnabledAlerts(com.sonicsw.mf.common.metrics.IMetricIdentity[])

enableMetrics

void enableMetrics(IMetricIdentity[] ids)

Invokes the enableMetrics operation.

Enable the given set of dynamic metrics.

Impact: ACTION

Dynamic metrics are:

Parameters:: ids - A list of metrics identity patterns.
See Also:: disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

forceCRLUpdate

void forceCRLUpdate(java.lang.String distributionPoint)

Invokes the forceCRLUpdate operation.

Force immediate refresh of the cached CRL.

Impact: ACTION

Parameters:: distributionPoint - LDAP DN of the cached CRL.

getActiveMetrics

IMetricIdentity[] getActiveMetrics(IMetricIdentity[] ids)

Invokes the getActiveMetrics operation.

Gets the the list of metrics currently active in this component.

Impact: INFO

Parameters:: ids - A list of metrics identity patterns.
Returns:: An array of IMetricIdentity objects representing currently active metrics in this component.
See Also:: disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

getAttributes

AttributeList getAttributes(java.lang.String[] attributeNames)

Gets the values of several attributes of a Broker component.

Getting multiple attribute values at once is typically more efficient than getting individual attribute values.

Readable attributes (and their datatypes) exposed by a Broker are:

BrokerName (java.lang.String)
Classname (java.lang.String)
Classpath (java.lang.String)
ClusterName (java.lang.String)
ConfigID (java.lang.String)
DBCompactState (java.lang.Integer)
DBCompactStateString (java.lang.String)
LastError (java.lang.String)
LastErrorLevel (java.lang.Integer)
LastErrorLevelString (java.lang.String)
MetricsCollectionInterval (java.lang.Integer)
MetricsRefreshInterval (java.lang.Integer)
ReleaseVersion (java.lang.String)
ReplicationState (java.lang.Integer)
ReplicationStateString (java.lang.String)
ReplicationType (java.lang.String)
RoutingNodeName (java.lang.String)
SecurityEnabled (java.lang.Boolean)
State (java.lang.Short)
StateString (java.lang.String)
TraceMask (java.lang.Integer)
TraceMaskValues (java.lang.String)
Uptime (java.lang.Long)

Parameters:: attributeNames - A list of the attribute names of attributes to be retrieved.
Returns:: The list of the retrieved attributes.
See Also:: setAttributes(javax.management.AttributeList)

getBrokerName

java.lang.String getBrokerName()

Gets the value of the BrokerName attribute.

Returns:: The configured broker name.

getBrowseMessages

java.util.ArrayList getBrowseMessages(IBrowseToken ibt,
                                      java.lang.Integer maxMessages)

Invokes the getBrowseMessages operation.

Get the next set of messages for a durable browser.

The number of messages returned may be less than or equal to the maximum number specified.

Impact: INFO

Parameters:: ibt - An IBrowseToken representing an active durable browser.; maxMessages - The maximum number of messages to return.
Returns:: An ArrayList of IMessageHeader objects.
Throws:: ProxyRuntimeException - If there is an error returning the ArrayList. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException, createDurableBrowseToken(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.Boolean), IMessageHeader

getClassname

java.lang.String getClassname()

Gets the value of the Classname attribute.

Returns:: Component classname.

getClasspath

java.lang.String getClasspath()

Gets the value of the Classpath attribute.

Returns:: Component classpath.

getClusterName

java.lang.String getClusterName()

Gets the value of the ClusterName attribute.

Returns:: The name of the cluster to which the broker belongs (empty if the broker is not a member of a cluster).

getConfigID

java.lang.String getConfigID()

Gets the value of the ConfigID attribute.

Returns:: Configuration identity.

getConnectionMemberDetails

java.util.ArrayList getConnectionMemberDetails(java.util.ArrayList refs)

Invokes the getConnectionMemberDetails operation.

Gets the details of the requested connection members.

The result is an ArrayList of IConnectionMemberDetails instances, one instance per requested member. The ArrayList will contain a null element for any connection members that no longer exist.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: refs - An ArrayList of Longs, each representing a connection member reference id, for which to retrieve the member's details.
See Also:: IConnectionData.getConnectionMemberRef()

getConnectionMemberDetails

IConnectionMemberDetails getConnectionMemberDetails(java.lang.Long ref)

Invokes the getConnectionMemberDetails operation.

Gets the details of the requested connection member.

The result will be null if the member reference id no longer exists.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: ref - The connection member reference id for which to retrieve the member's details.
See Also:: IConnectionData.getConnectionMemberRef()

getConnections

java.util.ArrayList getConnections(java.lang.String prefix)

Invokes the getConnections operation.

Gets the set of current connections to this broker.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: prefix - When specifed, filters the list of returned connections to those with a user name starting with, or equal to, the given filter. If not specified (null or empty string), all connected clients will be returned.
Returns:: Each element of the list is an instance of IConnectionData.
See Also:: IConnectionData, dropConnections(java.util.ArrayList)

getConnectionTree

java.util.ArrayList getConnectionTree(java.util.ArrayList nodes,
                                      java.lang.Integer depth)

Invokes the getConnectionTree operation.

Gets full or partial tree of connection member information. Exposes the hierachy of currently-connected connections, sessions, consumers, etc.

The result is an ArrayList of IConnectionTreeNode instances, one instance per requested node. The ArrayList will contain a null element for any connection members that no longer exist.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: nodes - An ArrayList of Longs, each representing a connection member reference id, for which to retrieve a connection sub-tree, or null to retrieve the whole tree.; depth - The maximum depth of child nodes to retrieve.
See Also:: IConnectionData.getConnectionMemberRef(), IConnectionTreeNode

getCRLList

java.lang.String[] getCRLList()

Invokes the getCRLList operation.

Return the names of all known CRLs.

Impact: INFO

Returns:: Names of all known CRLs to this broker.

getDBCompactState

java.lang.Integer getDBCompactState()

Gets the value of the DBCompactState attribute.

Retreive the current status of a compaction operation. Possible values re

NONE (-1) - no current known state
PENDING (1) - an operation is under way.
COMPLETE (2) - an opertion has successfully completed
ERROR (3) - a failure has occured. Check the container log for information. When an error occurs, a notification is triggered.

Returns:: the current status of the database compaction operation (Not started, In progress, Failed)

getDBCompactStateString

java.lang.String getDBCompactStateString()

Gets the value of the DBCompactStateString attribute.

Retreive the current status of a compaction operation. Possible values re

NONE (-1) - no current known state
PENDING (1) - an operation is under way.
COMPLETE (2) - an opertion has successfully completed
ERROR (3) - a failure has occured. Check the container log for information. When an error occurs, a notification is triggered.

Returns:: the current status of the database compaction operation (Not started, In progress, Failed)

getDurableSubscriptions

java.util.ArrayList getDurableSubscriptions(java.lang.String user)

Invokes the getDurableSubscriptions operation.

Gets the set of durable subscriptions for the given user.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: user - The user name for which the list of durable subscriptions will be returned.
Returns:: Each element of the list is an instance of IDurableSubscriptionData.
See Also:: IDurableSubscriptionData, getUsersWithDurableSubscriptions(java.lang.String), deleteDurableSubscriptions(java.lang.String, java.util.ArrayList)

getEnabledAlerts

IAlert[] getEnabledAlerts(IMetricIdentity[] ids)

Invokes the getEnabledAlerts operation.

Get all metric threshold alerts enabled by this component.

Impact: INFO

Parameters:: ids - A list of metrics identities for which to get the enabled alerts.
Returns:: The list of enabled alerts.
See Also:: disableAlerts(com.sonicsw.mf.common.metrics.IAlert[]), enableAlerts(com.sonicsw.mf.common.metrics.IAlert[])

getEnabledMetrics

IMetricIdentity[] getEnabledMetrics(IMetricIdentity[] ids)

Invokes the getEnabledMetrics operation.

Get the list of metric patterns that have been enabled for this component.

Impact: INFO

Parameters:: ids - A list of metrics identities for which to get the enabled alerts.
Returns:: An array of IMetricIdentity objects of enabled metrics for this component.
See Also:: disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo(), resetMetrics()

getExternalUsers

java.lang.String[] getExternalUsers(java.lang.String prefix)

Invokes the getExternalUsers operation.

This operation is used in the PASS feature. If a Broker is connected to an External Authentication Domain, then this operation can be invoked to get the list of external users cached by the broker. The broker must be in an online state in order to invoke this operation. Returns a list of external users cached by the broker.

Impact: INFO

Parameters:: prefix - Not implemented/used in this release.
Returns:: List of external users cached by the broker.

getGlobalQueueAdvertisements

java.util.ArrayList getGlobalQueueAdvertisements(java.lang.String prefix)

Invokes the getGlobalQueueAdvertisements operation.

Gets the set of global queue advertisements known by this broker.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: prefix - When specifed, filters the list of returned advertisements to those with a node name starting with, or equal to, the given filter. If not specified (null or empty string), all advertisements will be returned.
Returns:: Each element of the list is an instance of IGlobalQueueRouteData (the implementation of which describes the routing node and global queue name).
See Also:: IGlobalQueueRouteData, deleteGlobalQueueAdvertisements(ArrayList)

getInstanceMetricNames

java.lang.String[] getInstanceMetricNames(IMetricIdentity id)

Invokes the getInstanceMetricNames operation.

Get the instance names to which the given instance metric may be applied. An array of instance names. If there are no instances the broker will a zero length array. If the metric identity is either unknown or not that of an instance metric, then the broker will return null.

Impact: INFO

Parameters:: id - The instance metric parent identity.
Returns:: List of of instance metric names for given parent metric identity.

getLastError

java.lang.String getLastError()

Gets the value of the LastError attribute.

Returns:: Last (uncleared) error condition.

getLastErrorLevel

java.lang.Integer getLastErrorLevel()

Gets the value of the LastErrorLevel attribute.

Returns:: Last (uncleared) error severity.

getLastErrorLevelString

java.lang.String getLastErrorLevelString()

Gets the value of the LastErrorLevelString attribute.

Returns:: Last (uncleared) error severity description.

getMessage

IMessage getMessage(IMessageHeaderToken ht)

Invokes the getMessage operation.

Retrieve a message from a durable subscriber.

Impact: INFO

Parameters:: ht - A IMessageHeaderToken that represents the javax.jms.Message to retrieve.
Returns:: An IMessage interface that can be utilized to create a javax.jms.Message.
Throws:: ProxyRuntimeException - If there is an error retrieving the IMessage. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException, JMSObjectFactory.createJMSMessage(com.sonicsw.mq.common.runtime.IMessage)

getMetricsCollectionInterval

java.lang.Integer getMetricsCollectionInterval()

Gets the value of the MetricsCollectionInterval attribute.

Returns:: Metrics collection interval (in minutes)
See Also:: setMetricsCollectionInterval(java.lang.Integer)

getMetricsData

IMetricsData getMetricsData(IMetricIdentity[] ids,
                            java.lang.Boolean returnTriggeredAlerts)

Invokes the getMetricsData operation.

Gets metric values for a given set of metrics. If a requested metric was not enabled or is otherwise unknown, then no data for that metric will be included in the results.

Impact: INFO

Parameters:: ids - A list of active metrics, either individual metrics or instances.; returnTriggeredAlerts - If true, each metric returned should include a list of triggered (exceeded) alerts for these metrics.
Returns:: An IMetricsData instance containing metric values corresponding to specified metric identities.
See Also:: disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsInfo(), resetMetrics()

getMetricsInfo

IMetricInfo[] getMetricsInfo()

Invokes the getMetricsInfo operation.

Gets the meta-data for all metrics supported by this component.

Impact: INFO

Returns:: An array of IMetricInfo describing all the metrics supported by this component.
See Also:: disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), resetMetrics()

getMetricsRefreshInterval

java.lang.Integer getMetricsRefreshInterval()

Gets the value of the MetricsRefreshInterval attribute.

Returns:: Metrics refresh interval (in seconds)
See Also:: setMetricsRefreshInterval(java.lang.Integer)

getPreparedXABranches

java.util.ArrayList getPreparedXABranches()

Invokes the getPreparedXABranches operation.

Gets the set of prepared XA branches.

Impact: INFO

Returns:: Each element of the list is an instance of IPreparedXABranchData (the implementation of which describes a prepared XA branch).
See Also:: IPreparedXABranchData, commitPreparedXABranches(java.lang.Integer[]), rollbackPreparedXABranches(java.lang.Integer[])

getQueues

java.util.ArrayList getQueues(java.lang.String prefix)

Invokes the getQueues operation.

Gets the set of queues known by this broker.

The list will potentially include all queue types (system, temporary, global and clusterwide).

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: prefix - When specifed, filters the list of returned queues to those with a queue name starting with, or equal to, the given filter. If not specified (null or empty string), all queues will be returned.
Returns:: Each element of the list is an instance of IQueueData (the implementation of which describes the queue type and current message count).
Throws:: java.lang.IllegalStateException - If the broker is not in an online state.
See Also:: IQueueData, deleteQueueMessages(java.util.ArrayList)

getReleaseVersion

java.lang.String getReleaseVersion()

Gets the value of the ReleaseVersion attribute.

Returns:: Component release version.

getReliableReceiveSequences

java.util.ArrayList getReliableReceiveSequences()

Invokes the getReliableReceiveSequences operation.

For each remote broker, get reliable receive sequences.

Impact: INFO

Returns:: A list of IReliableSequenceData objects representing reliable receive sequences currently active in the broker component
See Also:: cancelReliableSequences(java.util.ArrayList)

getReliableSendSequences

java.util.ArrayList getReliableSendSequences()

Invokes the getReliableSendSequences operation.

For each remote broker, get reliable send sequences.

Impact: INFO

Returns:: A list of IReliableSequenceData objects representing reliable send sequences currently active in the broker component
See Also:: cancelReliableSequences(java.util.ArrayList)

getRemoteSubscriptionSummary

java.util.ArrayList getRemoteSubscriptionSummary(java.lang.String nodePattern)

Invokes the getRemoteSubscriptionSummary operation.

For each remote node, get remote subscription summary information (accepts optional node name filter).

For remote routing nodes whose name starts with an optional prefix, get summary information on all propagated subscriptions. Summary information is only returned for remote routing node names that match the prefix and that are propagating subscriptions.

Equivalent to getRemoteSubscriptionSummary(nodePrefix,Boolean.FALSE)

Impact: INFO

Parameters:: nodePattern - Remote routing node names match prefix. Null or zero-length string matches all remote routing nodes names.
Returns:: An array list of com.sonicsw.mq.common.runtime.IRemoteSubscriptionSummary objects.
See Also:: IRemoteSubscriptionSummary, getRemoteSubscriptionSummary(java.lang.String,java.lang.Boolean)

getRemoteSubscriptionSummary

java.util.ArrayList getRemoteSubscriptionSummary(java.lang.String nodePattern,
                                                 java.lang.Boolean getAllNodes)

Invokes the getRemoteSubscriptionSummary operation.

Get all remote nodes, for each node, get remote subscription summary information (accepts optional node name filter).

For remote routing nodes whose name starts with an optional prefix, get summary information on all propagated remote subscriptions. Summary information is only returned for remote routing node names that match the prefix. Summary information will be returned for all configured remote routing nodes that match the prefix regardless of whether they are propagating subscriptions if the getAllNodes parameter is true.

Impact: INFO

Parameters:: nodePattern - Remote routing node names match prefix. Null or zero-length string matches all remote routing nodes names.; getAllNodes - If true, return subscription information for all configured routing nodes that match the node prefix including nodes that are not propagating subscriptions. If false, return subscription information for routing nodes that match the node prefix and that are propagating subscriptions.
Returns:: An array list of com.sonicsw.mq.common.runtime.IRemoteSubscriptionSummary objects.
See Also:: IRemoteSubscriptionSummary

getRemoteSubscriptionTopics

java.util.ArrayList getRemoteSubscriptionTopics(java.lang.String node,
                                                java.lang.String topicPattern)

Invokes the getRemoteSubscriptionTopics operation.

Retrieves remote subscription topics for a given remote node and optional matching topic pattern.

For a given remote routing node name and topic pattern, retrieve propagated remote subscription topics that match the given topic pattern.

Impact: INFO

Parameters:: node - Name of remote routing node that is propagating remote subscriptions.; topicPattern - Optional topic pattern in subject namespace syntax. Null, empty string and "#" match all topics.
Returns:: An array list of java.lang.String objects returning topic names that match the pattern.

getReplicationConnections

java.lang.String[] getReplicationConnections()

Invokes the getReplicationConnections operation.

Retrieve the names of defined replication connections.

Impact: INFO

Returns:: The names of replication connections known by the broker.

getReplicationConnectionState

java.lang.Integer getReplicationConnectionState(java.lang.String name)

Invokes the getReplicationConnectionState operation.

Retrieve the current state of a replication connection.

Impact: INFO

Parameters:: name - The name of the replication connection.
Returns:: The replication state of the connection.
See Also:: ReplicationConnectionStateConstants

getReplicationConnectionStateString

java.lang.String getReplicationConnectionStateString(java.lang.String name)

Invokes the getReplicationConnectionStateString operation.

Retrieve the name of the current state of a replication connection.

Impact: INFO

Parameters:: name - The name of the replication connection.
Returns:: The stringified form of the replication state of the connection.
See Also:: ReplicationConnectionStateConstants

getReplicationState

java.lang.Integer getReplicationState()

Gets the value of the ReplicationState attribute.

Returns:: 0=STARTUP,1=WAITING,2=STANDALONE,3=ACTIVE,4=STANDBY,5=ACTIVE_SYNC,6=STANDBY_SYNC

getReplicationStateString

java.lang.String getReplicationStateString()

Gets the value of the ReplicationStateString attribute.

Returns:: The current Replication State

getReplicationType

java.lang.String getReplicationType()

Gets the value of the ReplicationType attribute.

Returns:: PRIMARY or BACKUP

getRoutingNodeName

java.lang.String getRoutingNodeName()

Gets the value of the RoutingNodeName attribute.

Returns:: The configured routing node name.

getRoutingStatistics

java.util.ArrayList getRoutingStatistics(java.lang.String prefix)

Invokes the getRoutingStatistics operation.

Gets a list of nodes that have outstanding messsage to be routed. The list will include IRouteStatistic objects.

An IRouteStatistic object may exist for the local node name. This will contain information for messages bound to other brokers in a cluster.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: prefix - When specifed, filters the list of returned route statistics to those with a Remote node name starting with, or equal to, the given filter. If not specified (null or empty string), all queues will be returned.
Returns:: Each element of the list is an instance of IRoutingStatistic (the implementation of which describes the routing node name and the current message count).
See Also:: IRoutingStatistic

getSecurityEnabled

java.lang.Boolean getSecurityEnabled()

Gets the value of the SecurityEnabled attribute.

Returns:: A flag indicating if the broker has security enabled.

getState

java.lang.Short getState()

Gets the value of the State attribute.

Returns:: Execution state of the component.
See Also:: getStateString(), IComponentState

getStateString

java.lang.String getStateString()

Gets the value of the StateString attribute.

Returns:: Description of the execution state of the component.
See Also:: getState(), IComponentState.STATE_TEXT

getSubscribers

java.util.ArrayList getSubscribers(java.util.ArrayList refs)

Invokes the getSubscribers operation.

Gets lists of subscribers for a batch of connections. When dealing with multiple connections this is more efficient than calling getSubscribers individually for each connection.

The result is an ArrayList of ArrayLists of ISubscriberData instances, one ArrayList per requested connection member.

With a large number of connections each with many subscribers (especially subscribers with large multi-topic destinations) it is possible the response could exceed the Management Broker's CONNECTION_TUNING_PARAMETERS.MAX_MSG_SIZE setting (default 10Mb), resulting in the request failing. In this case the Management Broker will log an EMsgTooBigException. Where the total number of subscribers is expected to be a few thousand or so, applications should use this API for appropriately-sized batches of connections rather than requesting the subscribers for all connections in a single call.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: refs - An ArrayList of Longs, each representing the connection member reference id of a connection for which the list of subscribers should be returned.
See Also:: IConnectionData.getConnectionMemberRef(), ISubscriberData

getSubscribers

java.util.ArrayList getSubscribers(java.lang.Long ref)

Invokes the getSubscribers operation.

Gets the list of subscribers for the given connection.

The result is an ArrayList of ISubscriberData instances. An empty list is returned if the connection has no subscribers, no longer exists, or does not represent a Connection.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: ref - The connection member reference id of a connection for which the list of subscribers should be returned.
See Also:: IConnectionData.getConnectionMemberRef(), ISubscriberData

getSubscribers

java.util.ArrayList getSubscribers(java.lang.String connectId,
                                   java.lang.String userId)

Invokes the getSubscribers operation.

Gets the list of subscribers for the given connection. A connection is identified by the combination of connectId and userId.

The alternative overloadings that take connection member references are preferred, provided the broker supports connection member references (SonicMQ 8.0 or later). This overloading will likely be deprecated in a future release.

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: connectId - The connectId for which the list of subscribers will be returned.; userId - The userId for which the list of subscribers will be returned.
Returns:: Each element of the list is an instance of ISubscriberData.
See Also:: getConnections(java.lang.String), ISubscriberData

getTraceMask

java.lang.Integer getTraceMask()

Gets the value of the TraceMask attribute. The trace mask is a bit mask composed from the following possible values:

1 - verbose
2 - set attributes
4 - operation invoked
8 - notification sent
16 - HTTP direct inbound
32 - HTTP direct outbound
64 - DRA log all connection failures
128 - external authentication

Returns:: Debug bit mask.
See Also:: setTraceMask(java.lang.Integer), getTraceMaskValues()

getTraceMaskValues

java.lang.String getTraceMaskValues()

Gets the value of the TraceMaskValues attribute.

Returns:: Possible TraceMask values.
See Also:: getTraceMask(), setTraceMask(java.lang.Integer)

getUptime

java.lang.Long getUptime()

Gets the value of the Uptime attribute.

Returns:: Execution time (milliseconds).

getUsersWithDurableSubscriptions

java.util.ArrayList getUsersWithDurableSubscriptions(java.lang.String prefix)

Invokes the getUsersWithDurableSubscriptions operation.

Gets the set of users that have durable subscriptions. The list will include both connected and disconnected durable subscribers

The broker must be in an online state in order to invoke this operation.

Impact: INFO

Parameters:: prefix - When specifed, filters the list of returned users to those with a user name starting with, or equal to, the given filter. If not specified (null or empty string), all users with durable subscriptions will be returned.
Returns:: Each element of the list is the user name (string).
See Also:: getDurableSubscriptions(java.lang.String), deleteDurableSubscriptions(java.lang.String, java.util.ArrayList)

initDuplicateDetectionStore

void initDuplicateDetectionStore(java.lang.Short action)

Invokes the initDuplicateDetectionStore operation.

(Re)Initialize the duplicate transaction detection table (0 = Create, 1 = Recreate, 2 = Delete, 3 = Upgrade).

The broker must be in an offline state in order to invoke this operation.

Impact: ACTION

Parameters:: action - The initialize action to be taken. Possible values are: 0 - create the duplicate detection tables, 1 - recreate the duplicate detection tables, 2 - delete the broker duplicate detection tables, 3 - upgrade from a prior version.
See Also:: initMessageStore(java.lang.Short)

initMessageStore

void initMessageStore(java.lang.Short action)

Invokes the initMessageStore operation.

(Re)Initialize the message store, recovery logs and duplicate transaction detection table (0 = Create, 1 = Recreate, 2 = Delete, 3 = Upgrade).

The broker must be in an offline state in order to invoke this operation.

In order to effect a broker name change, the broker should be stopped, have its database tables deleted, have its configured name changed, the database tables created and the broker restarted.

Impact: ACTION

Parameters:: action - The initialize action to be taken. Possible values are: 0 - create the broker specific database tables, 1 - recreate the broker specific database tables, 2 - delete the broker specific database tables, 3 - upgrade from a prior version.
See Also:: initDuplicateDetectionStore(java.lang.Short)

reconcileRemoteSubscriptions

void reconcileRemoteSubscriptions(java.util.ArrayList remoteNodes)

Invokes the reconcileRemoteSubscriptions operation.

Bi-laterally reconciles remote subscriptions with given remote nodes.

Bi-laterally reconciles remote subscriptions with given remote nodes. Reconciliation synchronizes propagated remote subscription information between nodes.

Impact: ACTION

Parameters:: remoteNodes - An array list of java.lang.String objects supplying names of remote routing nodes with which to bi-laterally reconcile remote subscriptions.

refreshSecurity

java.lang.Boolean refreshSecurity(java.lang.String prefix)

Invokes the refreshSecurity operation.

Impact: ACTION

Parameters:: prefix - Not implemented/used in this release.
Returns:: True if the operation was successful.
Throws:: java.lang.IllegalStateException - If the broker is not in an online state.

reload

void reload()

Invokes the reload operation.

Asynchronously reload the component and restart the component if it was previously online.

Impact: ACTION

removeMessage

void removeMessage(IMessageHeaderToken ht)

Invokes the removeMessage operation.

Remove a message from a durable subscriber.

Impact: ACTION

Parameters:: ht - An IMessageHeaderToken that represents the javax.jms.Message to remove.
Throws:: ProxyRuntimeException - If there is an error removing the message specified by the IMessageHeaderToken. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException

removeNotificationListener

void removeNotificationListener(NotificationListener listener)

Removes a notification listener.

This method will remove all the information related to the given listener.

Parameters:: listener - The listener object which will handle the notifications emitted by the registered MBean.
See Also:: addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, Object)

resetMetrics

void resetMetrics()

Invokes the resetMetrics operation.

Reset all metrics to their initial state.

Impact: ACTION

See Also:: disableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), enableMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getActiveMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getEnabledMetrics(com.sonicsw.mf.common.metrics.IMetricIdentity[]), getMetricsData(com.sonicsw.mf.common.metrics.IMetricIdentity[], java.lang.Boolean), getMetricsInfo()

rollbackPreparedXABranches

void rollbackPreparedXABranches(java.lang.Integer[] tids)

Invokes the rollbackPreparedXABranches operation.

Rollback the given set of prepared XA branches.

Impact: ACTION

Parameters:: tids - The internal TIDs of the branches to commit
See Also:: getPreparedXABranches(), commitPreparedXABranches(java.lang.Integer[])

searchMessage

IMessageHeader searchMessage(IMessageHeaderToken ht)

Invokes the searchMessage operation.

Search for a message from a durable subscriber.

Impact: INFO

Parameters:: ht - An IMessageHeaderToken that represents the javax.jms.Message to retrieve.
Returns:: An IMessageHeader object that allows access to the message.
Throws:: ProxyRuntimeException - If there is an error finding the message specified in the given IMessageHeaderToken. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException

setAttributes

AttributeList setAttributes(AttributeList attributes)

Sets the values of several attributes of a Broker component.

Setting multiple attribute values at once is typically more efficient than setting individual attribute values.

Settable attributes (and their datatypes) exposed by a Broker are:

MetricsCollectionInterval (java.lang.Integer)
MetricsRefreshInterval (java.lang.Integer)
TraceMask (java.lang.Integer)

Parameters:: attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.
Returns:: The list of attributes that were set, with their new values.
See Also:: getAttributes(java.lang.String[])

setBrowseInactiveTimeout

void setBrowseInactiveTimeout(IBrowseToken bt,
                              java.lang.Integer timeout)

Invokes the setBrowseInactiveTimeout operation.

Set the browser inactivity timeout. Default is 15 minutes. Afterthe given period of inactivity, the browser will remove any broker-side state information. Any operation on the browse token after the inactivity period will result in an exception.

Impact: INFO

Parameters:: bt - An IBrowseToken that should timeout in at least the specified time.; timeout - The amount of until a inactivity timeout occurs (in seconds).
Throws:: ProxyRuntimeException - If there is an error setting the inactivity timeout on the given IBrowseToken. The ProxyRuntimeException will contain a javax.management.MBeanException, which will in-turn contain a MFDurableOperationException.
See Also:: ProxyRuntimeException.getTargetException(), MBeanException.getTargetException(), MFDurableOperationException

setMetricsCollectionInterval

void setMetricsCollectionInterval(java.lang.Integer value)

Sets the value of the MetricsCollectionInterval attribute.

Parameters:: value - Metrics collection interval (in minutes)
See Also:: getMetricsCollectionInterval()

setMetricsRefreshInterval

void setMetricsRefreshInterval(java.lang.Integer value)

Sets the value of the MetricsRefreshInterval attribute.

Parameters:: value - Metrics refresh interval (in seconds)
See Also:: getMetricsRefreshInterval()

setTraceMask

void setTraceMask(java.lang.Integer value)

Sets the value of the TraceMask attribute. The trace mask is a bit mask composed from the following possible values:

1 - verbose
2 - set attributes
4 - operation invoked
8 - notification sent
16 - HTTP direct inbound
32 - HTTP direct outbound
64 - DRA log all connection failures
128 - external authentication

Parameters:: value - Debug bit mask.
See Also:: getTraceMask(), getTraceMaskValues()

start

void start()

Invokes the start operation.

Start providing service.

Impact: ACTION

See Also:: stop()

startDBCompact

void startDBCompact()

Invokes the startDBCompact operation.

Start a database compaction operation on the broker.

The broker must be offline.

Impact: ACTION

startDBCompactWorkdir

void startDBCompactWorkdir(java.lang.String workdir)

Invokes the startDBCompactWorkdir operation.

Start a database compaction, specifying an alternate location for workfiles generated during the operation. This variant is useful if the current volume hosting the message store is near capacity. The workDir parameter is relative to working directory of the container hosting the broker.

Impact: ACTION

Parameters:: workdir - A relative path to be used as the location for temporary files.

stop

void stop()

Invokes the stop operation.

Stop providing service.

Impact: ACTION

See Also:: start()

stopDBCompact

void stopDBCompact()

Invokes the stopDBCompact operation.

Stop an in-progress db compact operation. If none is pending, it is a no-op.

Impact: ACTION

syncMessageStore

void syncMessageStore(java.lang.String sourceWorkingDir)

Invokes the syncMessageStore operation.

Synchronize the message store of this broker to that of its replicated peer.

Impact: ACTION

Parameters:: sourceWorkingDir - The source broker�s container working directory as visible to broker on which the operation is invoked.

trimMessages

void trimMessages(IBrowseToken ibt,
                  java.lang.Long dateTime)

Invokes the trimMessages operation.

When a message is persisted for a durable subscription a timestamp is added indicating the time it was placed into the database. The trimMessages method allows callers to delete all messages stored prior to (and including) the date/time value provided for a specific durable subscription.

Impact: ACTION

Parameters:: ibt - A IBrowseToken representing a active durable browser.; dateTime - A Long value representing the "trim" date/time. Like the value returned from System.currentTimeMillis(), the value specifies the number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.

Overview

Package

Class

Tree

Index

Help

Sonic Management API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sonicsw.mq.mgmtapi.runtime Interface IBrokerProxy

APPLICATION_ALERT_BROKER_BYTES_TOPICDBSIZE_NOTIFICATION_ID

APPLICATION_ALERT_BROKER_CONNECTIONS_REJECTEDPERMINUTE_NOTIFICATION_ID

APPLICATION_ALERT_CONNECTION_BYTES_DELIVEREDPERSECOND_NOTIFICATION_ID

APPLICATION_ALERT_CONNECTION_BYTES_RECEIVEDPERSECOND_NOTIFICATION_ID

APPLICATION_ALERT_CONNECTION_MESSAGES_DELIVEREDPERSECOND_NOTIFICATION_ID

APPLICATION_ALERT_CONNECTION_MESSAGES_RECEIVEDPERSECOND_NOTIFICATION_ID

APPLICATION_ALERT_QUEUE_MESSAGES_COUNT_NOTIFICATION_ID

APPLICATION_ALERT_QUEUE_MESSAGES_SIZE_NOTIFICATION_ID

APPLICATION_CONNECTION_CONNECT_NOTIFICATION_ID

APPLICATION_CONNECTION_DISCONNECT_NOTIFICATION_ID

APPLICATION_CONNECTION_DROP_NOTIFICATION_ID

APPLICATION_CONNECTION_RECONNECT_NOTIFICATION_ID

APPLICATION_CONNECTION_REDIRECT_NOTIFICATION_ID

APPLICATION_CONNECTION_REJECT_NOTIFICATION_ID

APPLICATION_CONNECTION_REPLICATIONCONNECT_NOTIFICATION_ID

APPLICATION_CONNECTION_REPLICATIONDISCONNECT_NOTIFICATION_ID

APPLICATION_CONNECTION_REPLICATIONRETRY_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONPAUSE_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_CLUSTERCONNECTIONRESUME_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_ENDFLOWTODISK_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_PUBPAUSE_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_PUBRESUME_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_RMREORDERBUFFERAVAILABLE_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_RMREORDERBUFFERFULL_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_SENDPAUSE_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_SENDRESUME_NOTIFICATION_ID

APPLICATION_FLOWCONTROL_STARTFLOWTODISK_NOTIFICATION_ID

APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIBEFAILURE_NOTIFICATION_ID

APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONDELETED_NOTIFICATION_ID

APPLICATION_GLOBALSUBSCRIPTIONS_SUBSCRIPTIONEXPIRED_NOTIFICATION_ID

APPLICATION_MESSAGE_UNDELIVERED_NOTIFICATION_ID

APPLICATION_SESSION_ACKNOWLEDGEMENTPAUSE_NOTIFICATION_ID

APPLICATION_SESSION_ENDRECEIVE_NOTIFICATION_ID

APPLICATION_SESSION_STARTRECEIVE_NOTIFICATION_ID

APPLICATION_SESSION_SUBSCRIBE_NOTIFICATION_ID

APPLICATION_SESSION_SUBSCRIBERPAUSE_NOTIFICATION_ID

APPLICATION_SESSION_SUBSCRIBERRESUME_NOTIFICATION_ID

APPLICATION_SESSION_SUBSCRIPTIONMESSAGESTRIMMEDFROMDB_NOTIFICATION_ID

APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCANCELLED_NOTIFICATION_ID

APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONCOMPLETED_NOTIFICATION_ID

APPLICATION_SESSION_SUBSCRIPTIONTRIMINVOCATIONINITIATED_NOTIFICATION_ID

APPLICATION_SESSION_UNSUBSCRIBE_NOTIFICATION_ID

APPLICATION_STATE_ACCEPTORSTATUS_NOTIFICATION_ID

APPLICATION_STATE_DBCOMPACT_NOTIFICATION_ID

APPLICATION_STATE_DMQCAPACITY_NOTIFICATION_ID

APPLICATION_STATE_LOGCAPACITY_NOTIFICATION_ID

APPLICATION_STATE_PRIMARYACCEPTORSTATUS_NOTIFICATION_ID

APPLICATION_STATE_REPLICATIONACTIVATE_NOTIFICATION_ID

APPLICATION_STATE_REPLICATIONCHANNELSWITCH_NOTIFICATION_ID

APPLICATION_STATE_REPLICATIONSTATECHANGE_NOTIFICATION_ID

BROKER_BYTES_DELIVEREDPERSECOND_METRIC_ID

BROKER_BYTES_RECEIVEDPERSECOND_METRIC_ID

BROKER_BYTES_TOPICDBSIZE_METRIC_ID

BROKER_CONNECTIONS_COUNT_METRIC_ID

BROKER_CONNECTIONS_REJECTEDPERMINUTE_METRIC_ID

BROKER_MESSAGES_DELIVERED_METRIC_ID

BROKER_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

BROKER_MESSAGES_RECEIVED_METRIC_ID

BROKER_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

CONNECTION_BYTES_DELIVERED_METRIC_ID

CONNECTION_BYTES_DELIVEREDPERSECOND_METRIC_ID

CONNECTION_BYTES_RECEIVED_METRIC_ID

CONNECTION_BYTES_RECEIVEDPERSECOND_METRIC_ID

CONNECTION_MESSAGES_DELIVERED_METRIC_ID

CONNECTION_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

CONNECTION_MESSAGES_RECEIVED_METRIC_ID

CONNECTION_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

QUEUE_MESSAGES_COUNT_METRIC_ID

QUEUE_MESSAGES_DELIVEREDPERSECOND_METRIC_ID

QUEUE_MESSAGES_MAXDEPTH_METRIC_ID

QUEUE_MESSAGES_RECEIVEDPERSECOND_METRIC_ID

QUEUE_MESSAGES_SIZE_METRIC_ID

SYSTEM_STATE_OFFLINE_NOTIFICATION_ID

SYSTEM_STATE_ONLINE_NOTIFICATION_ID

activateWaitingBroker

addNotificationListener

cancelReliableSequences

clearDuplicateDetectionData

clearError

com.sonicsw.mq.mgmtapi.runtime
Interface IBrokerProxy