LightPIT: src/main/java/de/uapcore/lightpit/Constants.java@0a658e53177c

     1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

     3  *

     4  * Copyright 2018 Mike Becker. All rights reserved.

     5  *

     6  * Redistribution and use in source and binary forms, with or without

     7  * modification, are permitted provided that the following conditions are met:

     8  *

     9  *   1. Redistributions of source code must retain the above copyright

    10  *      notice, this list of conditions and the following disclaimer.

    11  *

    12  *   2. Redistributions in binary form must reproduce the above copyright

    13  *      notice, this list of conditions and the following disclaimer in the

    14  *      documentation and/or other materials provided with the distribution.

    15  *

    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE

    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

    26  * POSSIBILITY OF SUCH DAMAGE.

    27  *

    28  */

    29 package de.uapcore.lightpit;

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

    33 /**

    34  * Contains all non-local scope constants used by the this application.

    35  * <p>

    36  * Constants with (class) local scope are defined in their respective classes.

    37  */

    38 public final class Constants {

    39     /**

    40      * The path where the JSP files reside.

    41      */

    42     public static final String JSP_PATH_PREFIX = "/WEB-INF/jsp/";

    44     /**

    45      * The name of the generic JSP page that is displayed after a successful commit.

    46      */

    47     public static final String JSP_COMMIT_SUCCESSFUL = "commit-successful";

    49     /**

    50      * Name for the context parameter specifying the available languages.

    51      */

    52     public static final String CTX_ATTR_LANGUAGES = "available-languages";

    54     /**

    55      * Name for the context parameter optionally specifying a database schema.

    56      */

    57     public static final String CTX_ATTR_DB_SCHEMA = "db-schema";

    59     /**

    60      * Name for the context parameter optionally specifying a database dialect.

    61      */

    62     public static final String CTX_ATTR_DB_DIALECT = "db-dialect";

    64     /**

    65      * Key for the request attribute containing the resource bundle name.

    66      */

    67     public static final String REQ_ATTR_RESOURCE_BUNDLE = fqn(AbstractLightPITServlet.class, "bundleName");

    69     /**

    70      * Key for the request attribute containing the menu list.

    71      */

    72     public static final String REQ_ATTR_MENU = fqn(AbstractLightPITServlet.class, "mainMenu");

    74     /**

    75      * Key for the request attribute containing the breadcrumb menu.

    76      */

    77     public static final String REQ_ATTR_BREADCRUMBS = fqn(AbstractLightPITServlet.class, "breadcrumbs");

    79     /**

    80      * Key for the request attribute containing the base href.

    81      */

    82     public static final String REQ_ATTR_BASE_HREF = fqn(AbstractLightPITServlet.class, "base_href");

    84     /**

    85      * Key for the request attribute containing the full path information (servlet path + path info).

    86      */

    87     public static final String REQ_ATTR_PATH = fqn(AbstractLightPITServlet.class, "path");

    89     /**

    90      * Key for the name of the page which should be rendered.

    91      */

    92     public static final String REQ_ATTR_CONTENT_PAGE = fqn(AbstractLightPITServlet.class, "content-page");

    94     /**

    95      * Key for the view model object (the type depends on the rendered site).

    96      */

    97     public static final String REQ_ATTR_VIEWMODEL = "viewmodel";

    99     /**

   100      * Key for the name of the additional stylesheet used by a module.

   101      */

   102     public static final String REQ_ATTR_STYLESHEET = fqn(AbstractLightPITServlet.class, "extraCss");

   104     /**

   105      * Key for a location the page shall redirect to.

   106      * Will be used in a meta element.

   107      */

   108     public static final String REQ_ATTR_REDIRECT_LOCATION = fqn(AbstractLightPITServlet.class, "redirectLocation");

   110     /**

   111      * Key for the current language selection within the session.

   112      */

   113     public static final String SESSION_ATTR_LANGUAGE = fqn(AbstractLightPITServlet.class, "language");

   115     /**

   116      * This class is not instantiatable.

   117      */

   118     private Constants() {

   119     }

   120 }

Mercurial > hg > LightPIT / file revision