All Classes and Interfaces
Class
Description
A response object not attached to a client or server invocation.
Abstract implementation of
ValueInjector that can inject collections.A AbstractEntityProvider.
A AbstractJAXBProvider.
Created by rsearls
Helper base class for multipart/related producing providers.
Must be used in conjunction with GZIPDecodingInterceptor
Modifies Accept and Accept-Language headers by looking at path file suffix i.e. .xml means Accept application/xml
Enables content negotiation through a query parameter, instead of the Accept Header.
Returns a sorted list of values by their qualifier 'q' with parameters pulled off.
Use on any JAX-RS method if you want RESTEasy to inject the RESTServiceDiscovery
to every entity in the response.
Used to add an expiration attribute when signing or as a stale check for verification.
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
This will be removed in a future release as the underlying default implementation of the
ClientHttpEngine will be replaced.Deprecated, for removal: This API element is subject to removal in a future version.
This will be removed in a future release as the underlying default implementation of the
ClientHttpEngine will be replaced.
Per RFC5023:
The app:categories element can contain a "fixed" attribute, with a value of
either "yes" or "no", indicating whether the list of categories is a fixed or
an open set.
Per RFC5023:
Attributes common across all atom app types
This exception is thrown internally by Resteasy runtime.
Per RFC 5023:
Per RFC5023:
A CharSequence backed by a char[] (no copy on creation)
Interface for an async HttpClientEngine
Interface for extracting a result out of a ClientResponse
Used to turn a CompletionStage into another reactive class.
MessageBodyWriter which supports async IO.
OutputStream which supports async IO operations.
Utility class to write to an
AsyncOutputStream using a given Charset.A type that may be used as a resource method return value or as the entity
in a
Response when the application wishes to stream the output.Writer interceptors which support async IO.
Context for
AsyncWriterInterceptor which supports async IO.A processor for creating a value for the
HttpHeaders.AUTHORIZATION header.Deprecated.
This class is deprecated use jakarta.ws.rs.BadRequestException
Copied from keycloak.
A
Base64.InputStream will read data from another
java.io.InputStream, given in the constructor,
and encode/decode to/from Base64 notation on the fly.A
Base64.OutputStream will write data to another
java.io.OutputStream, given in the constructor,
and encode/decode to/from Base64 notation on the fly.Copied from keycloak
Helper for creating HttpRequest implementations.
If invoked within the context of a JAX-RS call, it will automatically build a
URI based the base URI of the JAX-RS application.
Client filter that will do basic authentication.
A simple filter which always adds a
Authorization header with a Basic
authorization value.An
AuthorizationProcessor which creates a HttpHeaders.AUTHORIZATION header for
BASIC authentication.BodyEntityExtractor extract body objects from responses.
A response object not attached to a client or server invocation.
Simple byte utilities.
This builder is not thread-safe.
Set response Cache-Control header automatically.
Per RFC4287:
A registry which is CDI aware and will create per-request resources from the CDI container.
This ConstructorInjector implementation uses CDI's BeanManager to obtain
a contextual instance of a bean.
A Jakarta REST
Feature that registers CDI integration providers.Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Configuration options for the RESTEasy CDI integration.
JAX-RS property injection is performed twice on CDI Beans.
A
ContainerResponseFilter that unwraps CDI proxies from response entities before serialization.Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Represents the
ClientBuilder configuration for configuring an
ClientHttpEngine.General client configuration exception
Interface to enable loading of authentication configuration from outside.
Client filter that will attach authorization header with either HTTP Basic auth or Bearer token auth.
Deprecated, for removal: This API element is subject to removal in a future version.
use the
org.jboss.resteasy.client.jaxrs.engine.ClientHttpEngineFactory insteadDeprecated, for removal: This API element is subject to removal in a future version.
This will be removed in a future release as the underlying default implementation of the
ClientHttpEngineBuilder will be replaced.A factory for creating HTTP engines for the Jakarta REST Client
implementation.
used to modify all of the ClientInvokers of a given ResteasyClientProxy.
Warning this class consists of generated code.
Implement a client proxy for ProxyFactory.
Used to annotate a predefined URL (as opposed to a @PathParam /@QueryParam)
in a Proxied client.
Attributes common across all atom types
Need to distinguish from a param or property that is actually a CompletionStage from
an async injection
A configuration property permission which, when the security manager is present, limits access to configuration
properties.
Create a deployment from String-based configuration data
A factory which returns the
Configuration.Configurations options for configuring an
SeBootstrap.Instance.For use when you want repository created via a context object, i.e., when defined within a WAR file.
Represents an atom:content element.
Meta annotation that specifies a Content-Encoding to be applied via the annotated annotation
Utility class to help generate, convert RFC compliant Content-ID and cid.
CDI producers for Jakarta RESTful Web Services types and RESTEasy specific types.
A utility to create and/or wrap executors in a contextual executor.
An executor which wraps runnables and callables to capture the context of the current
thread.
An executor which wraps runnables and callables to capture the context of the
current thread.
Handles CORS requests both preflight and simple CORS requests.
A utility class for parsing and formatting HTTP dates as used in cookies and
other headers.
Must be placed on a DecoratorProcessor class to specify the supported types
Meta-annotation to be placed on another annotation that triggers decoration
Finds DecoratorProcessors and calls decorates on them by introspecting annotations.
Part of a generic decorator framework.
Meta-annotation to be placed on another annotation that triggers decoration
A default configuration which searches for a property in the following order:
System properties
Environment variables
ResteasyConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.
Deflate (RFC 1951) utilities.
A simple delegating
ResteasyDeployment.MultivaluedMap implementation that delegates to another instance.Extract PrivateKey, PublicKey, and X509Certificate from a DER encoded byte array or file.
An
AuthorizationProcessor which creates a HttpHeaders.AUTHORIZATION header for
DIGEST authentication.Direct decrypter with a
shared symmetric key.
Direct encrypter with a
shared symmetric key.
One single signature within a DKIM-Signature header
Provider that reads and writes org.w3c.dom.Document.
Put this on a class or parameter when you do not want the JAXB MessageBodyReader/Writer
used but instead have a more specific provider you want to use to marshall the type.
Implement this interface to wrap, modify or extend RESTEasy's ELContext with
your own variable or method resolvers.
Deprecated.
An embedded server for serving Jakarta REST endpoints.
A utility for interacting with and locating embedded servers.
EntityExtractor extract objects from responses.
Create an EntityExtractor based on a method.
A stream used for entities.
Per RFC4287:
A ExceptionAdapter.
Adds support for the public directive which is not supported by
CacheControl for some reason.This exception should only be used by Resteasy integrators.
Per RFC4287:
Helper class to make a field accessible.
Deprecated.
finalizers should no longer be used and this type will be removed in the future
This can be used as a value object for incoming/outgoing request/responses.
Format XML output with indentations and newlines.
A simple utility for various functions.
A filter implementation filtering methods matching given methods.
Per RFC4287
A simple parser intended to parse sequences of name/value pairs.
A utility to define the filter to place on a REST client or on a request.
A
ClientResponseFilter which repeats the request if the response from the original request has a status of
Response.Status.UNAUTHORIZED.Deprecated, for removal: This API element is subject to removal in a future version.
A list of Http Header names.
Bridge interface between the base Resteasy JAX-RS implementation and the actual HTTP transport (i.e. a servlet container)
HttpRequestPreprocessors get invoked before any dispatching to JAX-RS resource methods happens
Bridge interface between the base Resteasy JAX-RS implementation and the actual HTTP transport (i.e. a servlet container)
Abstraction for an inbound http request on the server, or a response from a server to a client
Placed on a type, method, parameter, or field to tell JAXRS not to use JAXB provider for a certain
media type
A IIOImageProviderHelper.
An annotation that a resource class can use to pass parameters
to the
IIOImageProvider.Represents one part of a multipart message.
InternalDispatch represents a "forward" in servlet terms.
Thrown by RESTEasy when HTTP Internal Service Error (500) is encountered
JSONP is an alternative to normal AJAX requests.
Warning this class consists of generated code.
Configuration options for Jackson providers.
A wrapper class around a JAXBContext that enables additional features
to the RESTEasy JAXB-based providers.
A JAXB Provider which handles parameter and return types of
JAXBElement.A JAXBXmlRootElementProvider.
A JAXBXmlRootElementProvider.
A JAXB entity provider that handles classes without
XmlRootElement annotation.Deprecated, for removal: This API element is subject to removal in a future version.
this should not be used outside of this module and may be removed in a future release
Callback interface for when an interceptor registry changes
Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
Used for component jndi-based resources like enterprise beans.
Created by rsearls on 6/26/17.
Copied from keycloak
Any class that extends JsonWebToken will use NON_DEFAULT inclusion
Encrypt content.
The cryptographic parts of a JSON Web Encryption (JWE) object.
Any class that extends JsonWebToken will use NON_DEFAULT inclusion
Class provides utility functions for generation of V1
X509CertificateHow precisely a variant's language matched an entry in the
Accept-Language header.In-memory BrowserCache.
A simple map which limits the number of entries allowed.
Per RFC4287:
Use on your JAX-RS method, resource class or resource class' package to indicate that
you have a custom ELProvider for any links added to this response's entity.
Use this to mark JAX-RS methods that should be included in the REST service discovery.
Allows you have a list of
LinkResource on a single method.Can inject lists.
A version of ResteasyProviderFactory which does not reference its parent
after it is created.
This exception should only be used by Resteasy integrators.
A support utility for creating message loggers and message bundle types.
Warning this class consists of generated code.
Warning this class consists of generated code.
Warning this class consists of generated code.
Warning this class consists of generated code.
Deprecated, for removal: This API element is subject to removal in a future version.
This will be removed in a future release as the underlying default implementation of the
ClientHttpEngine will be replaced.Can inject maps.
This annotation can be added to any object to perform a Resource/method based
lookup to create a URI template.
Allows you to access the entity's raw bytes as well as the marshalled object.
A copy-on-write MediaType index of T.
Warning this class consists of generated code.
Warning this class consists of generated code.
Warning this class consists of generated code.
(RESTEASY-1485) Thwart select XSS attack by escaping special chars in
Exception message.
Will invoke a method in the context of an HTTP request.
Copy code from org.apache.james.mime4j.message.DefaultMessageBuilder.parseMessage().
A provider to handle multipart representations.
Creates a mock Dispatcher that you can invoke on locally
Acts as a bridge between asynchronous message and reply
Represents the entity parts of
multipart/form-data content.A
MessageBodyReader for reading multipart/form-data into a collection of
entity parts.A
MessageBodyWriter for write multipart/form-data as a list of
entity parts.This can be used as a value object for incoming/outgoing request/responses
of the multipart/form-data mime type.
Represents a multipart/related (RFC2387) incoming mime message.
Implements
MultipartRelatedInput by extending
MultipartInputImpl and adding multipart/related functionality.Represents a multipart/related (RFC2387) outgoing mime message.
The
MessageBodyReader implementation to deserialize
MultipartRelatedInput objects.The
MessageBodyWriter implementation to serialize
MultipartRelatedOutput objects.Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Set Cache-Control response header of "nocache"
WebApplicationExceptions are logged by RESTEasy.
A ClientHelper that does nothing, useful to save memory when creating a ResteasyProviderFactory for server side only
A ServerHelper that does nothing, useful to save memory when creating a ResteasyProviderFactory for client side only
This class encapsulates how an object can be converted to a URI string.
Configuration options to be looked up in the
Configuration.Defines a single URI template parameter binding.
Factory for
RequestParameterExtractor instances.A simple parser intended to parse sequences of name/value pairs.
Marks an entity's parent which will be used to resolve any parent ID used in path parameters.
Must be used in conjunction with @MultipartForm.
Must be used in conjunction with Multipart providers when writing out
a List or Map as a multipart/* type.
A utility class for handling URI template parameters.
Used when creating the matching path in ResteasyUriInfo
Utility classes to extract PublicKey, PrivateKey, and X509Certificate from openssl generated PEM files
Utility classes to extract PublicKey, PrivateKey, and X509Certificate from openssl generated PEM files.
Per RFC4287:
Pick
Allocates an instance of a class at each invocation
Utility class that provides a port number for the Resteasy embedded container.
Extension of
FormInjector that handles prefixes for associated classes.MultivaluedMap implementation that wraps another instance and only returns values that are
prefixed with the given PrefixedMultivaluedMap.prefixWithDot.Sorts components based on the
invalid input: '@Priority. The default is {@link Priorities#USER}.
@author <a href="mailto:jperkins@redhat.com">James R. Perkins</a>'
A service loader which loads classes aggressively sorting the implementations by the value in the
Priority
annotation.A utility class to provide supporting functionality to various
entity providers.
Created by Simon Ström on 7/11/14.
Created by Simon Ström on 7/17/14.
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Any exception thrown by a MessageBodyReader chain that is not an instance of a ReaderException is caught internally
by the Resteasy runtime and wrapped with an instance of ReaderException.
Deprecated.
<resource uriTemplate="/foo/bar{fff:.*}/x/a">
<get method="org.blah.MyResource.method()" invocations="5555">
<produces>application/xml</produces>
<produces>application/json</produces>
</get>
<post method="org.blah.MyResource.post()">
<produces>application/xml</produces>
</post>
</resource>
If invoked within the context of a JAX-RS call, it will automatically build a
URI based the base URI of the JAX-RS application.
If you return one of these from a resource method, RESTEasy-HTML will render it.
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Extracts a parameter value from an
HttpRequest.SPI which allows implementations to modify the resource metadata discovered by RESTEasy.
A utility used to register resources to be cleaned with a
Cleaner.Represents a facade for an entity which should still receive links for this entity even
though this entity's instance is not available.
Implementations of this interface are registered through the Registry class.
Marks this property as this resource's ID in URI templates.
Defines an ordered list of bean properties that defines this resource's ID in
URI templates.
Registry of resources and methods/classes that can dispatch HTTP method requests.
A scanner for locating resources.
This class represents the method level creation of a "rich response object"
that has the @ResponseObject annotation.
This class represents the proxying functionality for creating a
"rich response object" that has the @ResponseObject annotation.
Wraps a
BadRequestException with a sanitized response.A container for CDI-managed Jakarta REST components discovered during processing.
This is a ServletContextListener that creates the registry for resteasy and stuffs it as a servlet context attribute
Constant list of bootstrap classes.
A CDI
Extension that integrates Jakarta REST components with CDI.Abstraction for creating Clients.
Abstraction for creating Clients.
Wraps a
ClientErrorException with a sanitized response.implemented by every generated proxy
constant names of resteasy configuration variables within a servlet
This class is used to configure and initialize the core components of RESTEasy.
This class is used to configure and initialize the core components of RESTEasy.
An implementation of the
EntityPart.Builder.Wraps a
ForbiddenException with a sanitized response.Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Deprecated.
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Wraps a
InternalServerErrorException with a sanitized response.Only different from Jackson one is *+json in @Produces/@Consumes
Wraps a
NotAcceptableException with a sanitized response.Wraps a
NotAllowedException with a sanitized response.Wraps a
NotAuthorizedException with a sanitized responseWraps a
NotFoundException with a sanitized response.Wraps a
NotSupportedException with a sanitized response.A CDI
Extension that enables Jakarta REST parameter annotations (@CookieParam, @FormParam,
@HeaderParam, @MatrixParam, @PathParam, @QueryParam, and @BeanParam) to
function as CDI qualifiers.A ResteasyProviderFactoryDelegate.
Wraps a
RedirectionException with a sanitized response.An implementation of the
SeBootstrap.Configuration.An implementation of a
SeBootstrap.Instance.Wraps a
ServerErrorException with a sanitized response.Wraps a
ServiceUnavailableException with a sanitized response.UriInfo implementation with some added extra methods to help process requests.
Holds the data that is needed to initialize ResteasyUriInfo
The reason to extract this data into a separate class is that it's expensive
to produce and can be cached under certain circumstances
Wraps a
WebApplicationException with a sanitized response.
This holds a list of atom links describing the REST service discovered.
An Atom link
RSA decrypter.
RSA encrypter
Reactive Context propagator for RxJava 2.
Simple plugin to provide authentication/authorization to embedded implementations
Extension of
BufferedInputStream enforcing the contract where reset()
always returns to the beginning of the stream, and the internal buffer
expands automatically to the total length of content read from the underlying
stream.Determines a separator for String representations of multivalued parameters.
Server-side cookie representation.
Variant selection.Helper/delegate class to unify Servlet and Filter dispatcher implementations
Convenience annotation that triggers the signing of a request or response using the DOSETA specification.
POJO Security domain.
VERY simple implementation that just returns the instance the SingleResource was created with
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Represents units of size for things such as memory or files.
Acts as a HashMap until lockSnapshots is called.
Deprecated, for removal: This API element is subject to removal in a future version.
use the new dependencies
Allow us to sort message body implementations that are more specific for their types
i.e.
Per RFC4287:
Use to indicate MediaType of elements in SSE streams.
Use on async streams to push them to the client as they become available
over the OutputStream, rather than collected into collections.
Utility to replace predefined expressions within a string with values from the HTTP request;
Similar to StringConverter except specific to a parameter injection only.
Meta-annotation to be placed on another annotation that triggers a StringParameterUnmarshaller to be applied
to a string based annotation injector i.e.
Specifies an XML stylesheet header
Suspendable request context, which allows the users to suspend execution of the filter
chain until it is resumed normally, or abnormally with a
Throwable.Suspendable response context, which allows the users to suspend execution of the filter
chain until it is resumed normally, or abnormally with a
Throwable.Test utility class
Represents an atomTextConstruct element.
Represents a collection of
ThreadContext's.Allow applications to push/pop provider factories onto the stack.
Comment
Represents a threshold for a unit size.
A utility class that can convert a String value as a typed object.
Type conversions and generic type manipulations
Thrown by RESTEasy when HTTP Unauthorized (401) is encountered
This interface is discovered as a service provider for
configuring the
Undertow.Builder before it builds the server and starts it.An
EmbeddedServer that uses Undertow and enables CDI support.Wrapper around Undertow to make resteasy deployments easier
Each ResteasyDeployment or jaxrs Application is deployed under its own web deployment (WAR)
You may also deploy after the server has started.
This exception should only be used by Resteasy integrators.
Unmodifiable implementation of
MultivaluedMap interfaceThis is an interface which allows an object to perform its own uri creation
URIResolver Adapter for URIable classes
allows a user to specify the url.
This is the interface that defines all object to uri transformations in
ObjectToURI
This annotation can be added to any object to perform Java beans-based
transformation between URI template and bean properties.
Deprecated, for removal: This API element is subject to removal in a future version.
Represents the credentials a user and password for authentication purposes.
Utility methods for detecting CDI scopes and JAX-RS components.
A individual variant quality bean for the RVSA (Remote Variant Selection Algorithm).
Verification of input signature specified in a signature header.
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
Deprecated, for removal: This API element is subject to removal in a future version.
use new dependencies
An interface which allows a
WebApplicationException to be unwrapped.Put this on a method or parameter when you want to marshal or unmarshal a collection or array of JAXB objects
Put this on a method or parameter when you want to marshal or unmarshal a map of JAXB objects
Any exception thrown by a MessageBodyWriter chain that is not an instance of a WriterException is caught internally
by the Resteasy runtime and wrapped with an instance of WriterException.
Deprecated.
Sets an XML header for the returned document.
Deprecated.
This should no longer be used as it's quite simple to implement and is tied to the implementation
This annotation can be used to process/produce incoming/outgoing XOP messages
(packaged as multipart/related) to/from JAXB annotated objects.
A special JAXB Provider.
This provider is for reading xop packages packed as multipart/related.
This provider is for writing xop packages packed as multipart/related.
ClientHttpEnginewill be replaced.