LightPIT: src/main/java/de/uapcore/lightpit/LightPITModule.java@dd0a45ae25d7

     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  * <p>

    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      *

    48      * @return a base name suitable for the JSTL tag 'setBundle'.

    49      */

    50     String bundleBaseName();

    52     /**

    53      * An array of required modules, identified by the string representation of

    54      * their class names.

    55      *

    56      * @return an array of class names of required modules

    57      */

    58     String[] requires() default {};

    60     /**

    61      * The path for this module, which will also be used for the menu entry.

    62      * <p>

    63      * This path must adhere to the URL pattern of the Servlet but must not

    64      * contain any starting or trailing slashes.

    65      *

    66      * @return the relative module path

    67      */

    68     String modulePath();

    70     /**

    71      * Returns the properties key for the menu label.

    72      * <p>

    73      * Set this string to empty string, if the module should be hidden from

    74      * the menu.

    75      *

    76      * @return the properties key

    77      */

    78     String menuKey() default "menuLabel";

    80     /**

    81      * Returns the properties key for the page title.

    82      * <p>

    83      * By default this is the same as the menu label.

    84      *

    85      * @return the properties key

    86      */

    87     String titleKey() default "menuLabel";

    89     /**

    90      * If set to <code>true</code>, this module is always loaded, but never

    91      * visible in the menu or the Web UI module manager.

    92      *

    93      * @return true, if this is a system module

    94      */

    95     boolean systemModule() default false;

    97     /**

    98      * Optionally specifies a default priority for this module.

    99      * The priority is used to order the menu entries.

   100      *

   101      * @return an integer priority

   102      */

   103     int defaultPriority() default 1000;

   105     /**

   106      * Class representing the annotation.

   107      * This is necessary, because the EL resolver cannot deal with

   108      * annotation objects.

   109      * <p>

   110      * Note, that only the properties which are interesting for the JSP pages

   111      * are proxied by this object.

   112      */

   113     class ELProxy {

   114         private final String bundleBaseName, modulePath, menuKey, titleKey;

   116         public ELProxy(LightPITModule annotation) {

   117             bundleBaseName = annotation.bundleBaseName();

   118             modulePath = annotation.modulePath();

   119             menuKey = annotation.menuKey();

   120             titleKey = annotation.titleKey();

   121         }

   123         public String getBundleBaseName() {

   124             return bundleBaseName;

   125         }

   127         public String getMenuKey() {

   128             return menuKey;

   129         }

   131         public String getModulePath() {

   132             return modulePath;

   133         }

   135         public String getTitleKey() {

   136             return titleKey;

   137         }

   138     }

   139 }

Mercurial > hg > LightPIT / file revision