Package com.scaleout.client.caching

Enum Class RequestStatus

java.lang.Object
java.lang.Enum<RequestStatus>
com.scaleout.client.caching.RequestStatus
All Implemented Interfaces:
Serializable, Comparable<RequestStatus>, Constable
public enum RequestStatus extends Enum<RequestStatus>

The RequestStatus provides details on the status of a caching request.

For example, a read request that completes successfully will return RequestStatus.ObjectRetrieved.

  • Enum Constant Details

    • Success

      public static final RequestStatus Success
      The cache operation completed successfully.

    • ObjectRemoved

      public static final RequestStatus ObjectRemoved
      A cached object was removed from a ScaleOut cache.

    • ObjectAdded

      public static final RequestStatus ObjectAdded
      An object was added to the ScaleOut cache.

    • ObjectAddedAndLocked

      public static final RequestStatus ObjectAddedAndLocked
      An object was added with an exclusive lock to the ScaleOut cache.

    • ObjectUpdated

      public static final RequestStatus ObjectUpdated
      An object was updated in the ScaleOut cache.

    • ObjectUpdatedAndLockRetained

      public static final RequestStatus ObjectUpdatedAndLockRetained
      An object was updated and an exclusive lock was retained by the requester.

    • ObjectUpdatedAndUnlocked

      public static final RequestStatus ObjectUpdatedAndUnlocked
      An object was updated and an exclusive lock was released.

    • CacheCleared

      public static final RequestStatus CacheCleared
      The ScaleOut cache was cleared of all objects.

    • ObjectRetrieved

      public static final RequestStatus ObjectRetrieved
      An object was retrieved from the ScaleOut cache.

    • ObjectLocked

      public static final RequestStatus ObjectLocked
      An object in the ScaleOut cache was locked for exclusive access.

    • ObjectRetrievedAndLocked

      public static final RequestStatus ObjectRetrievedAndLocked
      An object was retrieved from the ScaleOut cache and locked for exclusive access.

    • ObjectAlreadyLocked

      public static final RequestStatus ObjectAlreadyLocked
      An object was already locked by another client.

    • LockLostError

      public static final RequestStatus LockLostError
      An exclusive lock timed out and then locked by another client.

    • ObjectUnlocked

      public static final RequestStatus ObjectUnlocked
      An object in the ScaleOut cache was unlocked.

    • GeoServerSuccessfulObjectTakeover

      public static final RequestStatus GeoServerSuccessfulObjectTakeover
      Note, requires GeoServer Pro. The local ScaleOut cache successfully took over object ownership from a remote ScaleOut cache.

    • GeoServerStaleRead

      public static final RequestStatus GeoServerStaleRead
      Note, requires GeoServer Pro. The local ScaleOut cache successfully retrieved an object and that object is stale.

    • ObjectError

      public static final RequestStatus ObjectError
      A general error occurred within the request. Retry the request.

    • NoMemory

      public static final RequestStatus NoMemory
      The ScaleOut store ran out of memory. This can typically be addressed by adding more memory to each ScaleOut host.

    • ObjectNotFound

      public static final RequestStatus ObjectNotFound
      The ScaleOut cache did not contain the request object.

    • WrongClient

      public static final RequestStatus WrongClient
      The ScaleOut cache rejected the request because the client was invalid. Retry the request.

    • NotLicensed

      public static final RequestStatus NotLicensed
      The client is not licensed to perform an operation.

    • NotReady

      public static final RequestStatus NotReady
      The ScaleOut store is not ready to perform the operation. Retry the request.

    • Timeout

      public static final RequestStatus Timeout
      The request timed out. Retry the request.

    • ReadPending

      public static final RequestStatus ReadPending
      The read request is pending. Retry the request.

    • ObjectVersionMismatch

      public static final RequestStatus ObjectVersionMismatch
      The version supplied didn't match the version in the store.

    • ObjectExists

      public static final RequestStatus ObjectExists
      The object already exists in the cache.

    • AuthNotNeeded

      public static final RequestStatus AuthNotNeeded
      The client requested authorization for a request which does not require authorization.

    • NotAuthorized

      public static final RequestStatus NotAuthorized
      The client is not authorized to perform an operation.

    • GeoServerRemoteAccessError

      public static final RequestStatus GeoServerRemoteAccessError
      Note, requires GeoServer Pro. The local ScaleOut store cannot access a remote ScaleOut store.

    • GeoServerNoActiveRemoteStore

      public static final RequestStatus GeoServerNoActiveRemoteStore
      Note, requires GeoServer Pro. The local ScaleOut store has no active remote ScaleOut store.

    • GeoServerLocalNameNotSet

      public static final RequestStatus GeoServerLocalNameNotSet
      Note, requires GeoServer Pro. The local ScaleOut store does not have GeoServer configured.

    • ProxyFound

      public static final RequestStatus ProxyFound
      Note, requires GeoServer Pro. The local ScaleOut cache returned the proxy version of an object.

    • NotImplemented

      public static final RequestStatus NotImplemented
      The request is not implemented. This can occur if the client is newer than the server.

    • WrongEpoch

      public static final RequestStatus WrongEpoch
      The event channel was established against an older version of the server. Recreate the event channel.

    • OperationFailed

      public static final RequestStatus OperationFailed
      The caching operation failed. Retry the request.

  • Method Details

    • values

      public static RequestStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RequestStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null