src/java/de/uapcore/lightpit/Functions.java

changeset 29
27a0fdd7bca7
parent 28
cfc3d11884ad
child 30
fb30f7b78f9b
equal deleted inserted replaced
28:cfc3d11884ad 29:27a0fdd7bca7
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;
30
31 import java.util.Optional;
32 import javax.servlet.ServletContext;
33 import javax.servlet.http.HttpServletRequest;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36
37 /**
38 * Contains common static functions.
39 */
40 public final class Functions {
41
42 private static final Logger LOG = LoggerFactory.getLogger(Functions.class);
43
44 public static Optional<String[]> availableLanguages(ServletContext ctx) {
45 return Optional.ofNullable(ctx.getInitParameter(Constants.CTX_ATTR_LANGUAGES)).map((x) -> x.split("\\s*,\\s*"));
46 }
47
48 public static String enforceExt(String filename, String ext) {
49 return filename.endsWith(ext) ? filename : filename + ext;
50 }
51
52 public static String jspPath(String filename) {
53 return enforceExt(Constants.JSP_PATH_PREFIX + filename, ".jsp");
54 }
55
56 public static String jspfPath(String filename) {
57 return enforceExt(Constants.JSPF_PATH_PREFIX + filename, ".jspf");
58 }
59
60 public static String dynFragmentPath(String filename) {
61 return enforceExt(Constants.DYN_FRAGMENT_PATH_PREFIX + filename, ".jsp");
62 }
63
64 public static String fqn(String base, String name) {
65 return base+"."+name;
66 }
67
68 public static String fqn(Class clazz, String name) {
69 return fqn(clazz.getName(), name);
70 }
71
72 public static String fullPath(LightPITModule module, RequestMapping mapping) {
73 StringBuilder sb = new StringBuilder();
74 sb.append(module.modulePath());
75 sb.append('/');
76 if (!mapping.requestPath().isEmpty()) {
77 sb.append(mapping.requestPath().isEmpty());
78 sb.append('/');
79 }
80 return sb.toString();
81 }
82
83 public static String fullPath(HttpServletRequest req) {
84 return req.getServletPath() + Optional.ofNullable(req.getPathInfo()).orElse("");
85 }
86
87 /**
88 * Returns the module path of the given LightPIT Servlet module.
89 *
90 * If you specify a malformed LightPIT servlet, which does not have a module
91 * annotation, the path to the <code>/error/404.html</code> page is returned.
92 *
93 * @param clazz the servlet class
94 * @return the module path
95 */
96 public static String modulePathOf(Class<? extends AbstractLightPITServlet> clazz) {
97 Optional<LightPITModule> moduleInfo = Optional.ofNullable(clazz.getAnnotation(LightPITModule.class));
98 if (moduleInfo.isPresent()) {
99 return moduleInfo.get().modulePath();
100 } else {
101 LOG.warn(
102 "{} is a LightPIT Servlet but is missing the module annotation.",
103 clazz.getName()
104 );
105 return "/error/404.html";
106 }
107 }
108
109 /**
110 * This class is not instantiatable.
111 */
112 private Functions() {}
113 }

mercurial