Fri, 22 May 2020 16:21:59 +0200
some reformatting
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 public static final String JSP_PATH_PREFIX = "/WEB-INF/jsp/";
41 public static final String DYN_FRAGMENT_PATH_PREFIX = "/WEB-INF/dynamic_fragments/";
43 public static final String DYN_FRAGMENT_COMMIT_SUCCESSFUL = "commit-successful";
45 /**
46 * Name for the context parameter specifying the available languages.
47 */
48 public static final String CTX_ATTR_LANGUAGES = "available-languages";
50 /**
51 * Name for the context parameter optionally specifying a database schema.
52 */
53 public static final String CTX_ATTR_DB_SCHEMA = "db-schema";
55 /**
56 * Name for the context parameter optionally specifying a database dialect.
57 */
58 public static final String CTX_ATTR_DB_DIALECT = "db-dialect";
60 /**
61 * Key for the request attribute containing the {@link LightPITModule} information of the currently dispatching module.
62 */
63 public static final String REQ_ATTR_MODULE_INFO = fqn(AbstractLightPITServlet.class, "moduleInfo");
65 /**
66 * Key for the request attribute containing the menu list.
67 */
68 public static final String REQ_ATTR_MENU = fqn(AbstractLightPITServlet.class, "mainMenu");
70 /**
71 * Key for the request attribute containing the breadcrumb menu.
72 */
73 public static final String REQ_ATTR_BREADCRUMBS = fqn(AbstractLightPITServlet.class, "breadcrumbs");
75 /**
76 * Key for the request attribute containing the base href.
77 */
78 public static final String REQ_ATTR_BASE_HREF = fqn(AbstractLightPITServlet.class, "base_href");
80 /**
81 * Key for the request attribute containing the full path information (servlet path + path info).
82 */
83 public static final String REQ_ATTR_PATH = fqn(AbstractLightPITServlet.class, "path");
85 /**
86 * Key for the name of the fragment which should be rendered.
87 */
88 public static final String REQ_ATTR_FRAGMENT = fqn(AbstractLightPITServlet.class, "fragment");
90 /**
91 * Key for the name of the additional stylesheet used by a module.
92 */
93 public static final String REQ_ATTR_STYLESHEET = fqn(AbstractLightPITServlet.class, "extraCss");
95 /**
96 * Key for a location the page shall redirect to.
97 * Will be used in a meta element.
98 */
99 public static final String REQ_ATTR_REDIRECT_LOCATION = fqn(AbstractLightPITServlet.class, "redirectLocation");
101 /**
102 * Key for the current language selection within the session.
103 */
104 public static final String SESSION_ATTR_LANGUAGE = fqn(AbstractLightPITServlet.class, "language");
106 /**
107 * This class is not instantiatable.
108 */
109 private Constants() {
110 }
111 }