com.ibm.websphere.objectgrid
Class LockTimeoutException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.websphere.objectgrid.ObjectGridException
              com.ibm.websphere.objectgrid.LockException
                  com.ibm.websphere.objectgrid.LockTimeoutException

All Implemented Interfaces:

IObjectGridException, Serializable

Direct Known Subclasses:

LockDeadlockException, LockInternalFailureException

public class LockTimeoutException
extends LockException

This exception is used by the lock manager to indicate that the maximum wait time for a lock has been exceeded. The timeout may or may not be the result of a deadlock. If it is a deadlock, the timeout is used to break the deadlock.

Since:

WAS XD 6.0, XC10

See Also:

Serialized Form

Constructor Summary

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

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

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

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

Method Summary

void	forceJavaCore()
String	getLockRequestQueueDetails() Provides detailed information about the state of the lock queue when the lock timeout occurred.
String	getMessage() Returns the detail message string of this exception.
void	setLockRequestQueueDetails(String string) Sets the details of the lock requests on the lock request queue at the time the lock timeout occurred.

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

getCause, initCause

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, 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

LockTimeoutException

public LockTimeoutException()

Constructs a new LockTimeoutException 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)

LockTimeoutException

public LockTimeoutException(String message)

Constructs a new LockTimeoutException 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), getMessage()

LockTimeoutException

public LockTimeoutException(String message,
                            Throwable cause)

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

Note that the detail message associated with cause is not automatically incorporated in this LockTimeoutException'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:

ObjectGridException.getCause(), getMessage()

LockTimeoutException

public LockTimeoutException(Throwable cause)

Constructs a new LockTimeoutException 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 LockTimeoutExceptions 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()

Method Detail

getLockRequestQueueDetails

public String getLockRequestQueueDetails()

Provides detailed information about the state of the lock queue when the lock timeout occurred.

Returns:

the argument that was passed to the setLockRequestQueueDetails(String) method of this class or null if the setLockRequestQueueDetails method was not previously called for this object.

forceJavaCore

public void forceJavaCore()

setLockRequestQueueDetails

public void setLockRequestQueueDetails(String string)

Sets the details of the lock requests on the lock request queue at the time the lock timeout occurred.

Parameters:

string - the details of lock requests on the lock request queue at the time the lock timeout occurred.

getMessage

public String getMessage()

Returns the detail message string of this exception. The returned String includes the request queue details as well as the message provided to the constructor.

Overrides:

getMessage in class Throwable

Returns:

the detail message string of this object instance