Package org.apache.qpid.protonj2.client.exceptions

Class ClientConnectionRedirectedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.qpid.protonj2.client.exceptions.ClientException

org.apache.qpid.protonj2.client.exceptions.ClientIOException

org.apache.qpid.protonj2.client.exceptions.ClientConnectionRemotelyClosedException

org.apache.qpid.protonj2.client.exceptions.ClientConnectionRedirectedException

All Implemented Interfaces:

Serializable

public class ClientConnectionRedirectedException
extends ClientConnectionRemotelyClosedException

A ClientIOException type that defines that the remote peer has requested that this connection be redirected to some alternative peer. The redirect information can be obtained by calling the getRedirectionURI() method which return the URI of the peer the client is being redirect to.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientConnectionRedirectedException(String reason, ClientRedirect redirect, ErrorCondition condition)	Creates a new connection redirect exception with the provided redirection information.

Method Summary

Modifier and Type	Method	Description
String	getHostname()	the host name of the remote peer where the Connection is being redirected.
String	getNetworkHost()	A network level host name that matches either the DNS hostname or IP address of the remote container.
String	getPath()	The path value that should be used when connecting to the provided host and port.
int	getPort()	A network level port value that should be used when redirecting this connection.
URI	getRedirectionURI()	Attempt to construct a URI that represents the location where the redirect is sending the client Connection.
String	getScheme()	Returns the connection scheme that should be used when connecting to the remote host and port provided in this redirection.

Methods inherited from class org.apache.qpid.protonj2.client.exceptions.ClientConnectionRemotelyClosedException

getErrorCondition

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConnectionRedirectedException

public ClientConnectionRedirectedException(String reason,
                                           ClientRedirect redirect,
                                           ErrorCondition condition)

Creates a new connection redirect exception with the provided redirection information.

Parameters:

reason - The reason for the redirect

redirect - The ClientRedirect information object.

condition - The ErrorCondition that describes the redirection error.

Method Detail

getHostname

public String getHostname()

the host name of the remote peer where the Connection is being redirected.

This value should be used in the 'hostname' field of the Open frame, and during SASL negotiation (if used). When using this client to reconnect this value would be assigned to the ConnectionOptions.virtualHost(String) value in the ConnectionOptions passed to the newly created Connection.

Returns:

the host name of the remote AMQP container to redirect to.

getNetworkHost

public String getNetworkHost()

A network level host name that matches either the DNS hostname or IP address of the remote container.

Returns:

the network level host name value where the connection is being redirected.

getPort

public int getPort()

A network level port value that should be used when redirecting this connection.

Returns:

the network port value where the connection is being redirected.

getScheme

public String getScheme()

Returns the connection scheme that should be used when connecting to the remote host and port provided in this redirection.

Returns:

the connection scheme to use when redirecting to the provided host and port.

getPath

public String getPath()

The path value that should be used when connecting to the provided host and port.

Returns:

the path value that should be used when redirecting to the provided host and port.

getRedirectionURI

public URI getRedirectionURI()
                      throws Exception

Attempt to construct a URI that represents the location where the redirect is sending the client Connection.

Returns:

the URI that represents the redirection.

Throws:

Exception - if an error occurs while converting the redirect into a URI.