jakarta.ws.rs.client.InvocationCallback Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.6

Show newest version

/*
 * Copyright (c) 2011, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ws.rs.client;

/**
 * Callback that can be implemented to receive the asynchronous processing events from the invocation processing.
 *
 * @param  response type. It can be either a general-purpose {@link jakarta.ws.rs.core.Response} or the
 * anticipated response entity type.
 * @author Marek Potociar
 * @since 2.0
 */
public interface InvocationCallback {

    /**
     * Called when the invocation was successfully completed. Note that this does not necessarily mean the response has bean
     * fully read, which depends on the parameterized invocation callback response type.
     * 
     * Once this invocation callback method returns, the underlying {@link jakarta.ws.rs.core.Response} instance will be
     * automatically closed by the runtime.
     * 
     *
     * @param response response data.
     */
    public void completed(RESPONSE response);

    /**
     * Called when the invocation has failed for any reason.
     * 
     * Note that the provided {@link Throwable} may be a {@link jakarta.ws.rs.ProcessingException} in case the invocation
     * processing failure has been caused by a client-side runtime component error. The {@code Throwable} may also be a
     * {@link jakarta.ws.rs.WebApplicationException} or one of its subclasses in case the response status code is not
     * {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the generic callback type is not
     * {@link jakarta.ws.rs.core.Response}. In case a processing of a properly received response fails, the wrapped processing
     * exception will be of {@link ResponseProcessingException} type and will contain the {@link jakarta.ws.rs.core.Response}
     * instance whose processing has failed. A {@link java.util.concurrent.CancellationException} would be indicate that the
     * invocation has been cancelled. An {@link InterruptedException} would indicate that the thread executing the
     * invocation has been interrupted.
     * 
     * 
     * Once this invocation callback method returns, the underlying {@link jakarta.ws.rs.core.Response} instance will be
     * automatically closed by the runtime.
     * 
     *
     * @param throwable contains failure details.
     */
    public void failed(Throwable throwable);
}