LightPIT: src/java/de/uapcore/lightpit/Functions.java@737ab27e37b3

     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.util.Optional;

    32 import javax.servlet.http.HttpServletRequest;

    33 import org.slf4j.Logger;

    34 import org.slf4j.LoggerFactory;

    36 /**

    37  * Contains common static functions.

    38  */

    39 public final class Functions {

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

    43     public static String jspPath(String filename) {

    44         return Constants.JSP_PATH_PREFIX + filename;

    45     }

    47     public static String fqn(String base, String name) {

    48         return base+"."+name;

    49     }

    51     public static String fqn(Class clazz, String name) {

    52         return fqn(clazz.getName(), name);

    53     }

    55     public static String fullPath(LightPITModule module, RequestMapping mapping) {

    56         StringBuilder sb = new StringBuilder();

    57         sb.append(module.modulePath());

    58         sb.append('/');

    59         if (!mapping.requestPath().isEmpty()) {

    60             sb.append(mapping.requestPath().isEmpty());

    61             sb.append('/');

    62         }

    63         return sb.toString();

    64     }

    66     public static String fullPath(HttpServletRequest req) {

    67         return req.getServletPath() + Optional.ofNullable(req.getPathInfo()).orElse("");

    68     }

    70     /**

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

    72      *

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

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

    75      *

    76      * @param clazz the servlet class

    77      * @return the module path

    78      */

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

    80         Optional<LightPITModule> moduleInfo = Optional.ofNullable(clazz.getAnnotation(LightPITModule.class));

    81         if (moduleInfo.isPresent()) {

    82             return moduleInfo.get().modulePath();

    83         } else {

    84             LOG.warn(

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

    86                     clazz.getName()

    87             );

    88             return "/error/404.html";

    89         }

    90     }

    92     /**

    93      * This class is not instantiatable.

    94      */

    95     private Functions() {}

    96 }

Mercurial > hg > LightPIT / file revision