Sat, 09 May 2020 14:37:15 +0200
moves DAO classes to different package
universe@6 | 1 | /* |
universe@6 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@6 | 3 | * |
universe@24 | 4 | * Copyright 2018 Mike Becker. All rights reserved. |
universe@6 | 5 | * |
universe@6 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@6 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@6 | 8 | * |
universe@6 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@6 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@6 | 11 | * |
universe@6 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@6 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@6 | 14 | * documentation and/or other materials provided with the distribution. |
universe@6 | 15 | * |
universe@6 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@6 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@6 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@6 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@6 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@6 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@6 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@6 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@6 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@6 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@6 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@6 | 27 | * |
universe@6 | 28 | */ |
universe@6 | 29 | package de.uapcore.lightpit; |
universe@6 | 30 | |
universe@7 | 31 | import java.lang.annotation.Documented; |
universe@6 | 32 | import java.lang.annotation.ElementType; |
universe@6 | 33 | import java.lang.annotation.Retention; |
universe@6 | 34 | import java.lang.annotation.RetentionPolicy; |
universe@6 | 35 | import java.lang.annotation.Target; |
universe@7 | 36 | import javax.servlet.annotation.WebServlet; |
universe@6 | 37 | |
universe@6 | 38 | |
universe@6 | 39 | /** |
universe@6 | 40 | * Contains information about a LightPIT module. |
universe@7 | 41 | * |
universe@7 | 42 | * This annotation is typically used to annotate the {@link WebServlet} which |
universe@7 | 43 | * implements the module's functionality. |
universe@6 | 44 | */ |
universe@7 | 45 | @Documented |
universe@6 | 46 | @Retention(RetentionPolicy.RUNTIME) |
universe@6 | 47 | @Target(ElementType.TYPE) |
universe@6 | 48 | public @interface LightPITModule { |
universe@7 | 49 | /** |
universe@7 | 50 | * Base name of the module specific resource bundle. |
universe@7 | 51 | * @return a base name suitable for the JSTL tag 'setBundle'. |
universe@7 | 52 | */ |
universe@7 | 53 | String bundleBaseName(); |
universe@6 | 54 | |
universe@7 | 55 | /** |
universe@7 | 56 | * An array of required modules, identified by the string representation of |
universe@7 | 57 | * their class names. |
universe@7 | 58 | * @return an array of class names of required modules |
universe@7 | 59 | */ |
universe@7 | 60 | String[] requires() default {}; |
universe@10 | 61 | |
universe@10 | 62 | /** |
universe@21 | 63 | * The path for this module, which will also be used for the menu entry. |
universe@10 | 64 | * |
universe@10 | 65 | * This path must adhere to the URL pattern of the Servlet but must not |
universe@10 | 66 | * contain any starting or trailing slashes. |
universe@10 | 67 | * |
universe@10 | 68 | * @return the relative module path |
universe@10 | 69 | */ |
universe@10 | 70 | String modulePath(); |
universe@10 | 71 | |
universe@10 | 72 | /** |
universe@21 | 73 | * Returns the properties key for the module name. |
universe@21 | 74 | * |
universe@21 | 75 | * @return the properties key |
universe@21 | 76 | */ |
universe@21 | 77 | String nameKey() default "name"; |
universe@21 | 78 | |
universe@21 | 79 | /** |
universe@21 | 80 | * Returns the properties key for the module description. |
universe@21 | 81 | * |
universe@21 | 82 | * @return the properties key |
universe@21 | 83 | */ |
universe@21 | 84 | String descKey() default "description"; |
universe@21 | 85 | |
universe@21 | 86 | |
universe@21 | 87 | /** |
universe@10 | 88 | * Returns the properties key for the menu label. |
universe@18 | 89 | * |
universe@18 | 90 | * Set this string to empty string, if the module should be hidden from |
universe@18 | 91 | * the menu. |
universe@18 | 92 | * |
universe@11 | 93 | * @return the properties key |
universe@10 | 94 | */ |
universe@10 | 95 | String menuKey() default "menuLabel"; |
universe@11 | 96 | |
universe@11 | 97 | /** |
universe@11 | 98 | * Returns the properties key for the page title. |
universe@11 | 99 | * |
universe@11 | 100 | * By default this is the same as the menu label. |
universe@11 | 101 | * |
universe@11 | 102 | * @return the properties key |
universe@11 | 103 | */ |
universe@11 | 104 | String titleKey() default "menuLabel"; |
universe@11 | 105 | |
universe@11 | 106 | /** |
universe@20 | 107 | * If set to <code>true</code>, this module is always loaded, but never |
universe@20 | 108 | * visible in the menu or the Web UI module manager. |
universe@20 | 109 | * |
universe@20 | 110 | * @return true, if this is a system module |
universe@20 | 111 | */ |
universe@20 | 112 | boolean systemModule() default false; |
universe@20 | 113 | |
universe@20 | 114 | /** |
universe@11 | 115 | * Class representing the annotation. |
universe@11 | 116 | * This is necessary, because the EL resolver cannot deal with |
universe@11 | 117 | * annotation objects. |
universe@11 | 118 | * |
universe@11 | 119 | * Note, that only the properties which are interesting for the JSP pages |
universe@11 | 120 | * are proxied by this object. |
universe@11 | 121 | */ |
universe@11 | 122 | public static class ELProxy { |
universe@21 | 123 | private final String bundleBaseName, modulePath, menuKey, titleKey, nameKey, descKey; |
universe@11 | 124 | |
universe@11 | 125 | public static ELProxy convert(LightPITModule annotation) { |
universe@11 | 126 | return new ELProxy( |
universe@11 | 127 | annotation.bundleBaseName(), |
universe@11 | 128 | annotation.modulePath(), |
universe@11 | 129 | annotation.menuKey(), |
universe@21 | 130 | annotation.titleKey(), |
universe@21 | 131 | annotation.nameKey(), |
universe@21 | 132 | annotation.descKey() |
universe@11 | 133 | ); |
universe@11 | 134 | } |
universe@11 | 135 | |
universe@21 | 136 | private ELProxy(String bundleBaseName, String modulePath, String menuKey, String titleKey, String nameKey, String descKey) { |
universe@11 | 137 | this.bundleBaseName = bundleBaseName; |
universe@11 | 138 | this.modulePath = modulePath; |
universe@11 | 139 | this.menuKey = menuKey; |
universe@11 | 140 | this.titleKey = titleKey; |
universe@21 | 141 | this.nameKey = nameKey; |
universe@21 | 142 | this.descKey = descKey; |
universe@11 | 143 | } |
universe@11 | 144 | |
universe@11 | 145 | public String getBundleBaseName() { |
universe@11 | 146 | return bundleBaseName; |
universe@11 | 147 | } |
universe@11 | 148 | |
universe@11 | 149 | public String getMenuKey() { |
universe@11 | 150 | return menuKey; |
universe@11 | 151 | } |
universe@11 | 152 | |
universe@11 | 153 | public String getModulePath() { |
universe@11 | 154 | return modulePath; |
universe@11 | 155 | } |
universe@11 | 156 | |
universe@11 | 157 | public String getTitleKey() { |
universe@11 | 158 | return titleKey; |
universe@11 | 159 | } |
universe@21 | 160 | |
universe@21 | 161 | public String getNameKey() { |
universe@21 | 162 | return nameKey; |
universe@21 | 163 | } |
universe@21 | 164 | |
universe@21 | 165 | public String getDescKey() { |
universe@21 | 166 | return descKey; |
universe@21 | 167 | } |
universe@21 | 168 | |
universe@11 | 169 | } |
universe@6 | 170 | } |