VitamHttpHeader.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/

package fr.gouv.vitam.common.server.application;

import fr.gouv.vitam.common.GlobalDataRest;

/**
 * Enum use to represent possible HTTP header for Vitam application. Also define a regular expression to check if values
 * from HTTP headers are right
 *
 */
public enum VitamHttpHeader {

    /**
     * The X_STRATEGY_ID header, used in HEAD requests to ask for a particular strategy </br>
     */
    // TODO P1 : change regex to be more precise (something like ^\s*\w+$ or \s*\w+\s*$)
    STRATEGY_ID(GlobalDataRest.X_STRATEGY_ID, ".+"),
    /**
     * The X_TENANT_ID header, used in requests to specify the used tenant</br>
     */
    // TODO P1 : change regex to be more precise (something like ^\s*\w+$ or \s*\w+\s*$)
    TENANT_ID(GlobalDataRest.X_TENANT_ID, ".+"),
    /**
     * The X_APPLICATION_ID header, used in requests to specify external Application Session Id</br>
     */
    // TODO P1 : change regex to be more precise (something like ^\s*\w+$ or \s*\w+\s*$)
    APPLICATION_ID(GlobalDataRest.X_APPLICATION_ID, ".+"),
    /**
     * The X-Http-Method-Override header, used in requests to handle unsupported Http methods with body
     */
    METHOD_OVERRIDE(GlobalDataRest.X_HTTP_METHOD_OVERRIDE, "get|patch|delete"),
    /**
     * The X-Qualifier header, used to get an object
     */
    QUALIFIER(GlobalDataRest.X_QUALIFIER, ".+"),
    /**
     * The X-Version header, used to get an object
     */
    VERSION(GlobalDataRest.X_VERSION, "[0-9]+"),
    /**
     * The X-Content-Length used to have object size (for storage)
     */
    X_CONTENT_LENGTH(GlobalDataRest.X_CONTENT_LENGTH, "[0-9]+"),
    
    /**
     * The X_DIGEST used to have digest value (for storage)
     */
    X_DIGEST(GlobalDataRest.X_DIGEST, ".+"),
    
    /**
     * The X_DIGEST_ALGORITHM used to have digest algrithm (for storage)
     */
    X_DIGEST_ALGORITHM(GlobalDataRest.X_DIGEST_ALGORITHM, ".+"),

    /**
     * The CONTEXT_ID header, used in POST and PUT requests to ask for a particular workflow execution context
     * stepBuStep or not </br>
     */
    // TODO P1 : change regex to be more precise (something like ^\s*\w+$ or \s*\w+\s*$)
    CONTEXT_ID(GlobalDataRest.X_CONTEXT_ID, ".+");


    private String name;
    private String regExp;

    /**
     * Constructor
     *
     * @param name the HTTP header name
     * @param regExp the regular expression to validate header values
     */
    VitamHttpHeader(String name, String regExp) {
        this.name = name;
        this.regExp = regExp;
    }

    /**
     * Get the header name
     *
     * @return the header name
     */
    public String getName() {
        return name;
    }

    /**
     * Get the regular expression to validate header values
     *
     * @return the regular expression
     */
    public String getRegExp() {
        return regExp;
    }

    /**
     * Get VitamHttpHeader from name
     *
     * @param headerName the wanted header name
     * @return the header if exists, null otherwise
     */
    public static VitamHttpHeader get(String headerName) {
        for (final VitamHttpHeader v : values()) {
            if (v.getName().equals(headerName)) {
                return v;
            }
        }
        return null;
    }

}