Enum HttpAttributes

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.CharSequence, java.lang.Comparable<HttpAttributes>

    public enum HttpAttributes
    extends java.lang.Enum<HttpAttributes>
    implements java.lang.CharSequence
    Common HTTP attributes.
    Since:
    1.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AVAILABLE_HTTP_METHODS
      Attribute used to store Available HTTP methods on the OPTIONS request.
      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.
      INVOCATION_CONTEXT
      Attribute used to store the MethodInvocationContext by declarative client.
      MEDIA_TYPE_CODEC
      Attribute used to store the MediaTypeCodec.
      METHOD_NAME
      Attribute used to store the HTTP method name, if required within the response.
      PRINCIPAL
      Attribute used to store the Principal.
      ROUTE
      Attribute used to store the object that represents the Route.
      ROUTE_INFO
      Attribute used to store the object that represents the Route metadata.
      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
      Attribute used to store a client Certificate (mutual authentication).
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      char charAt​(int index)  
      int length()  
      java.lang.CharSequence subSequence​(int start, int end)  
      java.lang.String toString()  
      static HttpAttributes valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HttpAttributes[] 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, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.lang.CharSequence

        chars, codePoints
    • Enum Constant Detail

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

      • values

        public static HttpAttributes[] 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 (HttpAttributes c : HttpAttributes.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static HttpAttributes 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
      • length

        public int length()
        Specified by:
        length in interface java.lang.CharSequence
      • charAt

        public char charAt​(int index)
        Specified by:
        charAt in interface java.lang.CharSequence
      • subSequence

        public java.lang.CharSequence subSequence​(int start,
                                                  int end)
        Specified by:
        subSequence in interface java.lang.CharSequence
      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface java.lang.CharSequence
        Overrides:
        toString in class java.lang.Enum<HttpAttributes>