jakarta.ws.rs.client.SyncInvoker 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) 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;
import jakarta.ws.rs.ProcessingException;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.GenericType;
import jakarta.ws.rs.core.Response;
/**
* Uniform interface for synchronous invocation of HTTP methods.
*
* @author Marek Potociar
* @since 2.0
*/
public interface SyncInvoker {
// GET
/**
* Invoke HTTP GET method for the current request synchronously.
*
* @return invocation response.
* @throws jakarta.ws.rs.ProcessingException in case the invocation processing has failed.
*/
Response get();
/**
* Invoke HTTP GET method for the current request synchronously.
*
* @param response entity type.
* @param responseType Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T get(Class responseType);
/**
* Invoke HTTP GET method for the current request synchronously.
*
* @param generic response entity type.
* @param responseType representation of a generic Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}
*/
T get(GenericType responseType);
// PUT
/**
* Invoke HTTP PUT method for the current request synchronously.
*
* @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.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response put(Entity entity);
/**
* Invoke HTTP PUT method for the current request synchronously.
*
* @param response entity type.
* @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.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T put(Entity entity, Class responseType);
/**
* Invoke HTTP PUT method for the current request synchronously.
*
* @param generic response entity type.
* @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.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}.
*/
T put(Entity entity, GenericType responseType);
// POST
/**
* Invoke HTTP POST method for the current request synchronously.
*
* @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.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response post(Entity entity);
/**
* Invoke HTTP POST method for the current request synchronously.
*
* @param response entity type.
* @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.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T post(Entity entity, Class responseType);
/**
* Invoke HTTP POST method for the current request synchronously.
*
* @param generic response entity type.
* @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.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}.
*/
T post(Entity entity, GenericType responseType);
// DELETE
/**
* Invoke HTTP DELETE method for the current request synchronously.
*
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response delete();
/**
* Invoke HTTP DELETE method for the current request synchronously.
*
* @param response entity type.
* @param responseType Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T delete(Class responseType);
/**
* Invoke HTTP DELETE method for the current request synchronously.
*
* @param generic response entity type.
* @param responseType representation of a generic Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}.
*/
T delete(GenericType responseType);
// HEAD
/**
* Invoke HTTP HEAD method for the current request synchronously.
*
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response head();
// OPTIONS
/**
* Invoke HTTP OPTIONS method for the current request synchronously.
*
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response options();
/**
* Invoke HTTP OPTIONS method for the current request synchronously.
*
* @param response entity type.
* @param responseType Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T options(Class responseType);
/**
* Invoke HTTP OPTIONS method for the current request synchronously.
*
* @param generic response entity type.
* @param responseType representation of a generic Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}.
*/
T options(GenericType responseType);
// TRACE
/**
* Invoke HTTP TRACE method for the current request synchronously.
*
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response trace();
/**
* Invoke HTTP TRACE method for the current request synchronously.
*
* @param response entity type.
* @param responseType Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T trace(Class responseType);
/**
* Invoke HTTP TRACE method for the current request synchronously.
*
* @param generic response entity type.
* @param responseType representation of a generic Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}.
*/
T trace(GenericType responseType);
// ARBITRARY METHOD
/**
* Invoke an arbitrary method for the current request synchronously.
*
* @param name method name.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response method(String name);
/**
* Invoke an arbitrary method for the current request synchronously.
*
* @param response entity type.
* @param name method name.
* @param responseType Java type the response entity will be converted to.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T method(String name, Class responseType);
/**
* Invoke an arbitrary method for the current request synchronously.
*
* @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.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}.
*/
T method(String name, GenericType responseType);
/**
* Invoke an arbitrary method for the current request synchronously.
*
* @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.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
*/
Response method(String name, Entity entity);
/**
* Invoke an arbitrary method for the current request synchronously.
*
* @param response entity type.
* @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.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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}.
*/
T method(String name, Entity entity, Class responseType);
/**
* Invoke an arbitrary method for the current request synchronously.
*
* @param generic response entity type.
* @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.
* @return invocation response.
* @throws 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 ProcessingException in case the request processing or subsequent I/O operation fails.
* @throws 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 generic response type does
* not represent {@link jakarta.ws.rs.core.Response}.
*/
T method(String name, Entity entity, GenericType responseType);
}