com.sonicsw.mq.common.runtime
Interface IConnectionMemberDetails

public interface IConnectionMemberDetails

This interface provides detailed information relating to a member of a broker connection. It extends the basic name and type information provided by IConnectionMemberInfo.

A few common attributes are exposed via dedicated methods. These include the member's state, and, in the case of consumers, the associated JMS destination (e.g. queue or topic).

The bulk of the information is provided in a String-based properties map. Individual properties can be extracted from the map using the PROPERTY_* constants as key values. The set of properties present varies depending on the connection member's type and internal state, and is subject to change in future releases.

See Also:

IBrokerProxy.getConnectionMemberDetails(java.util.ArrayList)

Field Summary

static java.lang.String	ACKNOWLEDGE_MODE_AUTO Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the AUTO_ACKNOWLEDGE acknowledgement mode.
static java.lang.String	ACKNOWLEDGE_MODE_CLIENT Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the CLIENT_ACKNOWLEDGE acknowledgement mode.
static java.lang.String	ACKNOWLEDGE_MODE_DUPS_OK Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the DUPS_OK_ACKNOWLEDGE acknowledgement mode.
static java.lang.String	ACKNOWLEDGE_MODE_SINGLE_MESSAGE Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the SINGLE_MESSAGE_ACKNOWLEDGE acknowledgement mode.
static java.lang.String	ACKNOWLEDGE_MODE_TRANSACTED Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing a transacted session.
static java.lang.String	CONNECTION_TYPE_APPLICATION Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a JMS client application connection.
static java.lang.String	CONNECTION_TYPE_CLUSTER Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing an interbroker (cluster) connection.
static java.lang.String	CONNECTION_TYPE_JNDI Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a connection to the Sonic JNDI store.
static java.lang.String	CONNECTION_TYPE_MANAGEMENT_CLIENT Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a management connection to the Domain Manager.
static java.lang.String	CONNECTION_TYPE_MANAGEMENT_CONTAINER Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing an MF Container's management connection to the Domain Manager.
static java.lang.String	CONNECTION_TYPE_ROUTING Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a routing (DRA) connection.
static java.lang.String	PROPERTY_CONNECTION_ACCEPTOR_NAME Name of property providing the name of the acceptor handling the connection.
static java.lang.String	PROPERTY_CONNECTION_ACCEPTOR_URL Name of property providing the URL of the acceptor handling the connection.
static java.lang.String	PROPERTY_CONNECTION_CLUSTER_PEER Name of property identifying the name of the peer broker if this is an interbroker (cluster) connection.
static java.lang.String	PROPERTY_CONNECTION_CONNECTION_TYPE Name of property indicating the type of the connection.
static java.lang.String	PROPERTY_CONNECTION_CONSUMER_COUNT Name of property providing the number of consumers associated with the connection.
static java.lang.String	PROPERTY_CONNECTION_FAULT_TOLERANT Name of property indicating whether this is a fault tolerant connection.
static java.lang.String	PROPERTY_CONNECTION_LOCAL_SOCKET Name of property providing information about the connection's local (broker-side) socket.
static java.lang.String	PROPERTY_CONNECTION_PROTOCOL Name of property providing the protocol version used for the connection, e.g.
static java.lang.String	PROPERTY_CONNECTION_REMOTE_BROKER Name of property identifying the name of the remote DRA broker if this is a routing connection.
static java.lang.String	PROPERTY_CONNECTION_REMOTE_NODE Name of property identifying the name of the remote DRA node if this is a routing connection.
static java.lang.String	PROPERTY_CONNECTION_REMOTE_SOCKET Name of property providing information about the connection's remote (client-side, or another broker) socket.
static java.lang.String	PROPERTY_CONNECTION_SESSION_COUNT Name of property providing the number of sessions associated with the connection.
static java.lang.String	PROPERTY_CONNECTION_USER Name of property providing the user associated with the connection.
static java.lang.String	PROPERTY_CONNECTION_VERSION Name of property providing the client's product version and build info (if available).
static java.lang.String	PROPERTY_CONSUMER_DURABLE_MESSAGE_ORDER Name of property indicating, for a durable subscriber, that strict message ordering across a cluster is enabled.
static java.lang.String	PROPERTY_CONSUMER_FLOW_TO_DISK_ENABLED Name of property indicating whether the Flow To Disk feature is enabled for this consumer.
static java.lang.String	PROPERTY_CONSUMER_FLOW_TO_DISK_STATUS Name of property indicating whether messages are currently flowing to disk for this consumer.
static java.lang.String	PROPERTY_CONSUMER_SELECTOR Name of property providing the value of the consumer's message selector if it has one.
static java.lang.String	PROPERTY_CONSUMER_SELECTOR_AT_BROKER Name of property indicating whether the message selector is applied by the broker or client.
static java.lang.String	PROPERTY_FLOW_CONTROL_BLOCKED_SENDERS Name of property identifying any sender(s) blocked by this subscriber.
static java.lang.String	PROPERTY_FLOW_CONTROL_BLOCKING_CONSUMERS Name of property identifying any subscriber(s) blocking this sender.
static java.lang.String	PROPERTY_FLOW_CONTROL_BLOCKING_DESTINATIONS Name of property identifying the destination(s) (typically queues) blocking this sender.
static java.lang.String	PROPERTY_FLOW_CONTROL_BY_PEER_MIN_PRIORITY Name of property indicating that flow control is being asserted by the peer on the other side of the connection.
static java.lang.String	PROPERTY_FLOW_CONTROL_MIN_PUBLISH_PRIORITY Name of property indicating that flow control is being asserted due to buffers on the local broker having filled.
static java.lang.String	PROPERTY_MESSAGES_OUTGOING_COUNT Name of property providing the number of messages queued for delivery to this connection member.
static java.lang.String	PROPERTY_MESSAGES_OUTGOING_SIZE Name of property providing the total size of the messages queued for delivery to this connection member.
static java.lang.String	PROPERTY_MESSAGES_PENDING_COUNT Name of property providing the number of messages pending acknowledgement by this connection member.
static java.lang.String	PROPERTY_MESSAGES_PENDING_SIZE Name of property providing the total size of the messages pending acknowledgement by this connection member.
static java.lang.String	PROPERTY_SESSION_ACKNOWLEDGE_MODE Name of property identifying the acknowledgement mode of the session.
static short	STATE_DISCONNECTED State constant indicating that the connection member has been disconnected.
static short	STATE_PENDING_RECONNECT State constant indicating that the connection member is pending reconnect.
static short	STATE_RESTORING State constant indicating that messages are being restored from disk for this connection member.
static short	STATE_STARTED State constant indicating that the connection member is started (i.e. active).
static short	STATE_STOPPED State constant indicating that the connection associated with this member has been stopped, or has not yet been started.
static java.lang.String[]	STATE_TEXT Textual representations of connection member states (indexed by STATE_<> values).
static short	STATE_UNKNOWN State constant indicating that the connection member is in an unknown state.

