Wed, 13 May 2020 21:10:23 +0200
simplifies menu generation, adds submenus and removes VersionsModule (versions will be part of the ProjectsModule)
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/";
44 /**
45 * Name for the context parameter specifying the available languages.
46 */
47 public static final String CTX_ATTR_LANGUAGES = "available-languages";
49 /**
50 * Name for the context parameter optionally specifying the JNDI context;
51 */
52 public static final String CTX_ATTR_JNDI_CONTEXT = "jndi-context";
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 {@link LightPITModule} information of the currently dispatching module.
66 */
67 public static final String REQ_ATTR_MODULE_INFO = fqn(AbstractLightPITServlet.class, "moduleInfo");
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 sub menu list.
76 */
77 public static final String REQ_ATTR_SUB_MENU = fqn(AbstractLightPITServlet.class, "subMenu");
79 /**
80 * Key for the request attribute containing the full path information (servlet path + path info).
81 */
82 public static final String REQ_ATTR_PATH = fqn(AbstractLightPITServlet.class, "path");
84 /**
85 * Key for the name of the fragment which should be rendered.
86 */
87 public static final String REQ_ATTR_FRAGMENT = fqn(AbstractLightPITServlet.class, "fragment");
89 /**
90 * Key for the name of the additional stylesheet used by a module.
91 */
92 public static final String REQ_ATTR_STYLESHEET = fqn(AbstractLightPITServlet.class, "extraCss");
95 /**
96 * Key for the current language selection within the session.
97 */
98 public static final String SESSION_ATTR_LANGUAGE = fqn(AbstractLightPITServlet.class, "language");
100 /**
101 * This class is not instantiatable.
102 */
103 private Constants() {
104 }
105 }