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

removes the sub menu and removes the home module
fixes the queries in the PGIssueDao
adds placeholder for a breadcrumb menu

     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      * The path for this module, which will also be used for the menu entry.

    54      * <p>

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

    56      * contain any starting or trailing slashes.

    57      *

    58      * @return the relative module path

    59      */

    60     String modulePath();

    62     /**

    63      * Returns the properties key for the menu label.

    64      * <p>

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

    66      * the menu.

    67      *

    68      * @return the properties key

    69      */

    70     String menuKey() default "menuLabel";

    72     /**

    73      * Returns the properties key for the page title.

    74      * <p>

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

    76      *

    77      * @return the properties key

    78      */

    79     String titleKey() default "menuLabel";

    81     /**

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

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

    84      *

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

    86      */

    87     boolean systemModule() default false;

    89     /**

    90      * Optionally specifies a default priority for this module.

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

    92      *

    93      * @return an integer priority

    94      */

    95     int defaultPriority() default 1000;

    97     /**

    98      * Class representing the annotation.

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

   100      * annotation objects.

   101      * <p>

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

   103      * are proxied by this object.

   104      */

   105     class ELProxy {

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

   108         public ELProxy(LightPITModule annotation) {

   109             bundleBaseName = annotation.bundleBaseName();

   110             modulePath = annotation.modulePath();

   111             menuKey = annotation.menuKey();

   112             titleKey = annotation.titleKey();

   113         }

   115         public String getBundleBaseName() {

   116             return bundleBaseName;

   117         }

   119         public String getMenuKey() {

   120             return menuKey;

   121         }

   123         public String getModulePath() {

   124             return modulePath;

   125         }

   127         public String getTitleKey() {

   128             return titleKey;

   129         }

   130     }

   131 }

Mercurial > hg > LightPIT / file revision