SecurityHeaderPageCategory.java

/*
 * Copyright (c) 2002-2025, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.business.securityheader;

/**
 * security headers pages categories
 * Determines on which pages the security headers must be applied :
 * ALL : all pages
 * LOGOUT_BO : Back office (admin) logout page
 * LOGOUT_FO : Front office (portal) logout page
 * AUTHENTICATED_ADMIN_BACK_OFFICE : Back office (admin) pages with authentication
 * AUTHENTICATED_ADMIN_FRONT_OFFICE : Front office (portal) pages with authentication
 * 
 */
public enum SecurityHeaderPageCategory
{
	ALL( "all" ),
	LOGOUT_BO( "logout_BO" ),
	LOGOUT_FO( "logout_FO" ),
	AUTHENTICATED_ADMIN_BACK_OFFICE( "auth_admin_BO" ),
	AUTHENTICATED_ADMIN_FRONT_OFFICE( "auth_admin_FO" );

	private final String _code;
	
	/**
	 * Constructor
	 * 
	 * @param code
	 *           The code
	 */
	private SecurityHeaderPageCategory( String code ) 
	{
		this._code = code;
	}
	
	/**
	 * Returns code
	 * 
	 * @return code
	 */
	public String getCode( )
	{
		return _code;
	}
}