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.Destroyable; 25 import org.eclipse.jetty.util.component.LifeCycle; 26 27 /* ------------------------------------------------------------ */ 28 /** A Jetty Server Handler. 29 * 30 * A Handler instance is required by a {@link Server} to handle incoming 31 * HTTP requests. A Handler may: <ul> 32 * <li>Completely generate the HTTP Response</li> 33 * <li>Examine/modify the request and call another Handler (see {@link HandlerWrapper}). 34 * <li>Pass the request to one or more other Handlers (see {@link HandlerCollection}). 35 * </ul> 36 * 37 * Handlers are passed the servlet API request and response object, but are 38 * not Servlets. The servlet container is implemented by handlers for 39 * context, security, session and servlet that modify the request object 40 * before passing it to the next stage of handling. 41 * 42 */ 43 public interface Handler extends LifeCycle, Destroyable 44 { 45 /* ------------------------------------------------------------ */ 46 /** Handle a request. 47 * @param target The target of the request - either a URI or a name. 48 * @param baseRequest The original unwrapped request object. 49 * @param request The request either as the {@link Request} 50 * object or a wrapper of that request. The {@link HttpConnection#getCurrentConnection()} 51 * method can be used access the Request object if required. 52 * @param response The response as the {@link Response} 53 * object or a wrapper of that request. The {@link HttpConnection#getCurrentConnection()} 54 * method can be used access the Response object if required. 55 * @throws IOException 56 * @throws ServletException 57 */ 58 public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) 59 throws IOException, ServletException; 60 61 public void setServer(Server server); 62 public Server getServer(); 63 64 public void destroy(); 65 66 } 67