Index (MicroProfile Rest Client API)

A B C D E F G H I K L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

applyContext() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptor: This method will be invoked by the MP Rest Client runtime on the "async" thread (i.e.
ARRAY_PAIRS - Enum constant in enum org.eclipse.microprofile.rest.client.ext.QueryParamStyle: Multiple parameter instances with square brackets for each parameter, e.g.: foo[]=v1&foo[]=v2&foo[]=v3
AsyncInvocationInterceptor - Interface in org.eclipse.microprofile.rest.client.ext: Implementations of this interface can intercept asynchronous method invocations.
AsyncInvocationInterceptorFactory - Interface in org.eclipse.microprofile.rest.client.ext: This is a provider interface intended for intercepting asynchronous method invocations.

B

baseUri() - Element in annotation type org.eclipse.microprofile.rest.client.inject.RegisterRestClient: Sets the base URI for the rest client interface.
baseUri(String) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies the base URI to be used when making requests.
baseUri(URI) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies the base URI to be used when making requests.
baseUrl(URL) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies the base URL to be used when making requests.
build(Class<T>) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Based on the configured RestClientBuilder, creates a new instance of the given REST interface to invoke API calls against.

C

ClientHeaderParam - Annotation Type in org.eclipse.microprofile.rest.client.annotation: Used to specify an HTTP parameter that should be sent with the outbound request.
ClientHeaderParams - Annotation Type in org.eclipse.microprofile.rest.client.annotation: Used to specify HTTP parameters that should be sent with the outbound request.
ClientHeadersFactory - Interface in org.eclipse.microprofile.rest.client.ext: This interface is intended for generating or propagating HTTP headers.
COMMA_SEPARATED - Enum constant in enum org.eclipse.microprofile.rest.client.ext.QueryParamStyle: A single parameter instance with multiple, comma-separated values, e.g.: foo=v1,v2,v3
configKey() - Element in annotation type org.eclipse.microprofile.rest.client.inject.RegisterRestClient: Associates the annotated rest client interface with this configuration key.
connectTimeout(long, TimeUnit) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Set the connect timeout.

D

DEFAULT_PRIORITY - Static variable in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper
DefaultClientHeadersFactoryImpl - Class in org.eclipse.microprofile.rest.client.ext: This class propagates Jakarta RESTful Web Services headers whose names are specified using the MicroProfile Config property, org.eclipse.microprofile.rest.client.propagateHeaders.
DefaultClientHeadersFactoryImpl() - Constructor for class org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl

E

executorService(ExecutorService) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies the ExecutorService to use when invoking asynchronous Rest Client interface methods.

F

followRedirects(boolean) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies whether client built by this builder should follow HTTP redirect responses (30x) or not.

G

getPriority() - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper: The priority of this mapper.

H

handles(int, MultivaluedMap<String, Object>) - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper: Whether or not this mapper will be used for the given response.
header(String, Object) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Add an arbitrary header.
hostnameVerifier(HostnameVerifier) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Set the hostname verifier to verify the endpoint's hostname

I

instance() - Static method in class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver: Gets or creates a RestClientBuilderResolver instance.

K

keyStore(KeyStore, String) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Set the client-side key store.

L

LITERAL - Static variable in annotation type org.eclipse.microprofile.rest.client.inject.RestClient

M

MULTI_PAIRS - Enum constant in enum org.eclipse.microprofile.rest.client.ext.QueryParamStyle: Multiple parameter instances, e.g.: foo=v1&foot=v2&foo=v3 This is the default if no style is configured.

N

name() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam
newBuilder() - Static method in interface org.eclipse.microprofile.rest.client.RestClientBuilder
newBuilder() - Method in class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver: Creates a new RestClientBuilder instance.
newInterceptor() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptorFactory: Implementations of this method should return an implementation of the AsyncInvocationInterceptor interface.

O

onNewBuilder(RestClientBuilder) - Method in interface org.eclipse.microprofile.rest.client.spi.RestClientBuilderListener
onNewClient(Class<?>, RestClientBuilder) - Method in interface org.eclipse.microprofile.rest.client.spi.RestClientListener
org.eclipse.microprofile.rest.client - package org.eclipse.microprofile.rest.client: APIs for building a type-safe RESTful client leveraging existing Jakarta RESTful Web Services APIs, for example:
org.eclipse.microprofile.rest.client.annotation - package org.eclipse.microprofile.rest.client.annotation: APIs for annotating MP Rest Client interfaces.
org.eclipse.microprofile.rest.client.ext - package org.eclipse.microprofile.rest.client.ext: APIs for extending MP Rest Client functionality - such as new providers.
org.eclipse.microprofile.rest.client.inject - package org.eclipse.microprofile.rest.client.inject: APIs to aid in CDI-based injection of MP Rest Client implementations.
org.eclipse.microprofile.rest.client.spi - package org.eclipse.microprofile.rest.client.spi: SPIs for MP Rest Client implementations or system-level components that provide additional functionality for MP Rest Clients.

P

prepareContext() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptor: This method will be invoked by the MP Rest Client runtime on the "main" thread (i.e.
priority() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.RegisterProvider
PROPAGATE_PROPERTY - Static variable in class org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl
proxyAddress(String, int) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies the HTTP proxy hostname/IP address and port to use for requests from client instances.

Q

queryParamStyle(QueryParamStyle) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies the URI formatting style to use when multiple query parameter values are passed to the client.
QueryParamStyle - Enum in org.eclipse.microprofile.rest.client.ext: A QueryParamStyle enum is used to specify how multiple values are handled when constructing the query portion of the URI.

R

readTimeout(long, TimeUnit) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Set the read timeout.
RegisterClientHeaders - Annotation Type in org.eclipse.microprofile.rest.client.annotation: Used to specify that a ClientHeadersFactory should be used to generate or propagate HTTP headers on the outbound request.
RegisterProvider - Annotation Type in org.eclipse.microprofile.rest.client.annotation: When annotation is placed at the interface level of a REST API definition, the providers listed will be registered upon proxying.
RegisterProviders - Annotation Type in org.eclipse.microprofile.rest.client.annotation: When annotation is placed at the interface level of a REST API definition, the providers listed will be registered upon proxying.
RegisterRestClient - Annotation Type in org.eclipse.microprofile.rest.client.inject: A marker annotation to register a rest client at runtime.
removeContext() - Method in interface org.eclipse.microprofile.rest.client.ext.AsyncInvocationInterceptor: This method will be invoked by the MP Rest Client runtime on the "async" thread (i.e.
required() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam
ResponseExceptionMapper<T extends Throwable> - Interface in org.eclipse.microprofile.rest.client.ext: Converts an Jakarta RESTful Web Services Response object into an Exception.
RestClient - Annotation Type in org.eclipse.microprofile.rest.client.inject: Use the RestClient qualifier on an injection to point to indicate that this injection point is meant to use an instance of a Type-Safe Rest Client.
RestClient.RestClientLiteral - Class in org.eclipse.microprofile.rest.client.inject
RestClientBuilder - Interface in org.eclipse.microprofile.rest.client: This is the main entry point for creating a Type Safe Rest Client.
RestClientBuilderListener - Interface in org.eclipse.microprofile.rest.client.spi: Implementations of this interface will be notified when new RestClientBuilder instances are being constructed.
RestClientBuilderResolver - Class in org.eclipse.microprofile.rest.client.spi: Resolver for a RestClientBuilder implementation.
RestClientBuilderResolver() - Constructor for class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver
RestClientDefinitionException - Exception in org.eclipse.microprofile.rest.client: This exception is thrown when the MicroProfile Rest Client implementation attempts to build a client using an invalid interface.
RestClientDefinitionException() - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
RestClientDefinitionException(String) - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
RestClientDefinitionException(String, Throwable) - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
RestClientDefinitionException(Throwable) - Constructor for exception org.eclipse.microprofile.rest.client.RestClientDefinitionException
RestClientListener - Interface in org.eclipse.microprofile.rest.client.spi: Implementations of this interface will be notified when new Rest Client instances are being constructed.
RestClientLiteral() - Constructor for class org.eclipse.microprofile.rest.client.inject.RestClient.RestClientLiteral

S

setInstance(RestClientBuilderResolver) - Static method in class org.eclipse.microprofile.rest.client.spi.RestClientBuilderResolver: Set the instance.
sslContext(SSLContext) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Specifies the SSL context to use when creating secured transport connections to server endpoints from web targets created by the client instance that is using this SSL context.

T

toThrowable(Response) - Method in interface org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper: Converts a given Response into a Throwable.
trustStore(KeyStore) - Method in interface org.eclipse.microprofile.rest.client.RestClientBuilder: Set the client-side trust store.

U

update(MultivaluedMap<String, String>, MultivaluedMap<String, String>) - Method in interface org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory: Updates the HTTP headers to send to the remote service.
update(MultivaluedMap<String, String>, MultivaluedMap<String, String>) - Method in class org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl

V

value() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.ClientHeaderParam
value() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.ClientHeaderParams
value() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders
value() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.RegisterProvider
value() - Element in annotation type org.eclipse.microprofile.rest.client.annotation.RegisterProviders
valueOf(String) - Static method in enum org.eclipse.microprofile.rest.client.ext.QueryParamStyle: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.rest.client.ext.QueryParamStyle: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I K L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form