Constants.java

/*
    Copyright 2009-2015 Josh Drummond

    This file is part of WebPasswordSafe.

    WebPasswordSafe is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    WebPasswordSafe 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with WebPasswordSafe; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
package net.webpasswordsafe.common.util;


/**
 * Common constants
 * 
 * @author Josh Drummond
 *
 */
public class Constants
{
    // versioning
    public static final String VERSION = "1.4";
    public static final String COPYRIGHT = "2008-2015 Josh Drummond";
    public static final String URL_WEBPASSWORDSAFE = "http://www.webpasswordsafe.net";
    public static final String URL_HELP =  "docs/UserGuide.html";
    public static final String URL_LICENSE = "docs/license.txt";
    
    // hardcoded names
    public static final String ADMIN_USER_NAME = "admin";
    public static final String EVERYONE_GROUP_NAME = "Everyone";
    
    // unique tokens
    public static final String SESSION_KEY_USERNAME = "X-WPS-Username";
    public static final String SESSION_KEY_ROLES = "X-WPS-Roles";
    public static final String CSRF_TOKEN_KEY = "X-WPS-CSRFToken";
    public static final String REST_AUTHN_USERNAME = "X-WPS-Username";
    public static final String REST_AUTHN_PASSWORD = "X-WPS-Password";
    public static final String REST_AUTHN_TOTP = "X-WPS-TOTP";

    // reports
    public static final String VIEW_REPORT_PREFIX = "VIEW_REPORT_";
    public static final String REPORT_PARAM_PREFIX = "p_";
    public static final String REPORT_TYPE_PDF = "pdf";
    public static final String REPORT_TYPE_CSV = "csv";
    
    // widget/report/rest fields
    public static final String ID = "id";
    public static final String FULLNAME = "fullname";
    public static final String NAME = "name";
    public static final String USERNAME = "username";
    public static final String USER = "user";
    public static final String GROUP = "group";
    public static final String PASSWORD = "password";
    public static final String DATE = "date";
    public static final String TITLE = "title";
    public static final String TAG = "tag";
    public static final String TAGS = "tags";
    public static final String NOTES = "notes";
    public static final String SUBJECT = "subject";
    public static final String ACCESSLEVEL = "accessLevel";
    public static final String PERMISSION = "permission";
    public static final String TEMPLATE = "template";
    public static final String TEMPLATEDETAIL = "templateDetail";
    public static final String VALUE = "value";
    public static final String I18N = "i18n";
    public static final String TYPES = "types";
    public static final String ROLE = "role";
    public static final String PARAMETERS = "parameters";
    public static final String REQUIRED = "required";
    public static final String TYPE = "type";
    public static final String BOOLEAN = "boolean";
    public static final String TEXT = "text";
    
    // enums
    public enum Match { OR, AND };
    public enum Role { ROLE_USER, ROLE_ADMIN };
    public enum Function { ADD_USER, UPDATE_USER, ADD_GROUP, UPDATE_GROUP, DELETE_GROUP, ADD_PASSWORD,
        BYPASS_PASSWORD_PERMISSIONS, ADD_TEMPLATE, UPDATE_TEMPLATE, BYPASS_TEMPLATE_SHARING,
        UNBLOCK_IP };
    public enum AuthenticationStatus { SUCCESS, FAILURE, TWO_STEP_REQ }

}