LightPIT: src/java/de/uapcore/lightpit/LightPITModule.java@bd1a76c91d5b

     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      *

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

    76      * the menu.

    77      *

    78      * @return the properties key

    79      */

    80     String menuKey() default "menuLabel";

    82     /**

    83      * Returns the properties key for the page title.

    84      *

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

    86      *

    87      * @return the properties key

    88      */

    89     String titleKey() default "menuLabel";

    91     /**

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

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

    94      *

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

    96      */

    97     boolean systemModule() default false;

    99     /**

   100      * Class representing the annotation.

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

   102      * annotation objects.

   103      *

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

   105      * are proxied by this object.

   106      */

   107     public static class ELProxy {

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

   110         public static ELProxy convert(LightPITModule annotation) {

   111             return new ELProxy(

   112                     annotation.bundleBaseName(),

   113                     annotation.modulePath(),

   114                     annotation.menuKey(),

   115                     annotation.titleKey()

   116             );

   117         }

   119         private ELProxy(String bundleBaseName, String modulePath, String menuKey, String titleKey) {

   120             this.bundleBaseName = bundleBaseName;

   121             this.modulePath = modulePath;

   122             this.menuKey = menuKey;

   123             this.titleKey = titleKey;

   124         }

   126         public String getBundleBaseName() {

   127             return bundleBaseName;

   128         }

   130         public String getMenuKey() {

   131             return menuKey;

   132         }

   134         public String getModulePath() {

   135             return modulePath;

   136         }

   138         public String getTitleKey() {

   139             return titleKey;

   140         }

   141     }

   142 }

Mercurial > hg > LightPIT / file revision