src/main/java/de/uapcore/lightpit/LightPITModule.java@58f78f0142e8
src/main/java/de/uapcore/lightpit/LightPITModule.java
Sat, 09 May 2020 14:58:20 +0200
- author
- Mike Becker <universe@uap-core.de>
- date
- Sat, 09 May 2020 14:58:20 +0200
- changeset 31
- 58f78f0142e8
- parent 29
- 27a0fdd7bca7
- child 34
- 824d4042c857
- permissions
- -rw-r--r--
adds module priorities
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 *
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 * @return a base name suitable for the JSTL tag 'setBundle'.
48 */
49 String bundleBaseName();
51 /**
52 * An array of required modules, identified by the string representation of
53 * their class names.
54 * @return an array of class names of required modules
55 */
56 String[] requires() default {};
58 /**
59 * The path for this module, which will also be used for the menu entry.
60 *
61 * This path must adhere to the URL pattern of the Servlet but must not
62 * contain any starting or trailing slashes.
63 *
64 * @return the relative module path
65 */
66 String modulePath();
68 /**
69 * Returns the properties key for the module name.
70 *
71 * @return the properties key
72 */
73 String nameKey() default "name";
75 /**
76 * Returns the properties key for the module description.
77 *
78 * @return the properties key
79 */
80 String descKey() default "description";
83 /**
84 * Returns the properties key for the menu label.
85 *
86 * Set this string to empty string, if the module should be hidden from
87 * the menu.
88 *
89 * @return the properties key
90 */
91 String menuKey() default "menuLabel";
93 /**
94 * Returns the properties key for the page title.
95 *
96 * By default this is the same as the menu label.
97 *
98 * @return the properties key
99 */
100 String titleKey() default "menuLabel";
102 /**
103 * If set to <code>true</code>, this module is always loaded, but never
104 * visible in the menu or the Web UI module manager.
105 *
106 * @return true, if this is a system module
107 */
108 boolean systemModule() default false;
110 /**
111 * Optionally specifies a default priority for this module.
112 * The priority is used to order the menu entries.
113 *
114 * @return an integer priority
115 */
116 int defaultPriority() default 1000;
118 /**
119 * Class representing the annotation.
120 * This is necessary, because the EL resolver cannot deal with
121 * annotation objects.
122 * <p>
123 * Note, that only the properties which are interesting for the JSP pages
124 * are proxied by this object.
125 */
126 class ELProxy {
127 private final String bundleBaseName, modulePath, menuKey, titleKey, nameKey, descKey;
129 public static ELProxy convert(LightPITModule annotation) {
130 return new ELProxy(
131 annotation.bundleBaseName(),
132 annotation.modulePath(),
133 annotation.menuKey(),
134 annotation.titleKey(),
135 annotation.nameKey(),
136 annotation.descKey()
137 );
138 }
140 private ELProxy(String bundleBaseName, String modulePath, String menuKey, String titleKey, String nameKey, String descKey) {
141 this.bundleBaseName = bundleBaseName;
142 this.modulePath = modulePath;
143 this.menuKey = menuKey;
144 this.titleKey = titleKey;
145 this.nameKey = nameKey;
146 this.descKey = descKey;
147 }
149 public String getBundleBaseName() {
150 return bundleBaseName;
151 }
153 public String getMenuKey() {
154 return menuKey;
155 }
157 public String getModulePath() {
158 return modulePath;
159 }
161 public String getTitleKey() {
162 return titleKey;
163 }
165 public String getNameKey() {
166 return nameKey;
167 }
169 public String getDescKey() {
170 return descKey;
171 }
173 }
174 }
