com.ibm.websphere.objectgrid
Class ConnectException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.websphere.objectgrid.ObjectGridException
              com.ibm.websphere.objectgrid.ConnectException

All Implemented Interfaces:

IObjectGridException, Serializable

public class ConnectException
extends ObjectGridException

This exception is used to indicate that the client was unable to connect to the server

Since:

WAS XD 6.0.1, XC10

See Also:

Serialized Form

Field Summary

static int	BAD_CONFIGURATION This failure code indicates the provided configuration was corrupt.
static int	CONNECTION_REFUSED This failure code indicates that the server may not be available.
static int	FAILED_SECURITY This failure code indicates the a failure to authenticate.
static int	SERVER_DEFINITION_NOT_FOUND This failure code indicates the definition of cluster cannot be accessed.
static int	UNKNOWN This failure code indicates the reason for the connect failure is unknown.

Constructor Summary

ConnectException()
Constructs a new ConnectException with null as its detail message.

ConnectException(String message)
Constructs a new ConnectException with the specified detail message.

ConnectException(String message, int failureCode)
Constructs a new ConnectException with the specified detail message.

ConnectException(String message, Throwable cause)
Constructs a new ConnectException with the specified detail message and cause.

ConnectException(String message, Throwable cause, int failureCode)
Constructs a new ConnectException with the specified detail message and cause.

ConnectException(Throwable cause)
Constructs a new ConnectException with a specified cause.

Method Summary

int	getFailureCode() Returns the failure code that was set by one of the constructors that accepts a failure code, or UNKNOWN if one of the other constructors was called.

Methods inherited from class com.ibm.websphere.objectgrid.ObjectGridException

getCause, initCause

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

BAD_CONFIGURATION

public static final int BAD_CONFIGURATION

This failure code indicates the provided configuration was corrupt.

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

This failure code indicates the reason for the connect failure is unknown.

See Also:

Constant Field Values

FAILED_SECURITY

public static final int FAILED_SECURITY

This failure code indicates the a failure to authenticate.

See Also:

Constant Field Values

CONNECTION_REFUSED

public static final int CONNECTION_REFUSED

This failure code indicates that the server may not be available.

See Also:

Constant Field Values

SERVER_DEFINITION_NOT_FOUND

public static final int SERVER_DEFINITION_NOT_FOUND

This failure code indicates the definition of cluster cannot be accessed.

See Also:

Constant Field Values

Constructor Detail

ConnectException

public ConnectException()

Constructs a new ConnectException with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to the initCause method. In addition the failure code is initialized to UNKNOWN.

See Also:

ObjectGridException.initCause(Throwable), UNKNOWN

ConnectException

public ConnectException(String message)

Constructs a new ConnectException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to the initCause method. In addition the failure code is initialized to UNKNOWN.

Parameters:

message - the detail message. The detail message is saved for later retrieval by the getMessage method.

See Also:

ObjectGridException.initCause(Throwable), Throwable.getMessage(), UNKNOWN

ConnectException

public ConnectException(String message,
                        int failureCode)

Constructs a new ConnectException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to the initCause method.

Parameters:

message - the detail message. The detail message is saved for later retrieval by the getMessage method.

failureCode - the failure code which should be one of the constants of this exception class.

See Also:

ObjectGridException.initCause(Throwable), Throwable.getMessage(), getFailureCode()

ConnectException

public ConnectException(Throwable cause)

Constructs a new ConnectException with a specified cause. The cause and a detail message of (cause==null ? null : cause.toString()) is used (which typically contains the class and detail message of cause). This constructor is useful for ConnectExceptions that are little more than wrappers for other throwables. The failure code is initialized to UNKNOWN.

Parameters:

cause - is the exception that caused this exception to be thrown, which is saved for later retrieval by the getCause() method. A null value is permitted and indicates that the cause is nonexistent or is unknown.

See Also:

ObjectGridException.getCause(), UNKNOWN

ConnectException

public ConnectException(String message,
                        Throwable cause)

Constructs a new ConnectException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this ConnectException's detail message. The failure code is initialized to UNKNOWN.

Parameters:

message - the detail message (which is saved for later retrieval by the getMessage method).

cause - the cause (which is saved for later retrieval by the getCause method). (Anull value is permitted, and indicates that the cause is nonexistent or unknown).

See Also:

ObjectGridException.getCause(), Throwable.getMessage()

ConnectException

public ConnectException(String message,
                        Throwable cause,
                        int failureCode)

Constructs a new ConnectException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this ConnectException's detail message. The failure code is initialized to UNKNOWN.

Parameters:

message - the detail message (which is saved for later retrieval by the getMessage method).

cause - the cause (which is saved for later retrieval by the getCause method). (Anull value is permitted, and indicates that the cause is nonexistent or unknown).

failureCode - the failure code which should be one of the constants of this exception class.

See Also:

ObjectGridException.getCause(), Throwable.getMessage(), getFailureCode()

Method Detail

getFailureCode

public int getFailureCode()

Returns the failure code that was set by one of the constructors that accepts a failure code, or UNKNOWN if one of the other constructors was called.

Returns:

the failure code. One of the constants of this exception class.