Package com.lightstreamer.jms_extender.jmx

Interface JmsConnectorMBean

public interface JmsConnectorMBean
Multiple JmsConnectorMBean instances are allowed in the system. Each JmsConnectorMBean instance pertains to one JMS Connector instance. Each JMS Connector instance is bound to one JmsConnectorMBean instance. Each JmsConnectorMBean instance is created at startup by the Server and lasts until the shutdown of the Server. Remote JMX clients should not deregister JmsConnectorMBean instances.

JmsConnectorMBean name pattern:
"com.lightstreamer:type=JmsConnector,JmsConnectorName=JMS.<JmsConnectorName>"

  • Method Details

    • getCumulUpstreamMessages

      java.lang.Long getCumulUpstreamMessages()
      Returns:
      The total (cumulative) number of JMS messages flowing from clients through this JMS Connector and to the JMS broker.

    • getUpstreamMessageFrequency

      java.lang.Double getUpstreamMessageFrequency()
      Returns:
      The frequency of JMS messages flowing from clients through this JMS Connector and to the JMS broker, in the last sampling period. It is expressed as messages per second.

    • getMaxUpstreamMessageFrequency

      java.lang.Double getMaxUpstreamMessageFrequency()
      Returns:
      The maximum frequency of JMS messages flowing from clients through this JMS Connector and to the JMS broker, reached in the life of the Server. It is expressed as messages per second.

    • getProducers

      java.lang.Integer getProducers()
      Returns:
      The number of JMS producers in this JMS Connector currently active for some client. Different producers to the same JMS destination activated by different clients (or even the same client) are reported multiple times in the count.

    • getMaxProducers

      java.lang.Integer getMaxProducers()
      Returns:
      The maximum number of currently active JMS producers in this JMS Connector, reached in the life of the Server.

    • getProducerList

      java.util.List getProducerList()
      Returns:
      The list of currently active JMS producers in this JMS Connector. Expressed as an ArrayList of Strings, where each String contains the destination name of the producer.

    • getCumulDownstreamMessages

      java.lang.Long getCumulDownstreamMessages()
      Returns:
      The total (cumulative) number of JMS messages flowing from the JMS broker through this JMS Connector and to clients.

    • getDownstreamMessageFrequency

      java.lang.Double getDownstreamMessageFrequency()
      Returns:
      The frequency of JMS messages flowing from the JMS broker through this JMS Connector and to clients, in the last sampling period. It is expressed as messages per second.

    • getMaxDownstreamMessageFrequency

      java.lang.Double getMaxDownstreamMessageFrequency()
      Returns:
      The maximum frequency of JMS messages flowing from the JMS broker through this JMS Connector and to clients, reached in the life of the Server. It is expressed as messages per second.

    • getConsumers

      java.lang.Integer getConsumers()
      Returns:
      The number of JMS consumers in this JMS Connector currently active for some client. Different consumers of the same JMS destination activated by different clients (or even the same client) are reported multiple times in the count.

    • getMaxConsumers

      java.lang.Integer getMaxConsumers()
      Returns:
      The maximum number of currently active JMS consumers in this JMS Connector, reached in the life of the Server.

    • getConsumerList

      java.util.List getConsumerList()
      Returns:
      The list of currently active JMS consumers in this JMS Connector. Expressed as an ArrayList of Strings, where each String contains the destination name of the consumer.

    • getClientSessions

      java.lang.Integer getClientSessions()
      Returns:
      The number of JMS sessions currently active in this JMS Connector.

    • getMaxClientSessions

      java.lang.Integer getMaxClientSessions()
      Returns:
      The maximum number of currently active JMS sessions in this JMS Connector, reached in the life of the Server.

    • getClientSessionList

      java.util.List getClientSessionList()
      Returns:
      The list of currently active JMS sessions for this JMS Connector. Expressed as an ArrayList of Strings, where each String contains the client session GUID.

    • getPooledBrokerConnections

      java.lang.Integer getPooledBrokerConnections()
      Returns:
      The number of pooled connections to the JMS broker currently active in this JMS Connector.

    • getMaxPooledBrokerConnections

      java.lang.Integer getMaxPooledBrokerConnections()
      Returns:
      The maximum number of currently active pooled connections to the JMS broker in this JMS Connector, reached in the life of the Server.

    • getDedicatedBrokerConnections

      java.lang.Integer getDedicatedBrokerConnections()
      Returns:
      The number of dedicated connections to the JMS broker currently active in this JMS Connector.

    • getMaxDedicatedBrokerConnections

      java.lang.Integer getMaxDedicatedBrokerConnections()
      Returns:
      The maximum number of currently active dedicated connections to the JMS broker in this JMS Connector, reached in the life of the Server.

    • getDedicatedBrokerConnectionList

      java.util.List getDedicatedBrokerConnectionList()
      Returns:
      The list of dedicated connections to the JMS broker currently active for this JMS Connector. Expressed as an ArrayList of Strings, where each String contains the session connection ID.

    • startCollectingAcknowledgeLatencyInfo

      java.lang.Boolean startCollectingAcknowledgeLatencyInfo​(long latencyReportInterval)
      Starts collecting statistical information on the delay that occurs between sending a message downstream and receiving its acknowledgement (acknowledge latency). At each specified interval a report is generated. Each report contains a simple chart with latency distribution up to 90th percentile. Acknowledge latency may also be configured for logging in the JMS Connector configuration.
      Parameters:
      latencyReportInterval - The interval between successive report generation. Expressed in milliseconds.
      Returns:
      True if operation succeeded. False if operation failed.

    • stopCollectingAcknowledgeLatencyInfo

      java.lang.Boolean stopCollectingAcknowledgeLatencyInfo()
      Stops collecting statistical information on the delay that occurs between sending a message downstream and receiving its acknowledgement (acknowledge latency). If acknowledge latency logging is configured in the JMS Connector configuration, this operation stop logging too.
      Returns:
      True if operation succeeded. False if operation failed.

    • dumpLastAcknowledgeLatencyReport

      java.lang.String dumpLastAcknowledgeLatencyReport()
      Dumps the latest generated report on acknowledge latency. See also jmsAcknowledgeLatencyStartCollectingInfo and jmsAcknowledgeLatencyStopCollectingInfo.
      Returns:
      The latest generated report.