src/main/java/de/uapcore/lightpit/Constants.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2018 Mike Becker. 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, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * 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 HOLDER 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.
 *
 */
package de.uapcore.lightpit;

import static de.uapcore.lightpit.Functions.fqn;

/**
 * Contains all non-local scope constants used by the this application.
 * <p>
 * Constants with (class) local scope are defined in their respective classes.
 */
public final class Constants {
    /**
     * The path where the JSP files reside.
     */
    public static final String JSP_PATH_PREFIX = "/WEB-INF/jsp/";

    /**
     * The name of the generic JSP page that is displayed after a successful commit.
     */
    public static final String JSP_COMMIT_SUCCESSFUL = "commit-successful";

    /**
     * Name for the context parameter specifying the available languages.
     */
    public static final String CTX_ATTR_LANGUAGES = "available-languages";

    /**
     * Name for the context parameter optionally specifying a database schema.
     */
    public static final String CTX_ATTR_DB_SCHEMA = "db-schema";

    /**
     * Name for the context parameter optionally specifying a database dialect.
     */
    public static final String CTX_ATTR_DB_DIALECT = "db-dialect";

    /**
     * Key for the request attribute containing the {@link LightPITModule} information of the currently dispatching module.
     */
    public static final String REQ_ATTR_MODULE_INFO = fqn(AbstractLightPITServlet.class, "moduleInfo");

    /**
     * Key for the request attribute containing the menu list.
     */
    public static final String REQ_ATTR_MENU = fqn(AbstractLightPITServlet.class, "mainMenu");

    /**
     * Key for the request attribute containing the breadcrumb menu.
     */
    public static final String REQ_ATTR_BREADCRUMBS = fqn(AbstractLightPITServlet.class, "breadcrumbs");

    /**
     * Key for the request attribute containing the base href.
     */
    public static final String REQ_ATTR_BASE_HREF = fqn(AbstractLightPITServlet.class, "base_href");

    /**
     * Key for the request attribute containing the full path information (servlet path + path info).
     */
    public static final String REQ_ATTR_PATH = fqn(AbstractLightPITServlet.class, "path");

    /**
     * Key for the name of the page which should be rendered.
     */
    public static final String REQ_ATTR_CONTENT_PAGE = fqn(AbstractLightPITServlet.class, "content-page");

    /**
     * Key for the name of the additional stylesheet used by a module.
     */
    public static final String REQ_ATTR_STYLESHEET = fqn(AbstractLightPITServlet.class, "extraCss");

    /**
     * Key for a location the page shall redirect to.
     * Will be used in a meta element.
     */
    public static final String REQ_ATTR_REDIRECT_LOCATION = fqn(AbstractLightPITServlet.class, "redirectLocation");

    /**
     * Key for the current language selection within the session.
     */
    public static final String SESSION_ATTR_LANGUAGE = fqn(AbstractLightPITServlet.class, "language");

    /**
     * This class is not instantiatable.
     */
    private Constants() {
    }
}