Package org.apache.qpid.jms.provider.failover

Class FailoverProvider

  • All Implemented Interfaces:
    Provider, ProviderListener
    public class FailoverProvider
extends DefaultProviderListener
implements Provider
    A Provider Facade that provides services for detection dropped Provider connections and attempting to reconnect to a different remote peer. Upon establishment of a new connection the FailoverProvider will initiate state recovery of the active JMS framework resources.

    • Field Detail

      • DEFAULT_MAX_RECONNECT_ATTEMPTS

        public static final int DEFAULT_MAX_RECONNECT_ATTEMPTS
        See Also:
        Constant Field Values

      • DEFAULT_STARTUP_MAX_RECONNECT_ATTEMPTS

        public static final int DEFAULT_STARTUP_MAX_RECONNECT_ATTEMPTS
        See Also:
        Constant Field Values

      • DEFAULT_INITIAL_RECONNECT_DELAY

        public static final long DEFAULT_INITIAL_RECONNECT_DELAY
        See Also:
        Constant Field Values

      • DEFAULT_RECONNECT_DELAY

        public static final long DEFAULT_RECONNECT_DELAY
        See Also:
        Constant Field Values

      • DEFAULT_MAX_RECONNECT_DELAY

        public static final long DEFAULT_MAX_RECONNECT_DELAY

      • DEFAULT_USE_RECONNECT_BACKOFF

        public static final boolean DEFAULT_USE_RECONNECT_BACKOFF
        See Also:
        Constant Field Values

      • DEFAULT_RECONNECT_BACKOFF_MULTIPLIER

        public static final double DEFAULT_RECONNECT_BACKOFF_MULTIPLIER
        See Also:
        Constant Field Values

      • DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS

        public static final int DEFAULT_WARN_AFTER_RECONNECT_ATTEMPTS
        See Also:
        Constant Field Values

    • Method Detail

      • connect

        public void connect​(JmsConnectionInfo connectionInfo)
             throws ProviderException
        Description copied from interface: Provider
        Performs the initial low level connection for this provider such as TCP or SSL connection to a remote Broker. If this operation fails then the Provider is considered to be unusable and no further operations should be attempted using this Provider.
        Specified by:
        connect in interface Provider
        Parameters:
        connectionInfo - The JmsConnectionInfo that contains the properties that define this connection.
        Throws:
        ProviderException - if the remote resource can not be contacted.

      • start

        public void start()
           throws ProviderException,
                  IllegalStateException
        Description copied from interface: Provider
        Starts the Provider. The start method provides a place for the Provider to perform and pre-start configuration checks to ensure that the current state is valid and that all contracts have been met prior to starting.
        Specified by:
        start in interface Provider
        Throws:
        ProviderException - if an error occurs during start processing.
        IllegalStateException - if the Provider is improperly configured.

      • close

        public void close()
        Description copied from interface: Provider
        Closes this Provider terminating all connections and canceling any pending operations. The Provider is considered unusable after this call. This call is a blocking call and will not return until the Provider has closed or an error occurs.
        Specified by:
        close in interface Provider

      • create

        public void create​(JmsResource resource,
                   AsyncResult request)
            throws ProviderException
        Description copied from interface: Provider
        Create the Provider version of the given JmsResource. For each JMS Resource type the Provider implementation must create it's own internal representation and upon successful creation provide the caller with a response. The Provider should examine the given JmsResource to determine if the given configuration is supported or can be simulated, or is not supported in which case an exception should be thrown. It is possible for a Provider to indicate that it cannot complete a requested create either due to some mis-configuration such as bad login credentials on connection create by throwing a JMSException. If the Provider does not support creating of the indicated resource such as a Temporary Queue etc the provider may throw an UnsupportedOperationException to indicate this.
        Specified by:
        create in interface Provider
        Parameters:
        resource - The JmsResouce instance that indicates what is being created.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • start

        public void start​(JmsResource resource,
                  AsyncResult request)
           throws ProviderException
        Description copied from interface: Provider
        Starts the Provider version of the given JmsResource. For some JMS Resources it is necessary or advantageous to have a started state that must be triggered prior to it's normal use. An example of this would be a MessageConsumer which should not receive any incoming messages until the JMS layer is in a state to handle them. One such time would be after connection recovery. A JMS consumer should normally recover with it's prefetch value set to zero, or an AMQP link credit of zero and only open up the credit window once all Connection resources are restored. The provider is required to implement this method and not throw any error other than an ProviderException if a communication error occurs. The start operation is not required to have any effect on the provider resource but must not throw UnsupportedOperation etc.
        Specified by:
        start in interface Provider
        Parameters:
        resource - The JmsResouce instance that indicates what is being started.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • stop

        public void stop​(JmsResource resource,
                 AsyncResult request)
          throws ProviderException
        Description copied from interface: Provider
        Stops (pauses) the Provider version of the given JmsResource, the resource would then need to be started again via a call to start() For some JMS Resources it is necessary or advantageous to have a stopped state that can be triggered to stop the resource generating new events or messages. An example of this would be a JMS Session which should not receive any incoming messages for any consumers until the JMS layer is in a state to handle them. One such time would be during a transaction rollback. A JMS Session should normally ensure that messages received in a transaction are set to be redelivered prior to any new deliveries on a transaction rollback. The provider is required to implement this method and not throw any error other than an ProviderException if a communication error occurs. The stop operation is not required to have any effect on the provider resource but must not throw UnsupportedOperation etc.
        Specified by:
        stop in interface Provider
        Parameters:
        resource - The JmsResouce instance that indicates what is being stopped.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • destroy

        public void destroy​(JmsResource resourceId,
                    AsyncResult request)
             throws ProviderException
        Description copied from interface: Provider
        Instruct the Provider to dispose of a given JmsResource. The provider is given a JmsResource which it should use to remove any associated resources and inform the remote Broker instance of the removal of this resource. If the Provider cannot destroy the resource due to a non-communication error such as the logged in user not have role access to destroy the given resource it may throw an instance of JMSException to indicate such an error.
        Specified by:
        destroy in interface Provider
        Parameters:
        resourceId - The JmsResouce that identifies a previously created JmsResource.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • send

        public void send​(JmsOutboundMessageDispatch envelope,
                 AsyncResult request)
          throws ProviderException
        Description copied from interface: Provider
        Sends the JmsMessage contained in the outbound dispatch envelope.
        Specified by:
        send in interface Provider
        Parameters:
        envelope - the message envelope containing the JmsMessage to send.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • acknowledge

        public void acknowledge​(JmsSessionId sessionId,
                        ProviderConstants.ACK_TYPE ackType,
                        AsyncResult request)
                 throws ProviderException
        Description copied from interface: Provider
        Called to acknowledge all messages that have been delivered in a given session. This method is typically used by a Session that is configured for client acknowledge mode. The acknowledgement should only be applied to Messages that have been marked as delivered and not those still awaiting dispatch.
        Specified by:
        acknowledge in interface Provider
        Parameters:
        sessionId - the ID of the Session whose delivered messages should be acknowledged.
        ackType - The type of acknowledgement being done.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • acknowledge

        public void acknowledge​(JmsInboundMessageDispatch envelope,
                        ProviderConstants.ACK_TYPE ackType,
                        AsyncResult request)
                 throws ProviderException
        Description copied from interface: Provider
        Called to acknowledge a JmsMessage has been delivered, consumed, re-delivered...etc. The provider should perform an acknowledgement for the message based on the configured mode of the consumer that it was dispatched to and the capabilities of the protocol.
        Specified by:
        acknowledge in interface Provider
        Parameters:
        envelope - The message dispatch envelope containing the Message delivery information.
        ackType - The type of acknowledgement being done.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • commit

        public void commit​(JmsTransactionInfo transactionInfo,
                   JmsTransactionInfo nextTransactionInfo,
                   AsyncResult request)
            throws ProviderException
        Description copied from interface: Provider
        Called to commit an open transaction, and start a new one if a new transaction info object is provided. If this method throws an exception it is either because the commit failed, or the start of the next transaction failed. The caller can investigate the state of the provided next transaction object to determine if a new transaction was created. If the provider is unable to support transactions then it should throw an UnsupportedOperationException to indicate this. The Provider may also throw a JMSException to indicate a transaction was already rolled back etc.
        Specified by:
        commit in interface Provider
        Parameters:
        transactionInfo - the transaction info that describes the transaction being committed.
        nextTransactionInfo - the transaction info that describes the new transaction that should be created.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • rollback

        public void rollback​(JmsTransactionInfo transactionInfo,
                     JmsTransactionInfo nextTransactionInfo,
                     AsyncResult request)
              throws ProviderException
        Description copied from interface: Provider
        Called to roll back an open transaction, and start a new one if a new transaction info object is provided. If this method throws an exception it is either because the commit failed, or the start of the next transaction failed. The caller can investigate the state of the provided next transaction object to determine if a new transaction was created.
        Specified by:
        rollback in interface Provider
        Parameters:
        transactionInfo - the transaction info that describes the transaction being rolled back.
        nextTransactionInfo - the transaction info that describes the new transaction that should be created.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • recover

        public void recover​(JmsSessionId sessionId,
                    AsyncResult request)
             throws ProviderException
        Description copied from interface: Provider
        Called to recover all unacknowledged messages for a Session in client Ack mode.
        Specified by:
        recover in interface Provider
        Parameters:
        sessionId - the Id of the JmsSession that is recovering unacknowledged messages..
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • unsubscribe

        public void unsubscribe​(String subscription,
                        AsyncResult request)
                 throws ProviderException
        Description copied from interface: Provider
        Remove a durable topic subscription by name. A provider can throw an instance of JMSException to indicate that it cannot perform the un-subscribe operation due to bad security credentials etc.
        Specified by:
        unsubscribe in interface Provider
        Parameters:
        subscription - the name of the durable subscription that is to be removed.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • pull

        public void pull​(JmsConsumerId consumerId,
                 long timeout,
                 AsyncResult request)
          throws ProviderException
        Description copied from interface: Provider
        Request a remote peer send a Message to this client. A message pull request is usually only needed in the case where the client sets a zero prefetch limit on the consumer. If the consumer has a set prefetch that's greater than zero this method should just return without performing any action. timeout < 0 then it should remain open until a message is received. timeout = 0 then it returns a message or null if none available timeout > 0 then it should remain open for timeout amount of time. The timeout value when positive is given in milliseconds.
        Specified by:
        pull in interface Provider
        Parameters:
        consumerId - the ID of the Consumer instance that is attempt to pull a message from the remote.
        timeout - the amount of time to tell the remote peer to keep this pull request valid.
        request - The request object that should be signaled when this operation completes.
        Throws:
        ProviderException - if an error occurs or the Provider is already closed.

      • getMessageFactory

        public JmsMessageFactory getMessageFactory()
        Description copied from interface: Provider
        Gets the Provider specific Message factory for use in the JMS layer when a Session is asked to create a Message type. The Provider should implement it's own internal JmsMessage core to optimize read / write and marshal operations for the connection.
        Specified by:
        getMessageFactory in interface Provider
        Returns:
        a JmsMessageFactory instance for use by the JMS layer.

      • onConnectionFailure

        public void onConnectionFailure​(ProviderException ex)
        Description copied from interface: ProviderListener
        Called to indicate that the underlying connection to the Broker has been lost and the Provider will not perform any reconnect. Following this call the provider is in a failed state and further calls to it will throw an Exception.
        Specified by:
        onConnectionFailure in interface ProviderListener
        Overrides:
        onConnectionFailure in class DefaultProviderListener
        Parameters:
        ex - The exception that indicates the cause of this Provider failure.

      • onResourceClosed

        public void onResourceClosed​(JmsResource resource,
                             ProviderException cause)
        Description copied from interface: ProviderListener
        Called to indicate that a currently active resource has been closed due to some error condition, management request or some other action. This can either be initiated remotely or locally depending on the condition that triggers the close.
        Specified by:
        onResourceClosed in interface ProviderListener
        Overrides:
        onResourceClosed in class DefaultProviderListener
        Parameters:
        resource - the JmsResource instance that has been closed.
        cause - optional exception object that indicates the cause of the close.

      • add

        public void add​(URI uri)

      • remove

        public void remove​(URI uri)

      • getRemoteURI

        public URI getRemoteURI()
        Description copied from interface: Provider
        Returns the URI used to configure this Provider and specify the remote address of the Broker it connects to.
        Specified by:
        getRemoteURI in interface Provider
        Returns:
        the URI used to configure this Provider.

      • getAlternateURIs

        public List<URI> getAlternateURIs()
        Description copied from interface: Provider
        Returns a List of alternate remote peers (possibly found via discovery) to which the caller can attempt a recoonect should this provider connection fail. If there are no known alternates this method returns an empty List.
        Specified by:
        getAlternateURIs in interface Provider
        Returns:
        a List or alternate remote URIs that could be connected to later.

      • setProviderListener

        public void setProviderListener​(ProviderListener listener)
        Description copied from interface: Provider
        Sets the listener of events from this Provider instance.
        Specified by:
        setProviderListener in interface Provider
        Parameters:
        listener - The listener instance that will receive all event callbacks.

      • getProviderListener

        public ProviderListener getProviderListener()
        Description copied from interface: Provider
        Gets the currently set ProdiverListener instance.
        Specified by:
        getProviderListener in interface Provider
        Returns:
        the currently set ProviderListener instance.

      • isRandomize

        public boolean isRandomize()

      • setRandomize

        public void setRandomize​(boolean value)

      • getInitialReconnectDelay

        public long getInitialReconnectDelay()

      • setInitialReconnectDelay

        public void setInitialReconnectDelay​(long initialReconnectDelay)

      • getReconnectDelay

        public long getReconnectDelay()

      • setReconnectDelay

        public void setReconnectDelay​(long reconnectDealy)

      • getMaxReconnectDelay

        public long getMaxReconnectDelay()

      • setMaxReconnectDelay

        public void setMaxReconnectDelay​(long maxReconnectDelay)

      • getMaxReconnectAttempts

        public int getMaxReconnectAttempts()

      • setMaxReconnectAttempts

        public void setMaxReconnectAttempts​(int maxReconnectAttempts)

      • getStartupMaxReconnectAttempts

        public int getStartupMaxReconnectAttempts()

      • setStartupMaxReconnectAttempts

        public void setStartupMaxReconnectAttempts​(int startupMaxReconnectAttempts)

      • getWarnAfterReconnectAttempts

        public int getWarnAfterReconnectAttempts()
        Gets the current setting controlling how many Connect / Reconnect attempts must occur before a warn message is logged. A value of <= 0 indicates that there will be no warn message logged regardless of how many reconnect attempts occur.
        Returns:
        the current number of connection attempts before warn logging is triggered.

      • setWarnAfterReconnectAttempts

        public void setWarnAfterReconnectAttempts​(int warnAfterReconnectAttempts)
        Sets the number of Connect / Reconnect attempts that must occur before a warn message is logged indicating that the transport is not connected. This can be useful when the client is running inside some container or service as it gives an indication of some problem with the client connection that might not otherwise be visible. To disable the log messages this value should be set to a value <= 0
        Parameters:
        warnAfterReconnectAttempts - The number of failed connection attempts that must happen before a warning is logged.

      • getReconnectBackOffMultiplier

        public double getReconnectBackOffMultiplier()

      • setReconnectBackOffMultiplier

        public void setReconnectBackOffMultiplier​(double reconnectBackOffMultiplier)

      • isUseReconnectBackOff

        public boolean isUseReconnectBackOff()

      • setUseReconnectBackOff

        public void setUseReconnectBackOff​(boolean useReconnectBackOff)

      • getCloseTimeout

        public long getCloseTimeout()

      • getSendTimeout

        public long getSendTimeout()

      • getRequestTimeout

        public long getRequestTimeout()

      • getAmqpOpenServerListAction

        public String getAmqpOpenServerListAction()

      • setAmqpOpenServerListAction

        public void setAmqpOpenServerListAction​(String amqpOpenServerListAction)

      • newProviderFuture

        public ProviderFuture newProviderFuture()
        Description copied from interface: Provider
        Gets a ProviderFuture instance from the Provider for use in performing Provider calls that require an asynchronous completion to know when the call to the provider has succeeded or failed.
        Specified by:
        newProviderFuture in interface Provider
        Returns:
        a ProviderFuture for use in calling Provider methods that require a completion object.

      • newProviderFuture

        public ProviderFuture newProviderFuture​(ProviderSynchronization synchronization)
        Description copied from interface: Provider
        Gets a ProviderFuture instance from the Provider for use in performing Provider calls that require an asynchronous completion to know when the call to the provider has succeeded or failed.
        Specified by:
        newProviderFuture in interface Provider
        Parameters:
        synchronization - A ProviderSynchronization to assign to the resulting ProviderFuture.
        Returns:
        a ProviderFuture for use in calling Provider methods that require a completion object.

      • getRequestSweeperInterval

        protected final long getRequestSweeperInterval()