com.ibm.websphere.objectgrid
Class ZoneConfigurationException

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

All Implemented Interfaces:

IObjectGridException, Serializable

public class ZoneConfigurationException
extends ObjectGridException

This exception is thrown when a container is started in an incompatible zone or when a problem has been detected with the zone configuration within the deployment policy. A container can be placed into a custom zone by specifying the zone name when the container is started. When no zone name is specified, the container is placed into the DefaultZone. When containers have been started in one or more custom zones for a particular ObjectGrid, it is an error to start a subsequent container in the DefaultZone for that ObjectGrid. A ZoneConfigurationException will be thrown when this is detected. Similarly, when containers are started in the DefaultZone for a particular ObjectGrid, it is an error to start a subsequent container in a custom zone for that ObjectGrid. A ZoneConfigurationException will be thrown in this case. A container's deployment policy is validated when the container starts. Validation is done on zone configuration within the deployment policy if zones are configured. If a problem is found with the zone configuration this exception is thrown.

Since:

WAS XD 6.1 FIX3

See Also:

Serialized Form

Field Summary

static int	CONTAINER_NOT_ALLOWED_IN_CUSTOM_ZONE One of the error codes for this exception.
static int	CONTAINER_NOT_ALLOWED_IN_DEFAULT_ZONE One of the error codes for this exception.
static int	GENERIC A generic error code.

Constructor Summary

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

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

ZoneConfigurationException(String message, int errorCode)
Constructs a new ZoneConfigurationException with the specified detail message and error code.

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

ZoneConfigurationException(String message, Throwable cause, int errorCode)
Constructs a new ZoneConfigurationException with the specified detail message, cause, and error code.

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

Method Summary

int	getErrorCode() Returns the error code that was set by one of the constructors that accepts an error code, or GENERIC 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

GENERIC

public static final int GENERIC

A generic error code. See the exception message for more detail.

See Also:

Constant Field Values

CONTAINER_NOT_ALLOWED_IN_DEFAULT_ZONE

public static final int CONTAINER_NOT_ALLOWED_IN_DEFAULT_ZONE

One of the error codes for this exception. When containers have already been started in one or more custom zones for a particular ObjectGrid, it is an error to start a subsequent container within the DefaultZone for the same ObjectGrid.

See Also:

ServerProperties.DEFAULT_ZONE, Constant Field Values

CONTAINER_NOT_ALLOWED_IN_CUSTOM_ZONE

public static final int CONTAINER_NOT_ALLOWED_IN_CUSTOM_ZONE

One of the error codes for this exception. When containers have already been started in the DefaultZone for a particular ObjectGrid, it is an error to start a subsequent container within a custom zone for the same ObjectGrid.

See Also:

ServerProperties.DEFAULT_ZONE, Constant Field Values

Constructor Detail

ZoneConfigurationException

public ZoneConfigurationException()

Constructs a new ZoneConfigurationException with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to the initCause method.

See Also:

ObjectGridException.initCause(Throwable)

ZoneConfigurationException

public ZoneConfigurationException(String message)

Constructs a new ZoneConfigurationException 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.

See Also:

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

ZoneConfigurationException

public ZoneConfigurationException(String message,
                                  int errorCode)

Constructs a new ZoneConfigurationException with the specified detail message and error code. 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.

errorCode - the errorCode corresponds to one of the constants of this class

See Also:

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

ZoneConfigurationException

public ZoneConfigurationException(Throwable cause)

Constructs a new ZoneConfigurationException 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 ZoneConfigurationException that are little more than wrappers for other throwables.

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()

ZoneConfigurationException

public ZoneConfigurationException(String message,
                                  Throwable cause)

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

Note that the detail message associated with cause is not automatically incorporated in this ZoneConfigurationException detail message.

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()

ZoneConfigurationException

public ZoneConfigurationException(String message,
                                  Throwable cause,
                                  int errorCode)

Constructs a new ZoneConfigurationException with the specified detail message, cause, and error code.

Note that the detail message associated with cause is not automatically incorporated in this ZoneConfigurationException detail message.

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).

errorCode - the errorCode corresponds to one of the constants of this class

See Also:

ObjectGridException.getCause(), Throwable.getMessage()

Method Detail

getErrorCode

public int getErrorCode()

Returns the error code that was set by one of the constructors that accepts an error code, or GENERIC if one of the other constructors was called.

Returns:

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