javax.xml.ws.Provider Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2005-2010 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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;
/**
* Service endpoints may implement the Provider
* interface as a dynamic alternative to an SEI.
*
*
Implementations are required to support Provider<Source>,
* Provider<SOAPMessage> and
* Provider<DataSource>, depending on the binding
* in use and the service mode.
*
*
The ServiceMode annotation can be used to control whether
* the Provider instance will receive entire protocol messages
* or just message payloads.
*
* @since JAX-WS 2.0
*
* @see javax.xml.transform.Source
* @see javax.xml.soap.SOAPMessage
* @see javax.xml.ws.ServiceMode
**/
public interface Provider {
/** Invokes an operation occording to the contents of the request
* message.
*
* @param request The request message or message payload.
* @return The response message or message payload. May be null if
there is no response.
* @throws WebServiceException If there is an error processing request.
* The cause of the WebServiceException may be set to a subclass
* of ProtocolException to control the protocol level
* representation of the exception.
* @see javax.xml.ws.handler.MessageContext
* @see javax.xml.ws.ProtocolException
**/
public T invoke(T request);
}