1 /*
2 * Copyright (C) 2009-2010, Google Inc.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.http.server.glue;
45
46 import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
47
48 import java.io.IOException;
49
50 import javax.servlet.ServletConfig;
51 import javax.servlet.ServletContext;
52 import javax.servlet.ServletException;
53 import javax.servlet.ServletRequest;
54 import javax.servlet.ServletResponse;
55 import javax.servlet.http.HttpServlet;
56 import javax.servlet.http.HttpServletRequest;
57 import javax.servlet.http.HttpServletResponse;
58
59 /**
60 * Generic container servlet to manage routing to different pipelines.
61 * <p>
62 * Callers can create and configure a new processing pipeline by using one of
63 * the {@link #serve(String)} or {@link #serveRegex(String)} methods to allocate
64 * a binder for a particular URL pattern.
65 * <p>
66 * Registered filters and servlets are initialized lazily, usually during the
67 * first request. Once initialized the bindings in this servlet cannot be
68 * modified without destroying the servlet and thereby destroying all registered
69 * filters and servlets.
70 */
71 public class MetaServlet extends HttpServlet {
72 private static final long serialVersionUID = 1L;
73
74 private final MetaFilter filter;
75
76 /**
77 * Empty servlet with no bindings.
78 */
79 public MetaServlet() {
80 this(new MetaFilter());
81 }
82
83 /**
84 * Initialize a servlet wrapping a filter.
85 *
86 * @param delegateFilter
87 * the filter being wrapped by the servlet.
88 */
89 protected MetaServlet(MetaFilter delegateFilter) {
90 filter = delegateFilter;
91 }
92
93 /**
94 * Get delegate filter
95 *
96 * @return filter this servlet delegates all routing logic to.
97 */
98 protected MetaFilter getDelegateFilter() {
99 return filter;
100 }
101
102 /**
103 * Construct a binding for a specific path.
104 *
105 * @param path
106 * pattern to match.
107 * @return binder for the passed path.
108 */
109 public ServletBinder serve(String path) {
110 return filter.serve(path);
111 }
112
113 /**
114 * Construct a binding for a regular expression.
115 *
116 * @param expression
117 * the regular expression to pattern match the URL against.
118 * @return binder for the passed expression.
119 */
120 public ServletBinder serveRegex(String expression) {
121 return filter.serveRegex(expression);
122 }
123
124 /** {@inheritDoc} */
125 @Override
126 public void init(ServletConfig config) throws ServletException {
127 String name = filter.getClass().getName();
128 ServletContext ctx = config.getServletContext();
129 filter.init(new NoParameterFilterConfig(name, ctx));
130 }
131
132 /** {@inheritDoc} */
133 @Override
134 public void destroy() {
135 filter.destroy();
136 }
137
138 /** {@inheritDoc} */
139 @Override
140 protected void service(HttpServletRequest req, HttpServletResponse res)
141 throws ServletException, IOException {
142 filter.doFilter(req, res,
143 (ServletRequest request, ServletResponse response) -> {
144 ((HttpServletResponse) response).sendError(SC_NOT_FOUND);
145 });
146 }
147
148 /**
149 * Configure a newly created binder.
150 *
151 * @param b
152 * the newly created binder.
153 * @return binder for the caller, potentially after adding one or more
154 * filters into the pipeline.
155 */
156 protected ServletBinder../../../../org/eclipse/jgit/http/server/glue/ServletBinder.html#ServletBinder">ServletBinder register(ServletBinder b) {
157 return filter.register(b);
158 }
159 }