Index (sda-commons-client-jersey 7.0.25 API)

A B C D E F G H I J O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addFeature(Feature) - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: Adds a feature used by the client.
addFilter(ClientRequestFilter) - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: Adds a request filter to the client.
AddRequestHeaderFilter - Interface in org.sdase.commons.client.jersey.filter: A ClientRequestFilter that adds a Http header if that header is not set yet and the implementation provides a value for the header.
AfterCreateExpiry - Class in org.sdase.commons.client.jersey.oidc.cache
AfterCreateExpiry() - Constructor for class org.sdase.commons.client.jersey.oidc.cache.AfterCreateExpiry
allClientErrors() - Element in annotation interface org.sdase.commons.client.jersey.proxy.annotation.SuppressHttpErrorsToNull
allRedirectErrors() - Element in annotation interface org.sdase.commons.client.jersey.proxy.annotation.SuppressHttpErrorsToNull
allServerErrors() - Element in annotation interface org.sdase.commons.client.jersey.proxy.annotation.SuppressHttpErrorsToNull
api(Class<A>) - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: Creates a client proxy implementation for accessing another service.
api(Class<A>, String) - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: Creates a client proxy implementation for accessing another service.
ApiClientBuilder<A> - Class in org.sdase.commons.client.jersey.builder: Builder to create clients from JAX-RS annotated interfaces.
ApiClientInvocationHandler - Class in org.sdase.commons.client.jersey.proxy
atTarget(String) - Method in class org.sdase.commons.client.jersey.builder.ApiClientBuilder: Creates the client proxy that can be used to access the api.
AuthHeaderClientFilter - Class in org.sdase.commons.client.jersey.filter: A client filter that adds the Authorization header from the incoming request context to the client request if no Authorization is set at the client request yet.
AuthHeaderClientFilter() - Constructor for class org.sdase.commons.client.jersey.filter.AuthHeaderClientFilter

B

build() - Method in class org.sdase.commons.client.jersey.JerseyClientBundle.Builder
build() - Method in interface org.sdase.commons.client.jersey.JerseyClientBundle.FinalBuilder
builder() - Static method in class org.sdase.commons.client.jersey.JerseyClientBundle
buildGenericClient(String) - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: Builds a generic client that can be used for Http requests.

C

CacheConfiguration - Class in org.sdase.commons.client.jersey.oidc.cache
CacheConfiguration() - Constructor for class org.sdase.commons.client.jersey.oidc.cache.CacheConfiguration
clearCache() - Method in class org.sdase.commons.client.jersey.oidc.OidcClient: Invalidate token in the cache.
ClientErrorUtil - Class in org.sdase.commons.client.jersey.error: A utility class to support handling of errors that are received from an outgoing request.
ClientErrorUtil.ResponseSupplier<T> - Interface in org.sdase.commons.client.jersey.error: A supplier that executes a request.
ClientFactory - Class in org.sdase.commons.client.jersey: A ClientFactory creates Http clients to access services within the SDA Platform or external services.
ClientRequestException - Exception in org.sdase.commons.client.jersey.error: Exception that wraps any WebApplicationException that occurred in a Http request to avoid that it is used to delegate the same response to the own caller by default exception mappers.
ClientRequestException(Throwable) - Constructor for exception org.sdase.commons.client.jersey.error.ClientRequestException
ClientRequestExceptionMapper - Class in org.sdase.commons.client.jersey.error: Exception mapper that converts ClientRequestException thrown from an outgoing request to another service into a 500 Internal Server Error response for our client.
ClientRequestExceptionMapper() - Constructor for class org.sdase.commons.client.jersey.error.ClientRequestExceptionMapper
close() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException: This implementation can be called multiple times and will never throw an exception.
ContainerRequestContextHolder - Class in org.sdase.commons.client.jersey.filter: A filter that provides the current request from a ThreadLocal.
ContainerRequestContextHolder() - Constructor for class org.sdase.commons.client.jersey.filter.ContainerRequestContextHolder
convertExceptions(ClientErrorUtil.ResponseSupplier<T>) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Wrapped around a request from a platform generic client of a external generic client to catch any WebApplicationException that is thrown during the request and convert it into ClientRequestException that is properly handled by ExceptionMappers for the incoming request.
createAccessToken() - Method in class org.sdase.commons.client.jersey.oidc.OidcClient: Retrieves a new access token from the token endpoint using the given OidcConfiguration.
createProxy(Class<T>, T) - Static method in class org.sdase.commons.client.jersey.proxy.ApiClientInvocationHandler: Creates a proxy around the given jerseyClientProxy that wraps all WebApplicationExceptions in ClientRequestExceptions.

