org.apache.qpid.jms.provider.discovery

Class DiscoveryProvider

java.lang.Object

org.apache.qpid.jms.provider.ProviderWrapper<FailoverProvider>

org.apache.qpid.jms.provider.discovery.DiscoveryProvider

All Implemented Interfaces:

DiscoveryListener, Provider, ProviderListener

public class DiscoveryProvider
extends ProviderWrapper<FailoverProvider>
implements DiscoveryListener

An Provider instance that wraps the FailoverProvider and listens for events about discovered remote peers using a configured set of DiscoveryAgent instance.

Field Summary

Fields inherited from class org.apache.qpid.jms.provider.ProviderWrapper

listener, next

Constructor Summary

Constructors

Constructor and Description
DiscoveryProvider(URI discoveryUri, FailoverProvider next) Creates a new instance of the DiscoveryProvider.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this Provider terminating all connections and canceling any pending operations.
List<DiscoveryAgent>	getDiscoveryAgents()
URI	getDiscoveryURI()
void	onConnectionInterrupted(URI remoteURI) Called from a fault tolerant Provider instance to signal that the underlying connection to the Broker has been lost.
void	onConnectionRestored(URI remoteURI) Called to signal that all recovery operations are now complete and the Provider is again in a normal connected state.
void	onServiceAdd(URI remoteURI) Called when a DiscoveryAgent becomes aware of a new remote peer.
void	onServiceRemove(URI remoteURI) Called when a DiscoveryAgent can no longer detect a previously known remote peer.
void	setDiscoveryAgents(List<DiscoveryAgent> agents) Sets the discovery agents used by this provider to locate remote peer instance.
void	start() Starts the Provider.

Methods inherited from class org.apache.qpid.jms.provider.ProviderWrapper

acknowledge, acknowledge, commit, connect, create, destroy, getMessageFactory, getNext, getProviderListener, getRemoteURI, onConnectionEstablished, onConnectionFailure, onConnectionRecovered, onConnectionRecovery, onInboundMessage, onProviderException, onResourceRemotelyClosed, pull, recover, rollback, send, setProviderListener, start, stop, unsubscribe

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiscoveryProvider

public DiscoveryProvider(URI discoveryUri,
                         FailoverProvider next)

Creates a new instance of the DiscoveryProvider. The Provider is created and initialized with the original URI used to create it, and an instance of a FailoverProcider which it will use to initiate and maintain connections to the discovered peers.

Parameters:

discoveryUri - The URI that configures the discovery provider.

next - The FailoverProvider that will be used to manage connections.

Method Detail

start

public void start()
           throws IOException,
                  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

Overrides:

start in class ProviderWrapper<FailoverProvider>

Throws:

IOException - 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

Overrides:

close in class ProviderWrapper<FailoverProvider>

getDiscoveryURI

public URI getDiscoveryURI()

Returns:

the original URI used to configure this DiscoveryProvider.

getDiscoveryAgents

public List<DiscoveryAgent> getDiscoveryAgents()

Returns:

a list of configured DiscoveryAgent instances used by this DiscoveryProvider.

setDiscoveryAgents

public void setDiscoveryAgents(List<DiscoveryAgent> agents)

Sets the discovery agents used by this provider to locate remote peer instance.

Parameters:

agents - the agents to use to discover remote peers

onServiceAdd

public void onServiceAdd(URI remoteURI)

Description copied from interface: DiscoveryListener

Called when a DiscoveryAgent becomes aware of a new remote peer.

Specified by:

onServiceAdd in interface DiscoveryListener

Parameters:

remoteURI - the URI of the newly discovered peer.

onServiceRemove

public void onServiceRemove(URI remoteURI)

Description copied from interface: DiscoveryListener

Called when a DiscoveryAgent can no longer detect a previously known remote peer.

Specified by:

onServiceRemove in interface DiscoveryListener

Parameters:

remoteURI - the URI of the previously discovered peer that is no longer active.

onConnectionInterrupted

public void onConnectionInterrupted(URI remoteURI)

Description copied from interface: ProviderListener

Called from a fault tolerant Provider instance to signal that the underlying connection to the Broker has been lost. The Provider will attempt to reconnect following this event unless closed. It is considered a programming error to allow any exceptions to be thrown from this notification method.

Specified by:

onConnectionInterrupted in interface ProviderListener

Overrides:

onConnectionInterrupted in class ProviderWrapper<FailoverProvider>

Parameters:

remoteURI - The URI of the Broker whose connection was lost.

onConnectionRestored

public void onConnectionRestored(URI remoteURI)

Description copied from interface: ProviderListener

Called to signal that all recovery operations are now complete and the Provider is again in a normal connected state. It is considered a programming error to allow any exceptions to be thrown from this notification method.

Specified by:

onConnectionRestored in interface ProviderListener

Overrides:

onConnectionRestored in class ProviderWrapper<FailoverProvider>

Parameters:

remoteURI - The URI of the Broker that the client has now connected to.