Sun, 10 May 2020 10:11:37 +0200
removes features that are not (and probably will not) used anyway
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 jspfPath(String filename) {
58 return enforceExt(Constants.JSPF_PATH_PREFIX + filename, ".jspf");
59 }
61 public static String dynFragmentPath(String filename) {
62 return enforceExt(Constants.DYN_FRAGMENT_PATH_PREFIX + filename, ".jsp");
63 }
65 public static String fqn(String base, String name) {
66 return base + "." + name;
67 }
69 public static String fqn(Class<?> clazz, String name) {
70 return fqn(clazz.getName(), name);
71 }
73 public static String fullPath(LightPITModule module, RequestMapping mapping) {
74 StringBuilder sb = new StringBuilder();
75 sb.append(module.modulePath());
76 sb.append('/');
77 if (!mapping.requestPath().isEmpty()) {
78 sb.append(mapping.requestPath().isEmpty());
79 sb.append('/');
80 }
81 return sb.toString();
82 }
84 public static String fullPath(HttpServletRequest req) {
85 return req.getServletPath() + Optional.ofNullable(req.getPathInfo()).orElse("");
86 }
88 /**
89 * Returns the module path of the given LightPIT Servlet module.
90 * <p>
91 * If you specify a malformed LightPIT servlet, which does not have a module
92 * annotation, the path to the <code>/error/404.html</code> page is returned.
93 *
94 * @param clazz the servlet class
95 * @return the module path
96 */
97 public static String modulePathOf(Class<? extends AbstractLightPITServlet> clazz) {
98 Optional<LightPITModule> moduleInfo = Optional.ofNullable(clazz.getAnnotation(LightPITModule.class));
99 if (moduleInfo.isPresent()) {
100 return moduleInfo.get().modulePath();
101 } else {
102 LOG.warn(
103 "{} is a LightPIT Servlet but is missing the module annotation.",
104 clazz.getName()
105 );
106 return "/error/404.html";
107 }
108 }
110 /**
111 * This class is not instantiatable.
112 */
113 private Functions() {
114 }
115 }