Package fr.gouv.vitam.ihmdemo.common.api

Enum IhmWebAppHeader

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<IhmWebAppHeader>
    public enum IhmWebAppHeader
extends java.lang.Enum<IhmWebAppHeader>
    Enum use to represent possible HTTP header for Vitam application. Also define a regular expression to check if values from HTTP headers are right

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COOKIE
      The COOKIE header, used to get an object
      LIMIT
      The X_LIMIT header, used to get an object
      OFFSET
      The X_OFFSET header, used to get an object
      REQUEST_ID
      The X_REQUEST_ID header, used to get an object
      TOTAL
      The X_TOTAL header, used to get an object

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static IhmWebAppHeader get​(java.lang.String headerName)
      Get VitamHttpHeader from name
      java.lang.String getName()
      Get the header name
      java.lang.String getRegExp()
      Get the regular expression to validate header values
      static IhmWebAppHeader valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static IhmWebAppHeader[] 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

      • LIMIT

        public static final IhmWebAppHeader LIMIT
        The X_LIMIT header, used to get an object

      • OFFSET

        public static final IhmWebAppHeader OFFSET
        The X_OFFSET header, used to get an object

      • TOTAL

        public static final IhmWebAppHeader TOTAL
        The X_TOTAL header, used to get an object

      • REQUEST_ID

        public static final IhmWebAppHeader REQUEST_ID
        The X_REQUEST_ID header, used to get an object

      • COOKIE

        public static final IhmWebAppHeader COOKIE
        The COOKIE header, used to get an object

    • Method Detail

      • values

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

      • valueOf

        public static IhmWebAppHeader 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

      • getName

        public java.lang.String getName()
        Get the header name
        Returns:
        the header name

      • getRegExp

        public java.lang.String getRegExp()
        Get the regular expression to validate header values
        Returns:
        the regular expression

      • get

        public static IhmWebAppHeader get​(java.lang.String headerName)
        Get VitamHttpHeader from name
        Parameters:
        headerName - the wanted header name
        Returns:
        the header if exists, null otherwise