D

DEFAULT_CONNECTION_TIMEOUT_MS - Static variable in class org.sdase.commons.client.jersey.HttpClientConfiguration: The default timeout to wait until a connection is established.
DEFAULT_TIMEOUT_MS - Static variable in class org.sdase.commons.client.jersey.HttpClientConfiguration: The default (read) timeout to wait for data in an established connection.
disableFollowRedirects() - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: Set this client to not follow redirects and therewith automatically resolve 3xx status codes

E

enableAuthenticationPassThrough() - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: If authentication pass through is enabled, the JWT in the "Authorization" header of an incoming request will be added to the outgoing request.
enableConsumerToken() - Method in class org.sdase.commons.client.jersey.builder.PlatformClientBuilder: If consumer token is enabled, the client will create a configured consumer token and add it as header to the outgoing request.
ERROR - Enum constant in enum class org.sdase.commons.client.jersey.oidc.model.OidcState
expireAfterCreate(String, TokenResource, long) - Method in class org.sdase.commons.client.jersey.oidc.cache.AfterCreateExpiry: Entries in the cache should only be valid for the lifetime of the token as specified in the expires_in property set by the issuer.
expireAfterRead(String, TokenResource, long, long) - Method in class org.sdase.commons.client.jersey.oidc.cache.AfterCreateExpiry: Not necessary for the cache but needs to be implemented to satisfy the Expiry interface.
expireAfterUpdate(String, TokenResource, long, long) - Method in class org.sdase.commons.client.jersey.oidc.cache.AfterCreateExpiry: Not necessary for the cache but needs to be implemented to satisfy the Expiry interface.
externalClient() - Method in class org.sdase.commons.client.jersey.ClientFactory: Starts creation of a client that calls APIs outside of the SDA SE Platform.
externalClient(HttpClientConfiguration) - Method in class org.sdase.commons.client.jersey.ClientFactory: Starts creation of a client that calls APIs outside of the SDA SE Platform.
ExternalClientBuilder - Class in org.sdase.commons.client.jersey.builder
ExternalClientBuilder(Environment, HttpClientConfiguration, OpenTelemetry) - Constructor for class org.sdase.commons.client.jersey.builder.ExternalClientBuilder

F

filter(ClientRequestContext) - Method in interface org.sdase.commons.client.jersey.filter.AddRequestHeaderFilter
filter(ClientRequestContext) - Method in class org.sdase.commons.client.jersey.filter.TraceTokenClientFilter
filter(ClientRequestContext) - Method in class org.sdase.commons.client.jersey.oidc.filter.OidcRequestFilter
filter(ClientRequestContext, ClientResponseContext) - Method in class org.sdase.commons.client.jersey.filter.TraceTokenClientFilter
filter(ContainerRequestContext) - Method in class org.sdase.commons.client.jersey.filter.ContainerRequestContextHolder
filter(ContainerRequestContext, ContainerResponseContext) - Method in class org.sdase.commons.client.jersey.filter.ContainerRequestContextHolder

G

