LightPIT: src/main/java/de/uapcore/lightpit/Functions.java@57cfb94ab99f

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

    32 import org.slf4j.LoggerFactory;

    34 import javax.servlet.ServletContext;

    35 import javax.servlet.http.HttpServletRequest;

    36 import java.util.Optional;

    38 /**

    39  * Contains common static functions.

    40  */

    41 public final class Functions {

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

    45     public static Optional<String[]> availableLanguages(ServletContext ctx) {

    46         return Optional.ofNullable(ctx.getInitParameter(Constants.CTX_ATTR_LANGUAGES)).map((x) -> x.split("\\s*,\\s*"));

    47     }

    49     public static String enforceExt(String filename, String ext) {

    50         return filename.endsWith(ext) ? filename : filename + ext;

    51     }

    53     public static String jspPath(String filename) {

    54         return enforceExt(Constants.JSP_PATH_PREFIX + filename, ".jsp");

    55     }

    57     public static String dynFragmentPath(String filename) {

    58         return enforceExt(Constants.DYN_FRAGMENT_PATH_PREFIX + filename, ".jsp");

    59     }

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

    62         return base + "." + name;

    63     }

    65     public static String fqn(Class<?> clazz, String name) {

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

    67     }

    69     public static String baseHref(HttpServletRequest req) {

    70         return String.format("%s://%s:%d%s/",

    71                 req.getScheme(),

    72                 req.getServerName(),

    73                 req.getServerPort(),

    74                 req.getContextPath());

    75     }

    77     public static String fullPath(HttpServletRequest req) {

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

    79     }

    81     /**

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

    83      * <p>

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

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

    86      *

    87      * @param clazz the servlet class

    88      * @return the module path

    89      */

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

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

    92         if (moduleInfo.isPresent()) {

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

    94         } else {

    95             LOG.warn(

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

    97                     clazz.getName()

    98             );

    99             return "/error/404.html";

   100         }

   101     }

   103     /**

   104      * This class is not instantiatable.

   105      */

   106     private Functions() {

   107     }

   108 }

Mercurial > hg > LightPIT / file revision