com.crankuptheamps.client

Class DefaultServerChooser

java.lang.Object

com.crankuptheamps.client.DefaultServerChooser

All Implemented Interfaces:

ServerChooser

public class DefaultServerChooser
extends java.lang.Object
implements ServerChooser

A simple ServerChooser that keeps a list of AMPS instances and Authenticators, and advances to the next one when failure occurs.

Constructor Summary

Constructors

Constructor and Description
DefaultServerChooser() Constructs a DefaultServerChooser instance with default settings.

Method Summary

Modifier and Type	Method and Description
DefaultServerChooser	add(java.lang.String uri) Adds a URI to self.
<T extends java.util.Collection<java.lang.String>> DefaultServerChooser	addAll(T uris) Adds URIs to self.
Authenticator	getCurrentAuthenticator() Returns the Authenticator instance associated with the current URI.
java.lang.String	getCurrentURI() Gets the current URI.
java.lang.String	getError() Provides additional details to be included in an exception thrown when the AMPS instance(s) are not available.
void	next() Advances to the next URI in the list of URIs.
void	reportFailure(java.lang.Exception exception, ConnectionInfo info) Called by HAClient when an error occurs connecting to the current URI, and/or when an error occurs logging on.
void	reportSuccess(ConnectionInfo info) Report success is not used in this implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultServerChooser

public DefaultServerChooser()

Constructs a DefaultServerChooser instance with default settings.

Method Detail

add

public DefaultServerChooser add(java.lang.String uri)

Adds a URI to self.

Parameters:

uri - The AMPS URI to add to the list.

Returns:

Returns this instance so that various operations can be chained together.

addAll

public <T extends java.util.Collection<java.lang.String>> DefaultServerChooser addAll(T uris)

Adds URIs to self.

Type Parameters:

T - A type that extends Collection<String>.

Parameters:

uris - The AMPS URIs to add to the list.

Returns:

Returns this instance so that various operations can be chained together.

getCurrentURI

public java.lang.String getCurrentURI()

Gets the current URI.

Specified by:

getCurrentURI in interface ServerChooser

Returns:

The current URI.

getCurrentAuthenticator

public Authenticator getCurrentAuthenticator()

Returns the Authenticator instance associated with the current URI.

Specified by:

getCurrentAuthenticator in interface ServerChooser

Returns:

Returns an Authenticator or null if none is required for logon.

reportFailure

public void reportFailure(java.lang.Exception exception,
                          ConnectionInfo info)
                   throws java.lang.Exception

Called by HAClient when an error occurs connecting to the current URI, and/or when an error occurs logging on. Implementors will likely advance the current URI to the next one in a list, or choose to stay with the current one, based on the exception type.

Specified by:

reportFailure in interface ServerChooser

Parameters:

exception - The exception associated with this failure.

info - Information about the connection that failed.

Throws:

java.lang.Exception - Allows any exception to be thrown: the exception will be reported to the ExceptionListener registered for the client

reportSuccess

public void reportSuccess(ConnectionInfo info)

Report success is not used in this implementation.

Specified by:

reportSuccess in interface ServerChooser

Parameters:

info - Information about the successful connection.

next

public void next()

Advances to the next URI in the list of URIs.

getError

public java.lang.String getError()

Provides additional details to be included in an exception thrown when the AMPS instance(s) are not available. Called by HAClient when creating an exception.

Specified by:

getError in interface ServerChooser

Returns:

Returns a String with information about the connection that failed and the reason for the failure. When no further information is available, returns an empty string.