LightPIT: src/java/de/uapcore/lightpit/Functions.java@89e3e6e28b69

     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 org.slf4j.Logger;

    32 import org.slf4j.LoggerFactory;

    34 /**

    35  * Contains common static functions.

    36  */

    37 public final class Functions {

    39     private static final Logger LOG = LoggerFactory.getLogger(Functions.class);

    41     public static String jspPath(String filename) {

    42         return Constants.JSP_PATH_PREFIX + filename;

    43     }

    45     public static String fullyQualifiedName(String base, String name) {

    46         return base+"."+name;

    47     }

    49     public static String fullyQualifiedName(Class clazz, String name) {

    50         return fullyQualifiedName(clazz.getName(), name);

    51     }

    53     /**

    54      * Returns the module path of the given LightPIT Servlet module.

    55      *

    56      * If you specify a malformed LightPIT servlet, which does not have a module

    57      * annotation, the path to the <code>/error/404.html</code> page is returned.

    58      *

    59      * @param clazz the servlet class

    60      * @return the module path

    61      */

    62     public static String modulePathOf(Class<? extends AbstractLightPITServlet> clazz) {

    63         LightPITModule moduleInfo = clazz.getAnnotation(LightPITModule.class);

    64         if (moduleInfo == null) {

    65             LOG.warn(

    66                     "{} is a LightPIT Servlet but is missing the module annotation.",

    67                     clazz.getName()

    68             );

    69             return "/error/404.html";

    70         } else {

    71             return moduleInfo.modulePath();

    72         }

    73     }

    75     /**

    76      * This class is not instantiatable.

    77      */

    78     private Functions() {}

    79 }

Mercurial > hg > LightPIT / file revision