Method Summary

IDestination	getDestination() If the member represents a consumer then this method returns the destination the consumer is listening on, otherwise it will return null.
IConnectionMemberInfo	getInfo() Returns the IConnectionMemberInfo associated with this connection member.
java.util.Map	getProperties() Gets additional properties associated with this connection member.
short	getState() Returns the state constant indicating this connection member's current state.
java.lang.String	getStateString() Returns a textual representation of this connection member's current state.
long	getTimeConnected() Gets the time at which this member was created.
long	getTimeOfLastStateChange() Gets the time at which this member's state transitioned to that returned by getState().

Field Detail

ACKNOWLEDGE_MODE_AUTO

static final java.lang.String ACKNOWLEDGE_MODE_AUTO

Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the AUTO_ACKNOWLEDGE acknowledgement mode.

See Also:

Constant Field Values

ACKNOWLEDGE_MODE_CLIENT

static final java.lang.String ACKNOWLEDGE_MODE_CLIENT

Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the CLIENT_ACKNOWLEDGE acknowledgement mode.

See Also:

Constant Field Values

ACKNOWLEDGE_MODE_DUPS_OK

static final java.lang.String ACKNOWLEDGE_MODE_DUPS_OK

Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the DUPS_OK_ACKNOWLEDGE acknowledgement mode.

