IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

com.ibm.websphere.objectgrid
Class AvailabilityException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by com.ibm.websphere.objectgrid.ObjectGridRuntimeException
                  extended by com.ibm.websphere.objectgrid.AvailabilityException
All Implemented Interfaces:
IObjectGridException, Serializable

public class AvailabilityException
extends ObjectGridRuntimeException

An AvailabilityException is thrown when a target is not in the proper state to handle a request that it receives.

Since:
WAS XD 6.1.0.3
See Also:
Serialized Form

Constructor Summary
AvailabilityException()
          Constructs a new AvailabilityException with null as its detail message.
AvailabilityException(String message)
          Constructs a new AvailabilityException with the specified detail message.
AvailabilityException(String message, Throwable cause)
          Constructs a new AvailabilityException with the specified detail message and cause.
AvailabilityException(Throwable cause)
          Constructs a new AvailabilityException with a specified cause.
 
Method Summary
 AvailabilityState getAvailabilityState()
           
 void setAvailabilityState(AvailabilityState availabilityState)
           
 
Methods inherited from class com.ibm.websphere.objectgrid.ObjectGridRuntimeException
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
 

Constructor Detail

AvailabilityException

public AvailabilityException()
Constructs a new AvailabilityException 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:
ObjectGridRuntimeException.initCause(Throwable)

AvailabilityException

public AvailabilityException(String message)
Constructs a new AvailabilityException 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:
ObjectGridRuntimeException.initCause(Throwable), Throwable.getMessage()

AvailabilityException

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

Note that the detail message associated with cause is not automatically incorporated in this AvailabilityException's 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:
ObjectGridRuntimeException.getCause(), Throwable.getMessage()

AvailabilityException

public AvailabilityException(Throwable cause)
Constructs a new AvailabilityException 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 AvailabilityException 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:
ObjectGridRuntimeException.getCause()
Method Detail

getAvailabilityState

public AvailabilityState getAvailabilityState()
Returns:
Returns the current availability tate of the shard.

setAvailabilityState

public void setAvailabilityState(AvailabilityState availabilityState)
Parameters:
availabilityState - The availabilityState to set.

IBM WebSphereTM eXtreme Scale, Release 8.6
API Specification

© Copyright International Business Machines Corp 2005,2012. All rights reserved.