jakarta.ws.rs.client.RxInvoker 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
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.
/*
* Copyright (c) 2015, 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;
import jakarta.ws.rs.core.GenericType;
/**
* Uniform interface for reactive invocation of HTTP methods. All reactive invokers in JAX-RS must implement this
* interface. The type parameter {@code T} represents the Java type of an asynchronous computation. All JAX-RS
* implementations MUST support the default reactive invoker based on {@link java.util.concurrent.CompletionStage}.
*
* @param a type representing the asynchronous computation.
* @author Marek Potociar
* @author Santiago Pericas-Geertsen
* @see jakarta.ws.rs.client.CompletionStageRxInvoker
* @since 2.1
*/
public interface RxInvoker {
/**
* Invoke HTTP GET method for the current request.
*
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T get();
/**
* Invoke HTTP GET method for the current request.
*
* @param responseType Java type the response entity will be converted to.
* @param response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T get(Class responseType);
/**
* Invoke HTTP GET method for the current request.
*
* @param responseType representation of a generic Java type the response entity will be converted to.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T get(GenericType responseType);
/**
* Invoke HTTP PUT method for the current request.
*
* @param entity request entity, including it's full {@link jakarta.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 wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T put(Entity entity);
/**
* Invoke HTTP PUT method for the current request.
*
* @param entity request entity, including it's full {@link jakarta.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.
* @param response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T put(Entity entity, Class responseType);
/**
* Invoke HTTP PUT method for the current request.
*
* @param entity request entity, including it's full {@link jakarta.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.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T put(Entity entity, GenericType responseType);
/**
* Invoke HTTP POST method for the current request.
*
* @param entity request entity, including it's full {@link jakarta.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 wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T post(Entity entity);
/**
* Invoke HTTP POST method for the current request.
*
* @param entity request entity, including it's full {@link jakarta.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.
* @param response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T post(Entity entity, Class responseType);
/**
* Invoke HTTP POST method for the current request.
*
* @param entity request entity, including it's full {@link jakarta.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.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T post(Entity entity, GenericType responseType);
/**
* Invoke HTTP DELETE method for the current request.
*
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T delete();
/**
* Invoke HTTP DELETE method for the current request.
*
* @param responseType Java type the response entity will be converted to.
* @param response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T delete(Class responseType);
/**
* Invoke HTTP DELETE method for the current request.
*
* @param responseType representation of a generic Java type the response entity will be converted to.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T delete(GenericType responseType);
/**
* Invoke HTTP HEAD method for the current request.
*
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T head();
/**
* Invoke HTTP OPTIONS method for the current request.
*
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T options();
/**
* Invoke HTTP OPTIONS method for the current request.
*
* @param responseType Java type the response entity will be converted to.
* @param response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T options(Class responseType);
/**
* Invoke HTTP OPTIONS method for the current request.
*
* @param responseType representation of a generic Java type the response entity will be converted to.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T options(GenericType responseType);
/**
* Invoke HTTP TRACE method for the current request.
*
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T trace();
/**
* Invoke HTTP TRACE method for the current request.
*
* @param responseType Java type the response entity will be converted to.
* @param response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T trace(Class responseType);
/**
* Invoke HTTP TRACE method for the current request.
*
* @param responseType representation of a generic Java type the response entity will be converted to.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type.
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T trace(GenericType responseType);
/**
* Invoke an arbitrary method for the current request.
*
* @param name method name.
* @return invocation response wrapped in the completion aware type..
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T method(String name);
/**
* Invoke an arbitrary method for the current request.
*
* @param name method name.
* @param responseType Java type the response entity will be converted to.
* @param response entity type.
* @return invocation response wrapped in the completion aware type..
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T method(String name, Class responseType);
/**
* Invoke an arbitrary method for the current request.
*
* @param name method name.
* @param responseType representation of a generic Java type the response entity will be converted to.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type..
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T method(String name, GenericType responseType);
/**
* Invoke an arbitrary method for the current request.
*
* @param name method name.
* @param entity request entity, including it's full {@link jakarta.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 wrapped in the completion aware type..
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
*/
public T method(String name, Entity entity);
/**
* Invoke an arbitrary method for the current request.
*
* @param name method name.
* @param entity request entity, including it's full {@link jakarta.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.
* @param response entity type.
* @return invocation response wrapped in the completion aware type..
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T method(String name, Entity entity, Class responseType);
/**
* Invoke an arbitrary method for the current request.
*
* @param name method name.
* @param entity request entity, including it's full {@link jakarta.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.
* @param generic response entity type.
* @return invocation response wrapped in the completion aware type..
* @throws jakarta.ws.rs.client.ResponseProcessingException in case processing of a received HTTP response fails (e.g. in
* a filter or during conversion of the response entity data to an instance of a particular Java type).
* @throws jakarta.ws.rs.ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws jakarta.ws.rs.WebApplicationException in case the response status code of the response returned by the server
* is not {@link jakarta.ws.rs.core.Response.Status.Family#SUCCESSFUL successful} and the specified response type is not
* {@link jakarta.ws.rs.core.Response}.
*/
public T method(String name, Entity entity, GenericType responseType);
}