See Also:

Constant Field Values

ACKNOWLEDGE_MODE_SINGLE_MESSAGE

static final java.lang.String ACKNOWLEDGE_MODE_SINGLE_MESSAGE

Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing the SINGLE_MESSAGE_ACKNOWLEDGE acknowledgement mode.

See Also:

Constant Field Values

ACKNOWLEDGE_MODE_TRANSACTED

static final java.lang.String ACKNOWLEDGE_MODE_TRANSACTED

Value of PROPERTY_SESSION_ACKNOWLEDGE_MODE property representing a transacted session.

See Also:

Constant Field Values

CONNECTION_TYPE_APPLICATION

static final java.lang.String CONNECTION_TYPE_APPLICATION

Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a JMS client application connection.

See Also:

Constant Field Values

CONNECTION_TYPE_CLUSTER

static final java.lang.String CONNECTION_TYPE_CLUSTER

Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing an interbroker (cluster) connection.

See Also:

Constant Field Values

CONNECTION_TYPE_JNDI

static final java.lang.String CONNECTION_TYPE_JNDI

Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a connection to the Sonic JNDI store.

See Also:

Constant Field Values

CONNECTION_TYPE_MANAGEMENT_CLIENT

static final java.lang.String CONNECTION_TYPE_MANAGEMENT_CLIENT

Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a management connection to the Domain Manager.

See Also:

Constant Field Values

CONNECTION_TYPE_MANAGEMENT_CONTAINER

static final java.lang.String CONNECTION_TYPE_MANAGEMENT_CONTAINER

Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing an MF Container's management connection to the Domain Manager.

See Also:

Constant Field Values

CONNECTION_TYPE_ROUTING

static final java.lang.String CONNECTION_TYPE_ROUTING

Value of PROPERTY_CONNECTION_CONNECTION_TYPE property representing a routing (DRA) connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_ACCEPTOR_NAME

static final java.lang.String PROPERTY_CONNECTION_ACCEPTOR_NAME

Name of property providing the name of the acceptor handling the connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_ACCEPTOR_URL

static final java.lang.String PROPERTY_CONNECTION_ACCEPTOR_URL

Name of property providing the URL of the acceptor handling the connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_CLUSTER_PEER

static final java.lang.String PROPERTY_CONNECTION_CLUSTER_PEER

Name of property identifying the name of the peer broker if this is an interbroker (cluster) connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_CONNECTION_TYPE

static final java.lang.String PROPERTY_CONNECTION_CONNECTION_TYPE

Name of property indicating the type of the connection. Property value will match one of the CONNECTION_TYPE_* constants.

See Also:

Constant Field Values

PROPERTY_CONNECTION_CONSUMER_COUNT

static final java.lang.String PROPERTY_CONNECTION_CONSUMER_COUNT

Name of property providing the number of consumers associated with the connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_FAULT_TOLERANT

static final java.lang.String PROPERTY_CONNECTION_FAULT_TOLERANT

Name of property indicating whether this is a fault tolerant connection. Property value will be "true" or "false".

See Also:

Constant Field Values

PROPERTY_CONNECTION_LOCAL_SOCKET

static final java.lang.String PROPERTY_CONNECTION_LOCAL_SOCKET

Name of property providing information about the connection's local (broker-side) socket.

See Also:

Constant Field Values

PROPERTY_CONNECTION_PROTOCOL

static final java.lang.String PROPERTY_CONNECTION_PROTOCOL

Name of property providing the protocol version used for the connection, e.g. "P30".

See Also:

Constant Field Values

PROPERTY_CONNECTION_REMOTE_BROKER

static final java.lang.String PROPERTY_CONNECTION_REMOTE_BROKER

Name of property identifying the name of the remote DRA broker if this is a routing connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_REMOTE_NODE

