Package io.micronaut.http
Enum Class HttpAttributes
- All Implemented Interfaces:
Serializable
,CharSequence
,Comparable<HttpAttributes>
,Constable
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 ConstantDescriptionAttribute used to store Available HTTP methods on the OPTIONS request.Attribute used to store any exception that may have occurred during request processing.Attribute used to store the cause of an error response.Attribute used to store the MethodInvocationContext by declarative client.Attribute used to store the MediaTypeCodec.The message body writer.Attribute used to store the HTTP method name, if required within the response.Attribute used to store thePrincipal
.Attribute used to store the object that represents the Route.Attribute used to store the object that represents the Route match.Attribute used to store the service ID a client request is being sent to.Attribute used to store the URI template defined by the route.Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionchar
charAt
(int index) int
length()
subSequence
(int start, int end) toString()
static HttpAttributes
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 interface java.lang.CharSequence
chars, codePoints, isEmpty
-
Enum Constant Details
-
PRINCIPAL
Attribute used to store thePrincipal
. -
ERROR
Attribute used to store any exception that may have occurred during request processing. -
ROUTE_MATCH
Attribute used to store the object that represents the Route match. -
ROUTE_INFO
Attribute used to store the object that represents the Route. -
URI_TEMPLATE
Attribute used to store the URI template defined by the route. -
METHOD_NAME
Attribute used to store the HTTP method name, if required within the response. -
SERVICE_ID
Attribute used to store the service ID a client request is being sent to. Used for tracing purposes. -
MEDIA_TYPE_CODEC
Attribute used to store the MediaTypeCodec. Used to override the registered codec per-request. -
INVOCATION_CONTEXT
Attribute used to store the MethodInvocationContext by declarative client. -
EXCEPTION
Attribute used to store the cause of an error response. -
X509_CERTIFICATE
Deprecated.UseHttpRequest.getCertificate()
insteadAttribute used to store a client Certificate (mutual authentication). -
AVAILABLE_HTTP_METHODS
Attribute used to store Available HTTP methods on the OPTIONS request. -
MESSAGE_BODY_WRITER
The message body writer.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
length
public int length()- Specified by:
length
in interfaceCharSequence
-
charAt
public char charAt(int index) - Specified by:
charAt
in interfaceCharSequence
-
subSequence
- Specified by:
subSequence
in interfaceCharSequence
-
toString
- Specified by:
toString
in interfaceCharSequence
- Overrides:
toString
in classEnum<HttpAttributes>
-
HttpRequest.getCertificate()
instead