org.waarp.gateway.kernel.rest

Enum RestArgument.REST_ROOT_FIELD

java.lang.Object

java.lang.Enum<RestArgument.REST_ROOT_FIELD>

org.waarp.gateway.kernel.rest.RestArgument.REST_ROOT_FIELD

All Implemented Interfaces:

Serializable, Comparable<RestArgument.REST_ROOT_FIELD>

Enclosing class:

RestArgument

public static enum RestArgument.REST_ROOT_FIELD
extends Enum<RestArgument.REST_ROOT_FIELD>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARG_BASEPATH arguments.path(ARG_BASEPATH).asText() = uri base path
ARG_HASBODY arguments.path(ARG_HASBODY).asBoolean() = true if the body has content
ARG_METHOD arguments.path(ARG_METHOD).asText() = method identified
ARG_PATH arguments.path(ARG_PATH) = uri path
ARG_X_AUTH_INTERNALKEY Internal Key used (not to be passed through wire)
ARG_X_AUTH_KEY arguments.path(ARG_X_AUTH_KEY).asText() = Key used
ARG_X_AUTH_ROLE arguments.path(ARG_X_AUTH_ROLE).asInt() = Role used
ARG_X_AUTH_TIMESTAMP arguments.path(ARG_X_AUTH_TIMESTAMP).asText() = Timestamp in ISO 8601 format
ARG_X_AUTH_USER arguments.path(ARG_X_AUTH_KEY).asText() = Key used
ARGS_SUBPATH arguments.path(ARGS_SUBPATH) main entry for SUB-PATH arguments arguments.path(ARGS_SUBPATH).elements() for an iterator or .get(x) for xth SUB-PATH argument
JSON_COMMAND
JSON_DETAIL
JSON_STATUSCODE
JSON_STATUSMESSAGE

Field Summary

Fields

Modifier and Type	Field and Description
String	field

Method Summary

Modifier and Type	Method and Description
static RestArgument.REST_ROOT_FIELD	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestArgument.REST_ROOT_FIELD[]	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

ARG_PATH

public static final RestArgument.REST_ROOT_FIELD ARG_PATH

arguments.path(ARG_PATH) = uri path

ARG_BASEPATH

public static final RestArgument.REST_ROOT_FIELD ARG_BASEPATH

arguments.path(ARG_BASEPATH).asText() = uri base path

ARGS_SUBPATH

public static final RestArgument.REST_ROOT_FIELD ARGS_SUBPATH

arguments.path(ARGS_SUBPATH) main entry for SUB-PATH arguments
arguments.path(ARGS_SUBPATH).elements() for an iterator or .get(x) for xth SUB-PATH argument

ARG_METHOD

public static final RestArgument.REST_ROOT_FIELD ARG_METHOD

arguments.path(ARG_METHOD).asText() = method identified

ARG_HASBODY

public static final RestArgument.REST_ROOT_FIELD ARG_HASBODY

arguments.path(ARG_HASBODY).asBoolean() = true if the body has content

ARG_X_AUTH_KEY

public static final RestArgument.REST_ROOT_FIELD ARG_X_AUTH_KEY

arguments.path(ARG_X_AUTH_KEY).asText() = Key used

ARG_X_AUTH_USER

public static final RestArgument.REST_ROOT_FIELD ARG_X_AUTH_USER

arguments.path(ARG_X_AUTH_KEY).asText() = Key used

ARG_X_AUTH_INTERNALKEY

public static final RestArgument.REST_ROOT_FIELD ARG_X_AUTH_INTERNALKEY

Internal Key used (not to be passed through wire)

ARG_X_AUTH_TIMESTAMP

public static final RestArgument.REST_ROOT_FIELD ARG_X_AUTH_TIMESTAMP

arguments.path(ARG_X_AUTH_TIMESTAMP).asText() = Timestamp in ISO 8601 format

ARG_X_AUTH_ROLE

public static final RestArgument.REST_ROOT_FIELD ARG_X_AUTH_ROLE

arguments.path(ARG_X_AUTH_ROLE).asInt() = Role used

JSON_STATUSCODE

public static final RestArgument.REST_ROOT_FIELD JSON_STATUSCODE

JSON_STATUSMESSAGE

public static final RestArgument.REST_ROOT_FIELD JSON_STATUSMESSAGE

JSON_COMMAND

public static final RestArgument.REST_ROOT_FIELD JSON_COMMAND

JSON_DETAIL

public static final RestArgument.REST_ROOT_FIELD JSON_DETAIL

Field Detail

field

public final String field

Method Detail

values

public static RestArgument.REST_ROOT_FIELD[] 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 (RestArgument.REST_ROOT_FIELD c : RestArgument.REST_ROOT_FIELD.values())
    System.out.println(c);

Returns:

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

valueOf

public static RestArgument.REST_ROOT_FIELD valueOf(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:

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

NullPointerException - if the argument is null