Method Detail

• getCurrentURI

  java.lang.String getCurrentURI()

  Returns the current URI.

  Returns:

  A string with the URI to connect to, or null if no server is available to connect to.

• getCurrentAuthenticator

  Authenticator getCurrentAuthenticator()
                                 throws java.lang.Exception

  Returns the Authenticator instance associated with the current URI.

  Returns:

  An Authenticator or null if none is required for logon.

  Throws:

  java.lang.Exception - unable to create an authenticator: typically wraps an exception that describes the actual failure

• reportFailure

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

  Called by the 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.

  Parameters:

  exception - The exception associated with this failure.

  info - Information about the connection that failed.

  Throws:

  java.lang.Exception - indicates that the failure is unrecoverable and stops the connection process

• getError

  java.lang.String getError()

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

  Returns:

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

• reportSuccess

  void reportSuccess(ConnectionInfo info)

  Called by the HAClient when successfully connected and logged on to the current instance.

  Parameters:

  info - Information about the successful connection.