static final java.lang.String PROPERTY_CONNECTION_REMOTE_NODE

Name of property identifying the name of the remote DRA node if this is a routing connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_REMOTE_SOCKET

static final java.lang.String PROPERTY_CONNECTION_REMOTE_SOCKET

Name of property providing information about the connection's remote (client-side, or another broker) socket.

See Also:

Constant Field Values

PROPERTY_CONNECTION_SESSION_COUNT

static final java.lang.String PROPERTY_CONNECTION_SESSION_COUNT

Name of property providing the number of sessions associated with the connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_USER

static final java.lang.String PROPERTY_CONNECTION_USER

Name of property providing the user associated with the connection.

See Also:

Constant Field Values

PROPERTY_CONNECTION_VERSION

static final java.lang.String PROPERTY_CONNECTION_VERSION

Name of property providing the client's product version and build info (if available).

See Also:

Constant Field Values

PROPERTY_CONSUMER_DURABLE_MESSAGE_ORDER

static final java.lang.String PROPERTY_CONSUMER_DURABLE_MESSAGE_ORDER

Name of property indicating, for a durable subscriber, that strict message ordering across a cluster is enabled. If the property is present (value "true") then strict message ordering is enabled.

See Also:

Constant Field Values

PROPERTY_CONSUMER_FLOW_TO_DISK_ENABLED

static final java.lang.String PROPERTY_CONSUMER_FLOW_TO_DISK_ENABLED

Name of property indicating whether the Flow To Disk feature is enabled for this consumer. Property value will be "true" or "false". The property is only present for topic-based consumers.

See Also:

Constant Field Values

PROPERTY_CONSUMER_FLOW_TO_DISK_STATUS

static final java.lang.String PROPERTY_CONSUMER_FLOW_TO_DISK_STATUS

Name of property indicating whether messages are currently flowing to disk for this consumer. If the property is present (value "Offloading") then any new messages for this consumer are getting buffered on disk.

See Also:

Constant Field Values

PROPERTY_CONSUMER_SELECTOR

static final java.lang.String PROPERTY_CONSUMER_SELECTOR

Name of property providing the value of the consumer's message selector if it has one.

See Also:

Constant Field Values

PROPERTY_CONSUMER_SELECTOR_AT_BROKER

static final java.lang.String PROPERTY_CONSUMER_SELECTOR_AT_BROKER

Name of property indicating whether the message selector is applied by the broker or client. Property value will be "true" or "false". The property is only present if the consumer has a message selector.

See Also:

Constant Field Values

PROPERTY_FLOW_CONTROL_BLOCKED_SENDERS

static final java.lang.String PROPERTY_FLOW_CONTROL_BLOCKED_SENDERS

Name of property identifying any sender(s) blocked by this subscriber. If present, the value of this property is a comma-separated list of connection member references to the senders' Sessions.

See Also:

Constant Field Values

PROPERTY_FLOW_CONTROL_BLOCKING_CONSUMERS

static final java.lang.String PROPERTY_FLOW_CONTROL_BLOCKING_CONSUMERS

Name of property identifying any subscriber(s) blocking this sender. If present, the value of this property is a comma-separated list of connection member references.

See Also:

Constant Field Values

PROPERTY_FLOW_CONTROL_BLOCKING_DESTINATIONS

static final java.lang.String PROPERTY_FLOW_CONTROL_BLOCKING_DESTINATIONS

Name of property identifying the destination(s) (typically queues) blocking this sender. If present, the value of this property is a comma-separated list of destination names. Queue names are prefixed with '$Q.'. In the case of the routing queue, additional information is provided about the target destinations, which may be topics.

See Also:

Constant Field Values

PROPERTY_FLOW_CONTROL_BY_PEER_MIN_PRIORITY

static final java.lang.String PROPERTY_FLOW_CONTROL_BY_PEER_MIN_PRIORITY

Name of property indicating that flow control is being asserted by the peer on the other side of the connection. The value of the property, if present, indicates the minimum message priority required for a message to be delivered prior to the flow control condition clearing.

See Also:

