com.sun.xml.ws.api.server.AsyncProviderCallback Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. 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.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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 com.sun.xml.ws.api.server;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
/**
* Callback interface to signal JAX-WS RI that the processing of an asynchronous request is complete.
*
*
* The application is responsible for invoking one of the two defined methods to
* indicate the result of the request processing.
*
*
* Both methods will return immediately, and the JAX-WS RI will
* send out an actual response at some later point.
*
* @author Jitendra Kotamraju
* @author Kohsuke Kawaguchi
* @since 2.1
* @see AsyncProvider
*/
public interface AsyncProviderCallback {
/**
* Indicates that a request was processed successfully.
*
* @param response
* Represents an object to be sent back to the client
* as a response. To indicate one-way, response needs to be null
*/
void send(@Nullable T response);
/**
* Indicates that an error had occured while processing a request.
*
* @param t
* The error is propagated to the client. For example, if this is
* a SOAP-based web service, the server will send back a SOAP fault.
*/
void sendError(@NotNull Throwable t);
}