Sun, 17 Dec 2017 01:45:28 +0100
implements simple request mapper
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2017 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 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;
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();
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 {};
62 /**
63 * The path for this module, which will 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();
72 /**
73 * Returns the properties key for the menu label.
74 * @return the properties key
75 */
76 String menuKey() default "menuLabel";
78 /**
79 * Returns the properties key for the page title.
80 *
81 * By default this is the same as the menu label.
82 *
83 * @return the properties key
84 */
85 String titleKey() default "menuLabel";
87 /**
88 * Class representing the annotation.
89 * This is necessary, because the EL resolver cannot deal with
90 * annotation objects.
91 *
92 * Note, that only the properties which are interesting for the JSP pages
93 * are proxied by this object.
94 */
95 public static class ELProxy {
96 private final String bundleBaseName, modulePath, menuKey, titleKey;
98 public static ELProxy convert(LightPITModule annotation) {
99 return new ELProxy(
100 annotation.bundleBaseName(),
101 annotation.modulePath(),
102 annotation.menuKey(),
103 annotation.titleKey()
104 );
105 }
107 private ELProxy(String bundleBaseName, String modulePath, String menuKey, String titleKey) {
108 this.bundleBaseName = bundleBaseName;
109 this.modulePath = modulePath;
110 this.menuKey = menuKey;
111 this.titleKey = titleKey;
112 }
114 public String getBundleBaseName() {
115 return bundleBaseName;
116 }
118 public String getMenuKey() {
119 return menuKey;
120 }
122 public String getModulePath() {
123 return modulePath;
124 }
126 public String getTitleKey() {
127 return titleKey;
128 }
129 }
130 }