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

Sat, 23 May 2020 13:34:41 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 23 May 2020 13:34:41 +0200
changeset 77
192298f8161f
parent 70
821c4950b619
permissions
-rw-r--r--

bloat removal 1/3 - configurable resource keys

universe@6 1 /*
universe@6 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@34 3 *
universe@24 4 * Copyright 2018 Mike Becker. All rights reserved.
universe@34 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@34 27 *
universe@6 28 */
universe@6 29 package de.uapcore.lightpit;
universe@6 30
universe@7 31 import javax.servlet.annotation.WebServlet;
universe@31 32 import java.lang.annotation.*;
universe@6 33
universe@6 34
universe@6 35 /**
universe@6 36 * Contains information about a LightPIT module.
universe@34 37 * <p>
universe@7 38 * This annotation is typically used to annotate the {@link WebServlet} which
universe@7 39 * implements the module's functionality.
universe@6 40 */
universe@7 41 @Documented
universe@6 42 @Retention(RetentionPolicy.RUNTIME)
universe@6 43 @Target(ElementType.TYPE)
universe@6 44 public @interface LightPITModule {
universe@7 45 /**
universe@7 46 * Base name of the module specific resource bundle.
universe@34 47 *
universe@7 48 * @return a base name suitable for the JSTL tag 'setBundle'.
universe@7 49 */
universe@7 50 String bundleBaseName();
universe@34 51
universe@7 52 /**
universe@21 53 * The path for this module, which will also be used for the menu entry.
universe@34 54 * <p>
universe@10 55 * This path must adhere to the URL pattern of the Servlet but must not
universe@10 56 * contain any starting or trailing slashes.
universe@34 57 *
universe@10 58 * @return the relative module path
universe@10 59 */
universe@10 60 String modulePath();
universe@34 61
universe@10 62 /**
universe@20 63 * If set to <code>true</code>, this module is always loaded, but never
universe@20 64 * visible in the menu or the Web UI module manager.
universe@31 65 *
universe@20 66 * @return true, if this is a system module
universe@20 67 */
universe@20 68 boolean systemModule() default false;
universe@31 69
universe@31 70 /**
universe@31 71 * Optionally specifies a default priority for this module.
universe@31 72 * The priority is used to order the menu entries.
universe@31 73 *
universe@31 74 * @return an integer priority
universe@31 75 */
universe@31 76 int defaultPriority() default 1000;
universe@31 77
universe@20 78 /**
universe@11 79 * Class representing the annotation.
universe@11 80 * This is necessary, because the EL resolver cannot deal with
universe@11 81 * annotation objects.
universe@31 82 * <p>
universe@11 83 * Note, that only the properties which are interesting for the JSP pages
universe@11 84 * are proxied by this object.
universe@11 85 */
universe@31 86 class ELProxy {
universe@77 87 private final String bundleBaseName, modulePath;
universe@31 88
universe@36 89 public ELProxy(LightPITModule annotation) {
universe@36 90 bundleBaseName = annotation.bundleBaseName();
universe@36 91 modulePath = annotation.modulePath();
universe@11 92 }
universe@11 93
universe@11 94 public String getBundleBaseName() {
universe@11 95 return bundleBaseName;
universe@11 96 }
universe@11 97 public String getModulePath() {
universe@11 98 return modulePath;
universe@11 99 }
universe@11 100 }
universe@6 101 }

mercurial