get() - Method in interface org.sdase.commons.client.jersey.error.ClientErrorUtil.ResponseSupplier
getAccessToken() - Method in class org.sdase.commons.client.jersey.oidc.model.OidcResult
getAccessToken() - Method in class org.sdase.commons.client.jersey.oidc.rest.model.TokenResource
getAccessTokenExpiresInSeconds() - Method in class org.sdase.commons.client.jersey.oidc.rest.model.TokenResource
getBearerToken() - Method in class org.sdase.commons.client.jersey.oidc.model.OidcResult
getCache() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getClientFactory() - Method in class org.sdase.commons.client.jersey.JerseyClientBundle
getClientId() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getClientSecret() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getConfiguration() - Method in interface org.sdase.commons.client.jersey.oidc.rest.OpenIdDiscoveryApi
getGrantType() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getHeaderName() - Method in interface org.sdase.commons.client.jersey.filter.AddRequestHeaderFilter
getHeaderName() - Method in class org.sdase.commons.client.jersey.filter.AuthHeaderClientFilter
getHeaderValue() - Method in interface org.sdase.commons.client.jersey.filter.AddRequestHeaderFilter
getHeaderValue() - Method in class org.sdase.commons.client.jersey.filter.AuthHeaderClientFilter
getHttpClient() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getIssuerUrl() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getPassword() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getResponse() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException
getState() - Method in class org.sdase.commons.client.jersey.oidc.model.OidcResult
getTokenEndpoint() - Method in class org.sdase.commons.client.jersey.oidc.rest.model.OpenIdDiscoveryResource
getTokenResource() - Method in class org.sdase.commons.client.jersey.oidc.rest.IssuerClient: Retrieves a TokenResource from the configured OIDC provider.
getTokenType() - Method in class org.sdase.commons.client.jersey.oidc.rest.model.TokenResource
getUsername() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
getWebApplicationExceptionCause() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException

H

HttpClientConfiguration - Class in org.sdase.commons.client.jersey: A class that overrides some defaults
HttpClientConfiguration() - Constructor for class org.sdase.commons.client.jersey.HttpClientConfiguration

I

initialize(Bootstrap<?>) - Method in class org.sdase.commons.client.jersey.JerseyClientBundle
invoke(Object, Method, Object[]) - Method in class org.sdase.commons.client.jersey.proxy.ApiClientInvocationHandler
isClientError() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException
isClientIdValid() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
isClientSecretValid() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
isConnectTimeout() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException
isDisabled() - Method in class org.sdase.commons.client.jersey.oidc.cache.CacheConfiguration
isDisabled() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
isGrantTypeValid() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
isHttpClientValid() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
isPasswordValid() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
isProcessingError() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException
isReadTimeout() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException
isServerError() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException
IssuerClient - Class in org.sdase.commons.client.jersey.oidc.rest
IssuerClient(ClientFactory, OidcConfiguration) - Constructor for class org.sdase.commons.client.jersey.oidc.rest.IssuerClient
isTimeout() - Method in exception org.sdase.commons.client.jersey.error.ClientRequestException
isUseAuthHeader() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
isUsernameValid() - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration

J

JerseyClientBundle<C extends io.dropwizard.core.Configuration> - Class in org.sdase.commons.client.jersey: A bundle that provides Jersey clients with appropriate configuration for the SDA Platform.
JerseyClientBundle.Builder<C extends io.dropwizard.core.Configuration> - Class in org.sdase.commons.client.jersey
JerseyClientBundle.ConsumerTokenProvider<C extends io.dropwizard.core.Configuration> - Interface in org.sdase.commons.client.jersey: Provides the consumer token that is added to outgoing requests from the configuration.
JerseyClientBundle.FinalBuilder<C extends io.dropwizard.core.Configuration> - Interface in org.sdase.commons.client.jersey
JerseyClientBundle.InitialBuilder<C extends io.dropwizard.core.Configuration> - Interface in org.sdase.commons.client.jersey

O

