com.sun.xml.ws.api.server.AsyncProviderCallback Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2019 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
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);
}