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

Mon, 01 Jun 2020 14:46:58 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 01 Jun 2020 14:46:58 +0200
changeset 86
0a658e53177c
parent 78
bb4c52bf3439
child 96
b7b685f31e39
permissions
-rw-r--r--

improves issue overview and adds progress information

universe@1 1 /*
universe@1 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@34 3 *
universe@24 4 * Copyright 2018 Mike Becker. All rights reserved.
universe@34 5 *
universe@1 6 * Redistribution and use in source and binary forms, with or without
universe@1 7 * modification, are permitted provided that the following conditions are met:
universe@1 8 *
universe@1 9 * 1. Redistributions of source code must retain the above copyright
universe@1 10 * notice, this list of conditions and the following disclaimer.
universe@1 11 *
universe@1 12 * 2. Redistributions in binary form must reproduce the above copyright
universe@1 13 * notice, this list of conditions and the following disclaimer in the
universe@1 14 * documentation and/or other materials provided with the distribution.
universe@1 15 *
universe@1 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@1 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@1 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@1 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@1 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@1 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@1 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@1 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@1 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@1 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@1 26 * POSSIBILITY OF SUCH DAMAGE.
universe@34 27 *
universe@1 28 */
universe@1 29 package de.uapcore.lightpit;
universe@1 30
universe@11 31 import static de.uapcore.lightpit.Functions.fqn;
universe@10 32
universe@6 33 /**
universe@13 34 * Contains all non-local scope constants used by the this application.
universe@34 35 * <p>
universe@13 36 * Constants with (class) local scope are defined in their respective classes.
universe@6 37 */
universe@10 38 public final class Constants {
universe@74 39 /**
universe@74 40 * The path where the JSP files reside.
universe@74 41 */
universe@11 42 public static final String JSP_PATH_PREFIX = "/WEB-INF/jsp/";
universe@34 43
universe@74 44 /**
universe@74 45 * The name of the generic JSP page that is displayed after a successful commit.
universe@74 46 */
universe@74 47 public static final String JSP_COMMIT_SUCCESSFUL = "commit-successful";
universe@34 48
universe@13 49 /**
universe@13 50 * Name for the context parameter specifying the available languages.
universe@13 51 */
universe@13 52 public static final String CTX_ATTR_LANGUAGES = "available-languages";
universe@34 53
universe@11 54 /**
universe@16 55 * Name for the context parameter optionally specifying a database schema.
universe@16 56 */
universe@16 57 public static final String CTX_ATTR_DB_SCHEMA = "db-schema";
universe@34 58
universe@16 59 /**
universe@19 60 * Name for the context parameter optionally specifying a database dialect.
universe@19 61 */
universe@19 62 public static final String CTX_ATTR_DB_DIALECT = "db-dialect";
universe@34 63
universe@19 64 /**
universe@78 65 * Key for the request attribute containing the resource bundle name.
universe@11 66 */
universe@78 67 public static final String REQ_ATTR_RESOURCE_BUNDLE = fqn(AbstractLightPITServlet.class, "bundleName");
universe@34 68
universe@11 69 /**
universe@11 70 * Key for the request attribute containing the menu list.
universe@11 71 */
universe@11 72 public static final String REQ_ATTR_MENU = fqn(AbstractLightPITServlet.class, "mainMenu");
universe@34 73
universe@11 74 /**
universe@71 75 * Key for the request attribute containing the breadcrumb menu.
universe@71 76 */
universe@71 77 public static final String REQ_ATTR_BREADCRUMBS = fqn(AbstractLightPITServlet.class, "breadcrumbs");
universe@71 78
universe@71 79 /**
universe@47 80 * Key for the request attribute containing the base href.
universe@47 81 */
universe@47 82 public static final String REQ_ATTR_BASE_HREF = fqn(AbstractLightPITServlet.class, "base_href");
universe@47 83
universe@47 84 /**
universe@11 85 * Key for the request attribute containing the full path information (servlet path + path info).
universe@11 86 */
universe@11 87 public static final String REQ_ATTR_PATH = fqn(AbstractLightPITServlet.class, "path");
universe@13 88
universe@13 89 /**
universe@74 90 * Key for the name of the page which should be rendered.
universe@34 91 */
universe@74 92 public static final String REQ_ATTR_CONTENT_PAGE = fqn(AbstractLightPITServlet.class, "content-page");
universe@34 93
universe@13 94 /**
universe@86 95 * Key for the view model object (the type depends on the rendered site).
universe@86 96 */
universe@86 97 public static final String REQ_ATTR_VIEWMODEL = "viewmodel";
universe@86 98
universe@86 99 /**
universe@13 100 * Key for the name of the additional stylesheet used by a module.
universe@34 101 */
universe@13 102 public static final String REQ_ATTR_STYLESHEET = fqn(AbstractLightPITServlet.class, "extraCss");
universe@34 103
universe@47 104 /**
universe@47 105 * Key for a location the page shall redirect to.
universe@47 106 * Will be used in a meta element.
universe@47 107 */
universe@47 108 public static final String REQ_ATTR_REDIRECT_LOCATION = fqn(AbstractLightPITServlet.class, "redirectLocation");
universe@34 109
universe@13 110 /**
universe@13 111 * Key for the current language selection within the session.
universe@13 112 */
universe@13 113 public static final String SESSION_ATTR_LANGUAGE = fqn(AbstractLightPITServlet.class, "language");
universe@34 114
universe@10 115 /**
universe@10 116 * This class is not instantiatable.
universe@10 117 */
universe@34 118 private Constants() {
universe@34 119 }
universe@1 120 }

mercurial