OidcClient - Class in org.sdase.commons.client.jersey.oidc: Service that can retrieve a new access token.
OidcClient(ClientFactory, OidcConfiguration) - Constructor for class org.sdase.commons.client.jersey.oidc.OidcClient
OidcConfiguration - Class in org.sdase.commons.client.jersey.oidc: Supports two grant types:
OidcConfiguration() - Constructor for class org.sdase.commons.client.jersey.oidc.OidcConfiguration
OidcRequestFilter - Class in org.sdase.commons.client.jersey.oidc.filter
OidcRequestFilter(ClientFactory, OidcConfiguration, boolean) - Constructor for class org.sdase.commons.client.jersey.oidc.filter.OidcRequestFilter
OidcResult - Class in org.sdase.commons.client.jersey.oidc.model
OidcResult() - Constructor for class org.sdase.commons.client.jersey.oidc.model.OidcResult
OidcState - Enum Class in org.sdase.commons.client.jersey.oidc.model
OK - Enum constant in enum class org.sdase.commons.client.jersey.oidc.model.OidcState
OpenIdDiscoveryApi - Interface in org.sdase.commons.client.jersey.oidc.rest: A client that is able to fetch an OpenID Connect configuration according to OpenID spec 4.1
OpenIdDiscoveryResource - Class in org.sdase.commons.client.jersey.oidc.rest.model: A resource providing information according to OpenID spec 3.
OpenIdDiscoveryResource() - Constructor for class org.sdase.commons.client.jersey.oidc.rest.model.OpenIdDiscoveryResource
org.sdase.commons.client.jersey - package org.sdase.commons.client.jersey
org.sdase.commons.client.jersey.builder - package org.sdase.commons.client.jersey.builder
org.sdase.commons.client.jersey.error - package org.sdase.commons.client.jersey.error
org.sdase.commons.client.jersey.filter - package org.sdase.commons.client.jersey.filter
org.sdase.commons.client.jersey.oidc - package org.sdase.commons.client.jersey.oidc
org.sdase.commons.client.jersey.oidc.cache - package org.sdase.commons.client.jersey.oidc.cache
org.sdase.commons.client.jersey.oidc.filter - package org.sdase.commons.client.jersey.oidc.filter
org.sdase.commons.client.jersey.oidc.model - package org.sdase.commons.client.jersey.oidc.model
org.sdase.commons.client.jersey.oidc.rest - package org.sdase.commons.client.jersey.oidc.rest
org.sdase.commons.client.jersey.oidc.rest.model - package org.sdase.commons.client.jersey.oidc.rest.model
org.sdase.commons.client.jersey.proxy - package org.sdase.commons.client.jersey.proxy
org.sdase.commons.client.jersey.proxy.annotation - package org.sdase.commons.client.jersey.proxy.annotation

P

platformClient() - Method in class org.sdase.commons.client.jersey.ClientFactory: Starts creation of a client that calls APIs within the SDA SE Platform.
platformClient(HttpClientConfiguration) - Method in class org.sdase.commons.client.jersey.ClientFactory: Starts creation of a client that calls APIs within the SDA SE Platform.
PlatformClientBuilder - Class in org.sdase.commons.client.jersey.builder
PlatformClientBuilder(Environment, HttpClientConfiguration, OpenTelemetry, String) - Constructor for class org.sdase.commons.client.jersey.builder.PlatformClientBuilder

R

readErrorBody(Response) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Extracts the standard platform error object from the failed response.
readErrorBody(Response, TypeReference<E>) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Read json body of the given response as errorType.
readErrorBody(Response, GenericType<E>) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Read json body of the given response as errorType.
readErrorBody(Response, Class<E>) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Read json body of the given response as errorType.
readErrorBody(ClientRequestException) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Extracts the standard platform error object from the client exception.
readErrorBody(ClientRequestException, TypeReference<E>) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Read json body of the request encapsulated in the given ClientRequestException as errorType.
readErrorBody(ClientRequestException, GenericType<E>) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Read json body of the request encapsulated in the given ClientRequestException as errorType.
readErrorBody(ClientRequestException, Class<E>) - Static method in class org.sdase.commons.client.jersey.error.ClientErrorUtil: Read json body of the request encapsulated in the given ClientRequestException as errorType.
run(C, Environment) - Method in class org.sdase.commons.client.jersey.JerseyClientBundle

S

