javax.ws.rs.container.CompletionCallback Maven / Gradle / Ivy

Go to download

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.9

Show newest version

/*
 * Copyright (c) 2012, 2017 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 javax.ws.rs.container;

/**
 * A request processing callback that receives request processing completion events.
 * 
 * A completion callback is invoked when the whole request processing is over, i.e.
 * once a response for the request has been processed and sent back to the client
 * or in when an unmapped exception or error is being propagated to the container.
 * 
 *
 * @author Marek Potociar
 * @since 2.0
 */
public interface CompletionCallback {
    /**
     * A completion callback notification method that will be invoked when the request
     * processing is finished, after a response is processed and is sent back to the
     * client or when an unmapped throwable has been propagated to the hosting I/O
     * container.
     * 
     * An unmapped throwable is propagated to the hosting I/O container in case no
     * {@link javax.ws.rs.ext.ExceptionMapper exception mapper} has been found for
     * a throwable indicating a request processing failure.
     * In this case a non-{@code null} unmapped throwable instance is passed to the method.
     * Note that the throwable instance represents the actual unmapped exception thrown
     * during the request processing, before it has been wrapped into an I/O container-specific
     * exception that was used to propagate the throwable to the hosting I/O container.
     * 
     *
     * @param throwable is {@code null}, if the request processing has completed with a response
     *                  that has been sent to the client. In case the request processing resulted
     *                  in an unmapped exception or error that has been propagated to the hosting
     *                  I/O container, this parameter contains the unmapped exception instance.
     */
    public void onComplete(Throwable throwable);
}