io.nexusrpc.handler

Enum HandlerException.ErrorType

java.lang.Object

java.lang.Enum<HandlerException.ErrorType>

io.nexusrpc.handler.HandlerException.ErrorType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HandlerException.ErrorType>

Enclosing class:

HandlerException

public static enum HandlerException.ErrorType
extends java.lang.Enum<HandlerException.ErrorType>

Error type that can occur on a handler exception.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST The server cannot or will not process the request due to an apparent client error.
INTERNAL An internal error occurred.
NOT_FOUND The requested resource could not be found but may be available in the future.
NOT_IMPLEMENTED The server either does not recognize the request method, or it lacks the ability to fulfill the request.
RESOURCE_EXHAUSTED Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
UNAUTHENTICATED The client did not supply valid authentication credentials for this request.
UNAUTHORIZED The caller does not have permission to execute the specified operation.
UNAVAILABLE The service is currently unavailable.
UNKNOWN The error type is unknown.
UPSTREAM_TIMEOUT Used by gateways to report that a request to an upstream server has timed out.

Method Summary

Modifier and Type	Method and Description
static HandlerException.ErrorType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HandlerException.ErrorType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final HandlerException.ErrorType UNKNOWN

The error type is unknown. Subsequent requests by the client are permissible.

BAD_REQUEST

public static final HandlerException.ErrorType BAD_REQUEST

The server cannot or will not process the request due to an apparent client error. Clients should not retry this request unless advised otherwise.

UNAUTHENTICATED

public static final HandlerException.ErrorType UNAUTHENTICATED

The client did not supply valid authentication credentials for this request. Clients should not retry this request unless advised otherwise.

UNAUTHORIZED

public static final HandlerException.ErrorType UNAUTHORIZED

The caller does not have permission to execute the specified operation. Clients should not retry this request unless advised otherwise.

NOT_FOUND

public static final HandlerException.ErrorType NOT_FOUND

The requested resource could not be found but may be available in the future. Clients should not retry this request unless advised otherwise.

RESOURCE_EXHAUSTED

public static final HandlerException.ErrorType RESOURCE_EXHAUSTED

Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. Subsequent requests by the client are permissible.

INTERNAL

public static final HandlerException.ErrorType INTERNAL

An internal error occurred. Subsequent requests by the client are permissible.

NOT_IMPLEMENTED

public static final HandlerException.ErrorType NOT_IMPLEMENTED

The server either does not recognize the request method, or it lacks the ability to fulfill the request. Clients should not retry this request unless advised otherwise.

UNAVAILABLE

public static final HandlerException.ErrorType UNAVAILABLE

The service is currently unavailable. Subsequent requests by the client are permissible.

UPSTREAM_TIMEOUT

public static final HandlerException.ErrorType UPSTREAM_TIMEOUT

Used by gateways to report that a request to an upstream server has timed out. Subsequent requests by the client are permissible.

Method Detail

values

public static HandlerException.ErrorType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HandlerException.ErrorType c : HandlerException.ErrorType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HandlerException.ErrorType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null