Sonic Management API

com.sonicsw.mq.common.runtime
Interface IRemoteSubscriptionSummary


public interface IRemoteSubscriptionSummary

This interface aggregates and summarizes information on remote subscriptions propagated by another routing node to a broker.

The broker exposes an operation "getRemoteSubscriptionSummary" through its JMX interface. This operation returns an array list of IRemoteSubscriptionSummary elements.

See Also:
IBrokerProxy.getRemoteSubscriptionSummary(java.lang.String), IBrokerProxy.getRemoteSubscriptionSummary(java.lang.String,java.lang.Boolean)

Method Summary
 long getMessageCount()
          Gets the number of messages currently held in the routing queue of this broker that are destined for the propagating routing node and result from publications to remote subscriptions topics.
 long getMessageSize()
          Gets the total bytes of messages currently held in the routing queue of this broker that are destined for the propagating routing node and result from publications to remote subscriptions topics.
 java.lang.String getNodeName()
          Gets the routing node name of the remote routing node that is propagating subscriptions.
 boolean hasRemoteSubscription()
          Returns true if the remote node has propagated at least one remote subscription to this broker.
 

Method Detail

getMessageCount

long getMessageCount()
Gets the number of messages currently held in the routing queue of this broker that are destined for the propagating routing node and result from publications to remote subscriptions topics.

The returned value will always be 0 if the remote node has not propagated remote subscriptions to this broker.

Returns:
message count
See Also:
hasRemoteSubscription()

getMessageSize

long getMessageSize()
Gets the total bytes of messages currently held in the routing queue of this broker that are destined for the propagating routing node and result from publications to remote subscriptions topics.

The returned value will always be 0 if the remote node has not propagated remote subscriptions to this broker.

See Also:
hasRemoteSubscription()

getNodeName

java.lang.String getNodeName()
Gets the routing node name of the remote routing node that is propagating subscriptions.

Returns:
propagating routing node name

hasRemoteSubscription

boolean hasRemoteSubscription()
Returns true if the remote node has propagated at least one remote subscription to this broker.

If the remote node has not propagated remote subscriptions with the broker then both the message count and message size will be 0.

See Also:
getMessageCount(), getMessageSize()

Sonic Management API

Copyright © 2001-2010 Progress Software Corporation. All Rights Reserved.
HTML formatted on 16-Sep-2010.