src/main/java/de/uapcore/lightpit/LightPITModule.java@4f1c026a8aab
src/main/java/de/uapcore/lightpit/LightPITModule.java
Wed, 13 May 2020 18:33:25 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Wed, 13 May 2020 18:33:25 +0200
- changeset 41
- 4f1c026a8aab
- parent 36
- 0f4f8f255c32
- child 51
- dd0a45ae25d7
- permissions
- -rw-r--r--
adds files for 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 javax.servlet.annotation.WebServlet;
32 import java.lang.annotation.*;
35 /**
36 * Contains information about a LightPIT module.
37 * <p>
38 * This annotation is typically used to annotate the {@link WebServlet} which
39 * implements the module's functionality.
40 */
41 @Documented
42 @Retention(RetentionPolicy.RUNTIME)
43 @Target(ElementType.TYPE)
44 public @interface LightPITModule {
45 /**
46 * Base name of the module specific resource bundle.
47 *
48 * @return a base name suitable for the JSTL tag 'setBundle'.
49 */
50 String bundleBaseName();
52 /**
53 * An array of required modules, identified by the string representation of
54 * their class names.
55 *
56 * @return an array of class names of required modules
57 */
58 String[] requires() default {};
60 /**
61 * The path for this module, which will also be used for the menu entry.
62 * <p>
63 * This path must adhere to the URL pattern of the Servlet but must not
64 * contain any starting or trailing slashes.
65 *
66 * @return the relative module path
67 */
68 String modulePath();
70 /**
71 * Returns the properties key for the module name.
72 *
73 * @return the properties key
74 */
75 String nameKey() default "name";
77 /**
78 * Returns the properties key for the module description.
79 *
80 * @return the properties key
81 */
82 String descKey() default "description";
85 /**
86 * Returns the properties key for the menu label.
87 * <p>
88 * Set this string to empty string, if the module should be hidden from
89 * the menu.
90 *
91 * @return the properties key
92 */
93 String menuKey() default "menuLabel";
95 /**
96 * Returns the properties key for the page title.
97 * <p>
98 * By default this is the same as the menu label.
99 *
100 * @return the properties key
101 */
102 String titleKey() default "menuLabel";
104 /**
105 * If set to <code>true</code>, this module is always loaded, but never
106 * visible in the menu or the Web UI module manager.
107 *
108 * @return true, if this is a system module
109 */
110 boolean systemModule() default false;
112 /**
113 * Optionally specifies a default priority for this module.
114 * The priority is used to order the menu entries.
115 *
116 * @return an integer priority
117 */
118 int defaultPriority() default 1000;
120 /**
121 * Class representing the annotation.
122 * This is necessary, because the EL resolver cannot deal with
123 * annotation objects.
124 * <p>
125 * Note, that only the properties which are interesting for the JSP pages
126 * are proxied by this object.
127 */
128 class ELProxy {
129 private final String bundleBaseName, modulePath, menuKey, titleKey, nameKey, descKey;
131 public ELProxy(LightPITModule annotation) {
132 bundleBaseName = annotation.bundleBaseName();
133 modulePath = annotation.modulePath();
134 menuKey = annotation.menuKey();
135 titleKey = annotation.titleKey();
136 nameKey = annotation.nameKey();
137 descKey = annotation.descKey();
138 }
140 public String getBundleBaseName() {
141 return bundleBaseName;
142 }
144 public String getMenuKey() {
145 return menuKey;
146 }
148 public String getModulePath() {
149 return modulePath;
150 }
152 public String getTitleKey() {
153 return titleKey;
154 }
156 public String getNameKey() {
157 return nameKey;
158 }
160 public String getDescKey() {
161 return descKey;
162 }
164 }
165 }
