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.FilterChain;
51 import javax.servlet.ServletConfig;
52 import javax.servlet.ServletContext;
53 import javax.servlet.ServletException;
54 import javax.servlet.ServletRequest;
55 import javax.servlet.ServletResponse;
56 import javax.servlet.http.HttpServlet;
57 import javax.servlet.http.HttpServletRequest;
58 import javax.servlet.http.HttpServletResponse;
59
60 /**
61 * Generic container servlet to manage routing to different pipelines.
62 * <p>
63 * Callers can create and configure a new processing pipeline by using one of
64 * the {@link #serve(String)} or {@link #serveRegex(String)} methods to allocate
65 * a binder for a particular URL pattern.
66 * <p>
67 * Registered filters and servlets are initialized lazily, usually during the
68 * first request. Once initialized the bindings in this servlet cannot be
69 * modified without destroying the servlet and thereby destroying all registered
70 * filters and servlets.
71 */
72 public class MetaServlet extends HttpServlet {
73 private static final long serialVersionUID = 1L;
74
75 private final MetaFilter filter;
76
77 /**
78 * Empty servlet with no bindings.
79 */
80 public MetaServlet() {
81 this(new MetaFilter());
82 }
83
84 /**
85 * Initialize a servlet wrapping a filter.
86 *
87 * @param delegateFilter
88 * the filter being wrapped by the servlet.
89 */
90 protected MetaServlet(MetaFilter delegateFilter) {
91 filter = delegateFilter;
92 }
93
94 /**
95 * Get delegate filter
96 *
97 * @return filter this servlet delegates all routing logic to.
98 */
99 protected MetaFilter getDelegateFilter() {
100 return filter;
101 }
102
103 /**
104 * Construct a binding for a specific path.
105 *
106 * @param path
107 * pattern to match.
108 * @return binder for the passed path.
109 */
110 public ServletBinder serve(String path) {
111 return filter.serve(path);
112 }
113
114 /**
115 * Construct a binding for a regular expression.
116 *
117 * @param expression
118 * the regular expression to pattern match the URL against.
119 * @return binder for the passed expression.
120 */
121 public ServletBinder serveRegex(String expression) {
122 return filter.serveRegex(expression);
123 }
124
125 /** {@inheritDoc} */
126 @Override
127 public void init(ServletConfig config) throws ServletException {
128 String name = filter.getClass().getName();
129 ServletContext ctx = config.getServletContext();
130 filter.init(new NoParameterFilterConfig(name, ctx));
131 }
132
133 /** {@inheritDoc} */
134 @Override
135 public void destroy() {
136 filter.destroy();
137 }
138
139 /** {@inheritDoc} */
140 @Override
141 protected void service(HttpServletRequest req, HttpServletResponse res)
142 throws ServletException, IOException {
143 filter.doFilter(req, res, new FilterChain() {
144 @Override
145 public void doFilter(ServletRequest request,
146 ServletResponse response) throws IOException,
147 ServletException {
148 ((HttpServletResponse) response).sendError(SC_NOT_FOUND);
149 }
150 });
151 }
152
153 /**
154 * Configure a newly created binder.
155 *
156 * @param b
157 * the newly created binder.
158 * @return binder for the caller, potentially after adding one or more
159 * filters into the pipeline.
160 */
161 protected ServletBinder register(ServletBinder b) {
162 return filter.register(b);
163 }
164 }