setAccessToken(String) - Method in class org.sdase.commons.client.jersey.oidc.model.OidcResult
setAccessToken(String) - Method in class org.sdase.commons.client.jersey.oidc.rest.model.TokenResource
setAccessTokenExpiresInSeconds(long) - Method in class org.sdase.commons.client.jersey.oidc.rest.model.TokenResource
setCache(CacheConfiguration) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setClientId(String) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setClientSecret(String) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setDisabled(boolean) - Method in class org.sdase.commons.client.jersey.oidc.cache.CacheConfiguration
setDisabled(boolean) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setGrantType(String) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setHttpClient(HttpClientConfiguration) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setIssuerUrl(String) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setPassword(String) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setState(OidcState) - Method in class org.sdase.commons.client.jersey.oidc.model.OidcResult
setTokenType(String) - Method in class org.sdase.commons.client.jersey.oidc.rest.model.TokenResource
setUseAuthHeader(boolean) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
setUsername(String) - Method in class org.sdase.commons.client.jersey.oidc.OidcConfiguration
SKIPPED - Enum constant in enum class org.sdase.commons.client.jersey.oidc.model.OidcState
SuppressConnectTimeoutErrorsToNull - Annotation Interface in org.sdase.commons.client.jersey.proxy.annotation: Annotation used to suppress ClientRequestException caused by connection timeout errors.
SuppressHttpErrorsToNull - Annotation Interface in org.sdase.commons.client.jersey.proxy.annotation: Annotation used to suppress ClientRequestException with a WebApplicationException cause in API clients.
SuppressProcessingErrorsToNull - Annotation Interface in org.sdase.commons.client.jersey.proxy.annotation: Annotation used to suppress ClientRequestException caused by processing errors.
SuppressReadTimeoutErrorsToNull - Annotation Interface in org.sdase.commons.client.jersey.proxy.annotation: Annotation used to suppress ClientRequestException caused by read timeout errors.

T

TokenResource - Class in org.sdase.commons.client.jersey.oidc.rest.model: An access token resource according to RFC 6749 section 5.1
TokenResource() - Constructor for class org.sdase.commons.client.jersey.oidc.rest.model.TokenResource
toResponse(ClientRequestException) - Method in class org.sdase.commons.client.jersey.error.ClientRequestExceptionMapper
TraceTokenClientFilter - Class in org.sdase.commons.client.jersey.filter: The TraceTokenClientFilter adds a trace token to client requests.
TraceTokenClientFilter() - Constructor for class org.sdase.commons.client.jersey.filter.TraceTokenClientFilter
transferRequestContext(Runnable) - Static method in class org.sdase.commons.client.jersey.filter.ContainerRequestContextHolder: Transfers the request context and MDC with the runnable to a new thread.
transferRequestContext(Callable<V>) - Static method in class org.sdase.commons.client.jersey.filter.ContainerRequestContextHolder: Transfers the request context and MDC with the callable to a new thread.

V

value() - Element in annotation interface org.sdase.commons.client.jersey.proxy.annotation.SuppressHttpErrorsToNull
valueOf(String) - Static method in enum class org.sdase.commons.client.jersey.oidc.model.OidcState: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.sdase.commons.client.jersey.oidc.model.OidcState: Returns an array containing the constants of this enum class, in the order they are declared.

W

withConsumerTokenProvider(JerseyClientBundle.ConsumerTokenProvider<C1>) - Method in class org.sdase.commons.client.jersey.JerseyClientBundle.Builder
withConsumerTokenProvider(JerseyClientBundle.ConsumerTokenProvider<C1>) - Method in interface org.sdase.commons.client.jersey.JerseyClientBundle.InitialBuilder
withOpenTelemetry(OpenTelemetry) - Method in class org.sdase.commons.client.jersey.JerseyClientBundle.Builder
withOpenTelemetry(OpenTelemetry) - Method in interface org.sdase.commons.client.jersey.JerseyClientBundle.FinalBuilder: Specifies a custom telemetry instance to use.

A B C D E F G H I J O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form