Constant Field Values

PROPERTY_FLOW_CONTROL_MIN_PUBLISH_PRIORITY

static final java.lang.String PROPERTY_FLOW_CONTROL_MIN_PUBLISH_PRIORITY

Name of property indicating that flow control is being asserted due to buffers on the local broker having filled. The value of the property, if present, indicates the minimum message priority required for a message to be delivered prior to the flow control condition clearing.

See Also:

Constant Field Values

PROPERTY_MESSAGES_OUTGOING_COUNT

static final java.lang.String PROPERTY_MESSAGES_OUTGOING_COUNT

Name of property providing the number of messages queued for delivery to this connection member. If the property is not present then no messages are queued.

See Also:

Constant Field Values

PROPERTY_MESSAGES_OUTGOING_SIZE

static final java.lang.String PROPERTY_MESSAGES_OUTGOING_SIZE

Name of property providing the total size of the messages queued for delivery to this connection member. If the property is not present then no messages are queued.

See Also:

Constant Field Values

PROPERTY_MESSAGES_PENDING_COUNT

static final java.lang.String PROPERTY_MESSAGES_PENDING_COUNT

Name of property providing the number of messages pending acknowledgement by this connection member. If the property is not present then no messages are pending.

See Also:

Constant Field Values

PROPERTY_MESSAGES_PENDING_SIZE

static final java.lang.String PROPERTY_MESSAGES_PENDING_SIZE

Name of property providing the total size of the messages pending acknowledgement by this connection member. If the property is not present then no messages are pending.

See Also:

Constant Field Values

PROPERTY_SESSION_ACKNOWLEDGE_MODE

static final java.lang.String PROPERTY_SESSION_ACKNOWLEDGE_MODE

Name of property identifying the acknowledgement mode of the session. Property value will match one of the ACKNOWLEDGE_MODE_* constants.

See Also:

Constant Field Values

STATE_DISCONNECTED

static final short STATE_DISCONNECTED

State constant indicating that the connection member has been disconnected.

See Also:

Constant Field Values

STATE_PENDING_RECONNECT

static final short STATE_PENDING_RECONNECT

State constant indicating that the connection member is pending reconnect. In other words, the client was using a Fault Tolerant connection and the connection was lost. The broker holds onto the associated connection members for a while so the client has a chance to reconnect transparently.

See Also:

Constant Field Values

STATE_RESTORING

static final short STATE_RESTORING

State constant indicating that messages are being restored from disk for this connection member. For example, when a durable subscriber reconnects.

See Also:

Constant Field Values

STATE_STARTED

static final short STATE_STARTED

State constant indicating that the connection member is started (i.e. active).

See Also:

Constant Field Values

STATE_STOPPED

static final short STATE_STOPPED

State constant indicating that the connection associated with this member has been stopped, or has not yet been started. A JMS client must explicitly start() a connection in order to receive messages asynchronously.

See Also:

Constant Field Values

STATE_TEXT

static final java.lang.String[] STATE_TEXT

Textual representations of connection member states (indexed by STATE_<> values).

STATE_UNKNOWN

static final short STATE_UNKNOWN

State constant indicating that the connection member is in an unknown state.

See Also:

Constant Field Values

Method Detail

getDestination

IDestination getDestination()

If the member represents a consumer then this method returns the destination the consumer is listening on, otherwise it will return null.

See Also:

JMSObjectFactory.createJMSDestination(IDestination)

getInfo

IConnectionMemberInfo getInfo()

Returns the IConnectionMemberInfo associated with this connection member.

getProperties

java.util.Map getProperties()

Gets additional properties associated with this connection member. These are in the form of name-value pairs. Both the keys and their values are Strings.

getState

short getState()

Returns the state constant indicating this connection member's current state.

getStateString

java.lang.String getStateString()

Returns a textual representation of this connection member's current state.

getTimeConnected

long getTimeConnected()

Gets the time at which this member was created.

getTimeOfLastStateChange

long getTimeOfLastStateChange()

Gets the time at which this member's state transitioned to that returned by getState().