org.picketbox.http.PicketBoxConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of picketbox-http
PicketBox is a security framework for Java Applications
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.picketbox.http;

import org.picketbox.core.UserContext;

/**
 * Define all constants
 *
 * @author anil saldhana
 * @since July 5, 2012
 */
public interface PicketBoxConstants {

    String AUTHENTICATION_KEY = "org.picketbox.authentication";

    String AUTH_SCHEME_LOADER = "authSchemeLoader";

    String AUTHZ_MGR = "org.picketbox.authorization.manager";

    String BASIC = "BASIC";

    String CLIENT_CERT = "CLIENT_CERT";

    String CREDENTIAL = "picketbox.credential";

    String DIGEST = "DIGEST";

    String FORM = "FORM";

    String HTTP_AUTHORIZATION_HEADER = "Authorization";

    String HTTP_BASIC = "Basic";

    String HTTP_CERTIFICATE = "javax.servlet.request.X509Certificate";

    String HTTP_DIGEST = "Digest";

    String HTTP_DIGEST_QOP_AUTH = "auth";

    String HTTP_FORM_J_SECURITY_CHECK = "/j_security_check";

    String HTTP_FORM_J_USERNAME = "j_username";

    String HTTP_FORM_J_PASSWORD = "j_password";

    String HTTP_WWW_AUTHENTICATE = "WWW-Authenticate";

    String MD5 = "MD5";

    String PRINCIPAL = "PRINCIPAL";

    String SERVLET_CONTEXT = "servletContext";

    String USERS_PROPERTIES = "users.properties";

    String UTF8 = "UTF-8";

    String USERNAME = "picketbox.username";

    /**
     * 
     * Defines the {@link HttpSession} attribute name used to store a {@link SavedRequest} instance.
     * 
     */
    String SAVED_REQUEST = "SAVED_REQUEST";

    /**
     * 
     * Defines the {@link ServletContext} attribute name used to store a {@link DefaultPicketBoxManager} instance.
     * 
     */
    String PICKETBOX_MANAGER = "PICKETBOX_MANAGER";

    /**
     * 
     * Defines the {@link HttpSession} attribute name used to store a {@link UserContext} instance.
     * 
     */
    String SUBJECT = "SUBJECT";

    /**
     * 
     * Defines the default URI used to start the logout process.
     * 
     */
    String LOGOUT_URI = "/picketbox_logout";

    /**
     * 
     * Defines the parameter name used to store a {@link ConfigurationBuilderProvider}.
     * 
     */
    String HTTP_CONFIGURATION_PROVIDER = "org.picketbox.configuration.provider";

    /**
     * 
     * Defines the http session parameter name used to store the authenticated {@link UserContext}.
     * 
     */
    String USER_ATTRIBUTE_NAME = "org.picketbox.http.session.user.attribute";
}