Package cool.mqtt.jmx

Interface ConfiguredMqttBrokerMBean

public interface ConfiguredMqttBrokerMBean
Multiple ConfiguredMqttBrokerMBean instance exist in the system, to provide information on the activity of the server related to a specific MQTT broker configuration.
Each ConfiguredMqttBrokerMBean instance relative to a statically configured MQTT broker is created at startup by the server and lasts until the shutdown of the server.
Each ConfiguredMqttBrokerMBean instance relative to an MQTT broker whose configuration is provided by the plugged Hook is created upon a connection request issued by the first client which contacts such a broker, and lasts until the shutdown of the server.
Each ConfiguredMqttBrokerMBean instance relative to a dynamic looked up MQTT broker is created upon a connection request issued by the first client which contacts such a broker, and lasts until no more clients reference it.

Remote JMX clients should not deregister ConfiguredMqttBrokerMBean instances.

ConfiguredMqttBrokerMBean name:
"cool.mqtt:type=ConfiguredMqttBroker, name=<MqttBrokerReference>"

where <MqttBrokerReference> is:

  • the connection alias used by clients to establish the connection to the statically configured MQTT broker, or
  • the connection alias used by clients to establish the connection to the MQTT broker whose configuration is provided by the plugged Hook, or
  • a surrogate of the URI used by clients to contact a dynamic looked up MQTT broker, in the form <host>_<port>

  • Method Details

    • getAddress

      java.lang.String getAddress()
      Returns:
      The address of the configured MQTT broker.

    • getConnectionTimeout

      java.lang.Integer getConnectionTimeout()
      Returns:
      The configured connection timeout expressed in seconds.

    • getClientIdPrefix

      java.lang.String getClientIdPrefix()
      Returns:
      The configured ClientId prefix to be used for shared connections.

    • getKeepAlive

      java.lang.Integer getKeepAlive()
      Returns:
      The configured keep alive interval expressed in seconds

    • getCumulUpstreamMessages

      java.lang.Long getCumulUpstreamMessages()
      Returns:
      The total (cumulative) number of MQTT messages flowing from clients to the configured MQTT broker.

    • getUpstreamMessageFrequency

      java.lang.Double getUpstreamMessageFrequency()
      Returns:
      The frequency of MQTT messages flowing from clients to the configured MQTT broker, in the last sampling period. It is expressed as messages per second; the value has a three decimal precision.

    • getMaxUpstreamMessageFrequency

      java.lang.Double getMaxUpstreamMessageFrequency()
      Returns:
      The maximum frequency of MQTT messages flowing from clients to the configured MQTT broker, reached in the life of the server. It is expressed as messages per second; the value has a three decimal precision.

    • getCumulDownstreamMessages

      java.lang.Long getCumulDownstreamMessages()
      Returns:
      The total (cumulative) number of MQTT messages flowing from the configured MQTT broker to clients.

    • getDownstreamMessageFrequency

      java.lang.Double getDownstreamMessageFrequency()
      Returns:
      The frequency of MQTT messages flowing from the configured MQTT broker to clients in the last sampling period. It is expressed as messages per second; the value has a three decimal precision.

    • getMaxDownstreamMessageFrequency

      java.lang.Double getMaxDownstreamMessageFrequency()
      Returns:
      The maximum frequency of MQTT messages flowing from the configured MQTT broker to clients, reached in the life of the server. It is expressed as messages per second; the value has a three decimal precision.

    • getClientConnections

      java.lang.Integer getClientConnections()
      Returns:
      The number of clients currently connected to the configured MQTT broker, reached in the life of the server.

    • getMaxClientConnections

      java.lang.Integer getMaxClientConnections()
      Returns:
      The maximum number of clients connected to the configured MQTT broker, reached in the life of the Server.

    • getClientIdList

      java.util.List<java.lang.String> getClientIdList()
      Returns:
      The list of client identifiers used by clients currently connected to the configured MQTT broker.

    • getTopicList

      java.util.List<java.lang.String> getTopicList()
      Returns:
      The list of MQTT topic filters currently subscribed to the configured MQTT broker.

    • getSharedBrokerConnections

      java.lang.Integer getSharedBrokerConnections()
      Returns:
      The number of shared connections currently established to the configured MQTT broker.

    • getMaxSharedBrokerConnections

      java.lang.Integer getMaxSharedBrokerConnections()
      Returns:
      The maximum number of shared connections established to the configured MQTT broker, reached in the life of the Server.

    • getDedicatedBrokerConnections

      java.lang.Integer getDedicatedBrokerConnections()
      Returns:
      The number of dedicated connections currently established to the configured MQTT broker.

    • getMaxDedicatedBrokerConnections

      java.lang.Integer getMaxDedicatedBrokerConnections()
      Returns:
      The maximum number of dedicated connections established to the configured MQTT broker, reached in the life of the server.

    • getBrokerConnections

      java.lang.Integer getBrokerConnections()
      Returns:
      The total number of broker connections (both shared and dedicated) currently established to the configured MQTT broker.

    • getMaxBrokerConnections

      java.lang.Integer getMaxBrokerConnections()
      Returns:
      The maximum total number of broker connections (both shared and dedicated) established to the configured MQTT broker, reached in the life of the Server.

    • getConnectionUIDList

      java.util.List<java.lang.String> getConnectionUIDList()
      Returns:
      The list of unique identifiers associated with the connections established to the configured MQTT broker.