javax.xml.ws.spi.http.HttpHandler Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.ws.spi.http;
import javax.xml.ws.Endpoint;
import java.io.IOException;
/**
* A handler which is invoked to process HTTP requests.
*
* JAX-WS runtime provides the implementation for this and sets
* it using {@link HttpContext#setHandler(HttpHandler)} during
* {@link Endpoint#publish(HttpContext) }
*
* @author Jitendra Kotamraju
* @since 1.7, JAX-WS 2.2
*/
public abstract class HttpHandler {
/**
* Handles a given request and generates an appropriate response.
* See {@link HttpExchange} for a description of the steps
* involved in handling an exchange. Container invokes this method
* when it receives an incoming request.
*
* @param exchange the exchange containing the request from the
* client and used to send the response
* @throws IOException when an I/O error happens during request
* handling
*/
public abstract void handle(HttpExchange exchange) throws IOException;
}