javax.ws.rs.client.InvocationCallback Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2011-2013 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
* http://glassfish.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.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 javax.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 javax.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 javax.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 javax.ws.rs.WebApplicationException} or one
* of its subclasses in case the response status code is not
* {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the generic
* callback type is not {@link javax.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 javax.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 javax.ws.rs.core.Response}
* instance will be automatically closed by the runtime.
*
*
* @param throwable contains failure details.
*/
public void failed(Throwable throwable);
}