Package com.adaptris.jmx.remote.jms

Interface JmsJmxConnectionFactory

  • All Superinterfaces:
    javax.jms.ConnectionFactory
    All Known Implementing Classes:
    JmsJmxConnectionFactoryImpl
    public interface JmsJmxConnectionFactory
extends javax.jms.ConnectionFactory
    Interface that defines additional functionality that is required to support JMX over JMS.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ATTR_BROKER_PASSWORD
      Key in the initial attributes that specifies the broker password to be associated the underlying ConnectionFactory .
      static java.lang.String ATTR_BROKER_USERNAME
      Key in the initial attributes that specifies the broker user to be associated the underlying ConnectionFactory .
      static java.lang.String ATTR_CLIENT_ID
      Key in the initial attributes that specifies the clientid to be associated the underlying ConnectionFactory.
      static java.lang.String ATTR_DESTINATION
      Key in the initial attributes that specifies the destination.
      static java.lang.String ATTR_DESTINATION_TYPE
      Key in the initial attributes that specifies the destination type (either "Topic" or "Queue")
      static java.lang.String ATTR_RETRY_INTERVAL_MS
      Key in the initial attributes that controls the interval (ms) between attempts to connect to the given broker.
      static java.lang.String ATTR_TIMEOUT_MS
      Key in the initial attributes that specifies the timeout value for operations in milliseconds.
      static long DEFAULT_RETRY_INTERVAL_MS
      The default value associated with ATTR_RETRY_INTERVAL_MS which is 30000L .
      static long DEFAULT_TIMEOUT_MS
      The default value associated with ATTR_TIMEOUT_MS which is 60000L .

    • Field Detail

      • ATTR_DESTINATION

        static final java.lang.String ATTR_DESTINATION
        Key in the initial attributes that specifies the destination.

        The value in the initial attributes can by overriden by specifying this as part of the query portion of the JMXServiceURL.

        See Also:
        Constant Field Values

      • ATTR_DESTINATION_TYPE

        static final java.lang.String ATTR_DESTINATION_TYPE
        Key in the initial attributes that specifies the destination type (either "Topic" or "Queue")

        The value in the initial attributes can by overriden by specifying this as part of the query portion of the JMXServiceURL.

        See Also:
        Constant Field Values

      • ATTR_TIMEOUT_MS

        static final java.lang.String ATTR_TIMEOUT_MS
        Key in the initial attributes that specifies the timeout value for operations in milliseconds.

        The value in the initial attributes can by overriden by specifying this as part of the query portion of the JMXServiceURL.

        See Also:
        DEFAULT_TIMEOUT_MS, Constant Field Values

      • ATTR_CLIENT_ID

        static final java.lang.String ATTR_CLIENT_ID
        Key in the initial attributes that specifies the clientid to be associated the underlying ConnectionFactory.

        The value in the initial attributes can by overriden by specifying this as part of the query portion of the JMXServiceURL.

        See Also:
        Constant Field Values

      • ATTR_BROKER_USERNAME

        static final java.lang.String ATTR_BROKER_USERNAME
        Key in the initial attributes that specifies the broker user to be associated the underlying ConnectionFactory .

        The value in the initial attributes can by overriden by specifying this as part of the query portion of the JMXServiceURL. Where appropriate then the values stored against the standard key JMXConnector.CREDENTIALS will supersede both this key and any query parameter.

        See Also:
        Constant Field Values

      • ATTR_BROKER_PASSWORD

        static final java.lang.String ATTR_BROKER_PASSWORD
        Key in the initial attributes that specifies the broker password to be associated the underlying ConnectionFactory .

        The value in the initial attributes can by overriden by specifying this as part of the query portion of the JMXServiceURL. Where appropriate then the values stored against the standard key JMXConnector.CREDENTIALS will supersede both this key and any query parameter.

        See Also:
        Constant Field Values

      • ATTR_RETRY_INTERVAL_MS

        static final java.lang.String ATTR_RETRY_INTERVAL_MS
        Key in the initial attributes that controls the interval (ms) between attempts to connect to the given broker.

        This value comes into play when the JMS broker is unavailable or an exception has occured with the connection. The underlying JMXConnector or JMXConnectorServer will not process any requests until a connection succeeds.

        See Also:
        DEFAULT_RETRY_INTERVAL_MS, Constant Field Values

    • Method Detail

      • getTargetDestination

        javax.jms.Destination getTargetDestination()
                                    throws javax.jms.JMSException
        Get the target dstination where you want to send requests and other things to.
        Returns:
        the destination.
        Throws:
        javax.jms.JMSException

      • createInvokerProxy

        com.adaptris.jmx.remote.jms.JmsInvokerProxy createInvokerProxy()
                                                        throws javax.jms.JMSException
        Create the invoker proxy.
        Returns:
        a JmsInvokerProxy instance.
        Throws:
        javax.jms.JMSException - if there was an problem creating the invoker proxy.

      • createTemporaryDestination

        javax.jms.Destination createTemporaryDestination​(javax.jms.Session s)
                                          throws javax.jms.JMSException
        Create a temporary destination (either a queue or a topic).
        Parameters:
        s - the session
        Returns:
        a TemporaryQueue or TemporaryTopic.
        Throws:
        javax.jms.JMSException - if there was an error creating the temporary destination.

      • destroy

        void destroy()
        Destroy any resources that may need destroying.