com.aoindustries.website.Constants Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2007-2009, 2016 by AO Industries, Inc.,
 * 7262 Bull Pen Cir, Mobile, Alabama, 36695, U.S.A.
 * All rights reserved.
 */
package com.aoindustries.website;

/**
 * Constants that may be used by other applications.
 *
 * @author  AO Industries, Inc.
 */
public class Constants {

	private Constants() {
	}

	/**
	 * The session key that stores when a "su" has been requested.
	 */
	public static final String SU_REQUESTED = "suRequested";

	/**
	 * The session key used to store the effective AOServConnector when the user has successfully authenticated.  Any "su" can change this.
	 */
	public static final String AO_CONN = "aoConn";

	/**
	 * The session key used to store the AOServConnector that the user has authenticated as.  "su" will not changes this.
	 */
	public static final String AUTHENTICATED_AO_CONN="authenticatedAoConn";

	/**
	 * The session key that stores the authentication target.
	 */
	public static final String AUTHENTICATION_TARGET="authenticationTarget";

	/**
	 * The request key used to store authentication messages.
	 */
	public static final String AUTHENTICATION_MESSAGE = "authenticationMessage";

	/**
	 * The session key used to store the current layout.  The layout setting
	 * affects the per-request skin selection.
	 */
	public static final String LAYOUT = "layout";

	/**
	 * The request key used to store the current Skin.
	 */
	public static final String SKIN = "skin";

	/**
	 * The request key used to store the current SiteSettings.
	 */
	public static final String SITE_SETTINGS = "siteSettings";

	/**
	 * The request key used to store the current Locale.
	 */
	public static final String LOCALE = "locale";

	/**
	 * The request key used to store the List<AOServPermission> that ALL must be allowed for the specified task.
	 */
	public static final String PERMISSION_DENIED = "permissionDenied";

	/**
	 * Until version 3.0 there will not be a getStatus method on the HttpServletResponse class.
	 * To allow code to detect the current status, anytime the status is set one should
	 * also set the request attribute of this name to a java.lang.Integer of the status.
	 */
	public static final String HTTP_SERVLET_RESPONSE_STATUS = "httpServletResponseStatus";
}