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
  • 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

      public static final HttpAttributes ROUTE
      Attribute used to store the object that represents the Route.
    • 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 metadata.
    • 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

      public static final HttpAttributes X509_CERTIFICATE
      Attribute used to store a client Certificate (mutual authentication).
    • AVAILABLE_HTTP_METHODS

      public static final HttpAttributes AVAILABLE_HTTP_METHODS
      Attribute used to store Available HTTP methods on the OPTIONS request.
  • 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>