1 // ========================================================================
2 // Copyright (c) 2004-2009 Mort Bay Consulting Pty. Ltd.
3 // ------------------------------------------------------------------------
4 // All rights reserved. This program and the accompanying materials
5 // are made available under the terms of the Eclipse Public License v1.0
6 // and Apache License v2.0 which accompanies this distribution.
7 // The Eclipse Public License is available at
8 // http://www.eclipse.org/legal/epl-v10.html
9 // The Apache License v2.0 is available at
10 // http://www.opensource.org/licenses/apache2.0.php
11 // You may elect to redistribute this code under either of these licenses.
12 // ========================================================================
13
14 package org.eclipse.jetty.server;
15
16 import java.io.IOException;
17
18 import javax.servlet.ServletException;
19 import javax.servlet.http.HttpServletRequest;
20 import javax.servlet.http.HttpServletResponse;
21
22 import org.eclipse.jetty.server.handler.HandlerCollection;
23 import org.eclipse.jetty.server.handler.HandlerWrapper;
24 import org.eclipse.jetty.util.component.LifeCycle;
25
26 /* ------------------------------------------------------------ */
27 /** A Jetty Server Handler.
28 *
29 * A Handler instance is required by a {@link Server} to handle incoming
30 * HTTP requests. A Handler may: <ul>
31 * <li>Completely generate the HTTP Response</li>
32 * <li>Examine/modify the request and call another Handler (see {@link HandlerWrapper}).
33 * <li>Pass the request to one or more other Handlers (see {@link HandlerCollection}).
34 * </ul>
35 *
36 * Handlers are passed the servlet API request and response object, but are
37 * not Servlets. The servlet container is implemented by handlers for
38 * context, security, session and servlet that modify the request object
39 * before passing it to the next stage of handling.
40 *
41 */
42 public interface Handler extends LifeCycle
43 {
44 /* ------------------------------------------------------------ */
45 /** Handle a request.
46 * @param target The target of the request - either a URI or a name.
47 * @param baseRequest The original unwrapped request object.
48 * @param request The request either as the {@link Request}
49 * object or a wrapper of that request. The {@link HttpConnection#getCurrentConnection()}
50 * method can be used access the Request object if required.
51 * @param response The response as the {@link Response}
52 * object or a wrapper of that request. The {@link HttpConnection#getCurrentConnection()}
53 * method can be used access the Response object if required.
54 * @throws IOException
55 * @throws ServletException
56 */
57 public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)
58 throws IOException, ServletException;
59
60 public void setServer(Server server);
61 public Server getServer();
62
63 public void destroy();
64
65 }
66