Package io.micronaut.http

Enum Class HttpAttributes

java.lang.Object

java.lang.Enum<HttpAttributes>

io.micronaut.http.HttpAttributes

All Implemented Interfaces:

Serializable, CharSequence, Comparable<HttpAttributes>, Constable

public enum HttpAttributes
extends Enum<HttpAttributes>
implements CharSequence

Common HTTP attributes.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVAILABLE_HTTP_METHODS	Deprecated, for removal: This API element is subject to removal in a future version. Not used anymore
ERROR	Attribute used to store any exception that may have occurred during request processing.
EXCEPTION	Attribute used to store the cause of an error response.
HEAD_BODY	Body that was discarded because this is a HEAD response.
INVOCATION_CONTEXT	Attribute used to store the MethodInvocationContext by declarative client.
MEDIA_TYPE_CODEC	Attribute used to store the MediaTypeCodec.
MESSAGE_BODY_WRITER	The message body writer.
METHOD_NAME	Attribute used to store the HTTP method name, if required within the response.
PRINCIPAL	Attribute used to store the Principal.
ROUTE_INFO	Attribute used to store the object that represents the Route.
ROUTE_MATCH	Attribute used to store the object that represents the Route match.
SERVICE_ID	Attribute used to store the service ID a client request is being sent to.
URI_TEMPLATE	Attribute used to store the URI template defined by the route.
X509_CERTIFICATE	Deprecated. Use HttpRequest.getCertificate() instead

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)
int	length()
CharSequence	subSequence(int start, int end)
String	toString()
static HttpAttributes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HttpAttributes[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints, isEmpty

Enum Constant Details

PRINCIPAL

public static final HttpAttributes PRINCIPAL

Attribute used to store the Principal.

ERROR

public static final HttpAttributes ERROR

Attribute used to store any exception that may have occurred during request processing.

ROUTE_MATCH

public static final HttpAttributes ROUTE_MATCH

Attribute used to store the object that represents the Route match.

ROUTE_INFO

public static final HttpAttributes ROUTE_INFO

Attribute used to store the object that represents the Route.

URI_TEMPLATE

public static final HttpAttributes URI_TEMPLATE

Attribute used to store the URI template defined by the route.

METHOD_NAME

public static final HttpAttributes METHOD_NAME

Attribute used to store the HTTP method name, if required within the response.

SERVICE_ID

public static final HttpAttributes SERVICE_ID

Attribute used to store the service ID a client request is being sent to. Used for tracing purposes.

MEDIA_TYPE_CODEC

public static final HttpAttributes MEDIA_TYPE_CODEC

Attribute used to store the MediaTypeCodec. Used to override the registered codec per-request.

INVOCATION_CONTEXT

public static final HttpAttributes INVOCATION_CONTEXT

Attribute used to store the MethodInvocationContext by declarative client.

EXCEPTION

public static final HttpAttributes EXCEPTION

Attribute used to store the cause of an error response.

X509_CERTIFICATE

@Deprecated
public static final HttpAttributes X509_CERTIFICATE

Deprecated.

Use HttpRequest.getCertificate() instead

Attribute used to store a client Certificate (mutual authentication).

AVAILABLE_HTTP_METHODS

@Deprecated(forRemoval=true,
            since="4.7")
public static final HttpAttributes AVAILABLE_HTTP_METHODS

Deprecated, for removal: This API element is subject to removal in a future version.

Not used anymore

Attribute used to store Available HTTP methods on the OPTIONS request.

MESSAGE_BODY_WRITER

public static final HttpAttributes MESSAGE_BODY_WRITER

The message body writer.

HEAD_BODY

public static final HttpAttributes HEAD_BODY

Body that was discarded because this is a HEAD response.

Method Details

values

public static HttpAttributes[] 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 HttpAttributes 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

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Enum<HttpAttributes>