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

changeset 29
27a0fdd7bca7
parent 24
8137ec335416
child 34
824d4042c857
equal deleted inserted replaced
28:cfc3d11884ad 29:27a0fdd7bca7
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;
30
31 import static de.uapcore.lightpit.Functions.fqn;
32
33 /**
34 * Contains all non-local scope constants used by the this application.
35 *
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/";
40
41 public static final String JSPF_PATH_PREFIX = "/WEB-INF/jspf/";
42
43 public static final String DYN_FRAGMENT_PATH_PREFIX = "/WEB-INF/dynamic_fragments/";
44
45
46 /**
47 * Name for the context parameter specifying the available languages.
48 */
49 public static final String CTX_ATTR_LANGUAGES = "available-languages";
50
51 /**
52 * Name for the context parameter optionally specifying the JNDI context;
53 */
54 public static final String CTX_ATTR_JNDI_CONTEXT = "jndi-context";
55
56 /**
57 * Name for the context parameter optionally specifying a database schema.
58 */
59 public static final String CTX_ATTR_DB_SCHEMA = "db-schema";
60
61 /**
62 * Name for the context parameter optionally specifying a database dialect.
63 */
64 public static final String CTX_ATTR_DB_DIALECT = "db-dialect";
65
66 /**
67 * Key for the request attribute containing the class name of the currently dispatching module.
68 */
69 public static final String REQ_ATTR_MODULE_CLASSNAME = fqn(AbstractLightPITServlet.class, "moduleClassname");
70
71 /**
72 * Key for the request attribute containing the {@link LightPITModule} information of the currently dispatching module.
73 */
74 public static final String REQ_ATTR_MODULE_INFO = fqn(AbstractLightPITServlet.class, "moduleInfo");
75
76 /**
77 * Key for the request attribute containing the menu list.
78 */
79 public static final String REQ_ATTR_MENU = fqn(AbstractLightPITServlet.class, "mainMenu");
80
81 /**
82 * Key for the request attribute containing the full path information (servlet path + path info).
83 */
84 public static final String REQ_ATTR_PATH = fqn(AbstractLightPITServlet.class, "path");
85
86 /**
87 * Key for the name of the fragment which should be rendered.
88 */
89 public static final String REQ_ATTR_FRAGMENT = fqn(AbstractLightPITServlet.class, "fragment");
90
91 /**
92 * Key for the name of the additional stylesheet used by a module.
93 */
94 public static final String REQ_ATTR_STYLESHEET = fqn(AbstractLightPITServlet.class, "extraCss");
95
96
97 /**
98 * Key for the current language selection within the session.
99 */
100 public static final String SESSION_ATTR_LANGUAGE = fqn(AbstractLightPITServlet.class, "language");
101
102 /**
103 * This class is not instantiatable.
104 */
105 private Constants() {}
106 }

mercurial