All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.ws.rs.client.AsyncInvoker Maven / Gradle / Ivy

Go to download

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.8
Show newest version
/*
 * 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;

import java.util.concurrent.Future;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.Response;

/**
 * Uniform interface for asynchronous invocation of HTTP methods.
 *
 * @author Marek Potociar
 * @since 2.0
 */
public interface AsyncInvoker {

    // GET

    /**
     * Invoke HTTP GET method for the current request asynchronously.
     * 

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * Note that 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 Response} * instance whose processing has failed. *

* * @return invocation response {@link Future future}. */ Future get(); /** * Invoke HTTP GET method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future get(Class responseType); /** * Invoke HTTP GET method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future get(GenericType responseType); /** * Invoke HTTP GET method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future get(InvocationCallback callback); // PUT /** * Invoke HTTP PUT method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @return invocation response {@link Future future}. */ Future put(Entity entity); /** * Invoke HTTP PUT method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future put(Entity entity, Class responseType); /** * Invoke HTTP PUT method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future put(Entity entity, GenericType responseType); /** * Invoke HTTP PUT method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future put(Entity entity, InvocationCallback callback); // POST /** * Invoke HTTP POST method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @return invocation response {@link Future future}. * @throws javax.ws.rs.ProcessingException * in case the invocation processing has failed. */ Future post(Entity entity); /** * Invoke HTTP POST method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future post(Entity entity, Class responseType); /** * Invoke HTTP POST method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future post(Entity entity, GenericType responseType); /** * Invoke HTTP POST method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future post(Entity entity, InvocationCallback callback); // DELETE /** * Invoke HTTP DELETE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @return invocation response {@link Future future}. */ Future delete(); /** * Invoke HTTP DELETE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future delete(Class responseType); /** * Invoke HTTP DELETE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future delete(GenericType responseType); /** * Invoke HTTP DELETE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future delete(InvocationCallback callback); // HEAD /** * Invoke HTTP HEAD method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @return invocation response {@link Future future}. */ Future head(); /** * Invoke HTTP HEAD method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future head(InvocationCallback callback); // OPTIONS /** * Invoke HTTP OPTIONS method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @return invocation response {@link Future future}. */ Future options(); /** * Invoke HTTP OPTIONS method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future options(Class responseType); /** * Invoke HTTP OPTIONS method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future options(GenericType responseType); /** * Invoke HTTP OPTIONS method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future options(InvocationCallback callback); // TRACE /** * Invoke HTTP TRACE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @return invocation response {@link Future future}. */ Future trace(); /** * Invoke HTTP TRACE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future trace(Class responseType); /** * Invoke HTTP TRACE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future trace(GenericType responseType); /** * Invoke HTTP TRACE method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future trace(InvocationCallback callback); // ARBITRARY METHOD /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @param name method name. * @return invocation response {@link Future future}. */ Future method(String name); /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param name method name. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future method(String name, Class responseType); /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param name method name. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future method(String name, GenericType responseType); /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param name method name. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future method(String name, InvocationCallback callback); /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure. * 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 Response} * instance whose processing has failed. *

* * @param name method name. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @return invocation response {@link Future future}. */ Future method(String name, Entity entity); /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param response entity type. * @param name method name. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param responseType Java type the response entity will be converted to. * @return invocation response {@link Future future}. */ Future method(String name, Entity entity, Class responseType); /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the specified response 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param name method name. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param responseType representation of a generic Java type the response * entity will be converted to. * @return invocation response {@link Future future}. */ Future method(String name, Entity entity, GenericType responseType); /** * Invoke an arbitrary method for the current request asynchronously. *

* Note that calling the {@link java.util.concurrent.Future#get()} method on the returned * {@code Future} instance may throw an {@link java.util.concurrent.ExecutionException} * that wraps either a {@link javax.ws.rs.ProcessingException} thrown in case of an invocation processing * failure or a {@link WebApplicationException} or one of its subclasses thrown in case the * received response status code is not {@link javax.ws.rs.core.Response.Status.Family#SUCCESSFUL * successful} and the generic type of the supplied response callback 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 Response} * instance whose processing has failed. *

* * @param generic response entity type. * @param name method name. * @param entity request entity, including it's full {@link javax.ws.rs.core.Variant} information. * Any variant-related HTTP headers previously set (namely {@code Content-Type}, * {@code Content-Language} and {@code Content-Encoding}) will be overwritten using * the entity variant information. * @param callback asynchronous invocation callback. * @return invocation response {@link Future future}. */ Future method(String name, Entity entity, InvocationCallback callback); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy