1 /*
   2  * Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.ws.spi.http;
  27 
  28 import javax.xml.ws.Endpoint;
  29 import java.io.IOException;
  30 
  31 /**
  32  * A handler which is invoked to process HTTP requests.
  33  * <p>
  34  * JAX-WS runtime provides the implementation for this and sets
  35  * it using {@link HttpContext#setHandler(HttpHandler)} during
  36  * {@link Endpoint#publish(HttpContext) }
  37  *
  38  * @author Jitendra Kotamraju
  39  * @since 1.7, JAX-WS 2.2
  40  */
  41 public abstract class HttpHandler {
  42     /**
  43      * Handles a given request and generates an appropriate response.
  44      * See {@link HttpExchange} for a description of the steps
  45      * involved in handling an exchange. Container invokes this method
  46      * when it receives an incoming request.
  47      *
  48      * @param exchange the exchange containing the request from the
  49      *      client and used to send the response
  50      * @throws IOException when an I/O error happens during request
  51      *      handling
  52      */
  53     public abstract void handle(HttpExchange exchange) throws IOException;
  54 }