Mercurial > hg > LightPIT / file comparison

comparison: src/main/java/de/uapcore/lightpit/LightPITModule.java

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

changeset 29
27a0fdd7bca7
parent 24
8137ec335416
child 31
58f78f0142e8
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 java.lang.annotation.Documented;
32 import java.lang.annotation.ElementType;
33 import java.lang.annotation.Retention;
34 import java.lang.annotation.RetentionPolicy;
35 import java.lang.annotation.Target;
36 import javax.servlet.annotation.WebServlet;
37
38
39 /**
40 * Contains information about a LightPIT module.
41 *
42 * This annotation is typically used to annotate the {@link WebServlet} which
43 * implements the module's functionality.
44 */
45 @Documented
46 @Retention(RetentionPolicy.RUNTIME)
47 @Target(ElementType.TYPE)
48 public @interface LightPITModule {
49 /**
50 * Base name of the module specific resource bundle.
51 * @return a base name suitable for the JSTL tag 'setBundle'.
52 */
53 String bundleBaseName();
54
55 /**
56 * An array of required modules, identified by the string representation of
57 * their class names.
58 * @return an array of class names of required modules
59 */
60 String[] requires() default {};
61
62 /**
63 * The path for this module, which will also be used for the menu entry.
64 *
65 * This path must adhere to the URL pattern of the Servlet but must not
66 * contain any starting or trailing slashes.
67 *
68 * @return the relative module path
69 */
70 String modulePath();
71
72 /**
73 * Returns the properties key for the module name.
74 *
75 * @return the properties key
76 */
77 String nameKey() default "name";
78
79 /**
80 * Returns the properties key for the module description.
81 *
82 * @return the properties key
83 */
84 String descKey() default "description";
85
86
87 /**
88 * Returns the properties key for the menu label.
89 *
90 * Set this string to empty string, if the module should be hidden from
91 * the menu.
92 *
93 * @return the properties key
94 */
95 String menuKey() default "menuLabel";
96
97 /**
98 * Returns the properties key for the page title.
99 *
100 * By default this is the same as the menu label.
101 *
102 * @return the properties key
103 */
104 String titleKey() default "menuLabel";
105
106 /**
107 * If set to <code>true</code>, this module is always loaded, but never
108 * visible in the menu or the Web UI module manager.
109 *
110 * @return true, if this is a system module
111 */
112 boolean systemModule() default false;
113
114 /**
115 * Class representing the annotation.
116 * This is necessary, because the EL resolver cannot deal with
117 * annotation objects.
118 *
119 * Note, that only the properties which are interesting for the JSP pages
120 * are proxied by this object.
121 */
122 public static class ELProxy {
123 private final String bundleBaseName, modulePath, menuKey, titleKey, nameKey, descKey;
124
125 public static ELProxy convert(LightPITModule annotation) {
126 return new ELProxy(
127 annotation.bundleBaseName(),
128 annotation.modulePath(),
129 annotation.menuKey(),
130 annotation.titleKey(),
131 annotation.nameKey(),
132 annotation.descKey()
133 );
134 }
135
136 private ELProxy(String bundleBaseName, String modulePath, String menuKey, String titleKey, String nameKey, String descKey) {
137 this.bundleBaseName = bundleBaseName;
138 this.modulePath = modulePath;
139 this.menuKey = menuKey;
140 this.titleKey = titleKey;
141 this.nameKey = nameKey;
142 this.descKey = descKey;
143 }
144
145 public String getBundleBaseName() {
146 return bundleBaseName;
147 }
148
149 public String getMenuKey() {
150 return menuKey;
151 }
152
153 public String getModulePath() {
154 return modulePath;
155 }
156
157 public String getTitleKey() {
158 return titleKey;
159 }
160
161 public String getNameKey() {
162 return nameKey;
163 }
164
165 public String getDescKey() {
166 return descKey;
167 }
168
169 }
170 }

Mercurial Repository: LightPIT

mercurial