All Classes and Interfaces
Class
Description
Configure the acknowledgement policy for the given
@Incoming
.The APIResponse annotation corresponds to the OpenAPI Response model object which describes a single response from an
API Operation, including design-time, static links to operations based on the response.
This interface represents a single response from an API Operation, including design-time, static links to operations
based on the response.
The ApiResponses annotation is a container for @ApiResponse annotations.
This interface represents the container for the expected responses of an operation.
The APIResponseSchema annotation corresponds to an individual schema in the OpenAPI Response model object which
describes a single response from an API Operation.
Wrap the execution and invoke it asynchronously.
Implementations of this interface can intercept asynchronous method invocations.
This is a provider interface intended for intercepting asynchronous method invocations.
Define bulkhead policy to limit the number of the concurrent calls to an instance.
The exception should be thrown when Bulkhead implementation throws an exception, e.g.
This object represents a callback URL that will be invoked.
Callback
Describes a single API callback operation.
This object represents an array of Callback URLs that can be invoked.
This qualifier indicates which channel should be injected / populated.
Defines a circuit breaker policy to an individual method or a class.
The exception should be thrown when circuit breaker is open.
Annotation used to signify an injection point for a
ClaimValue
from a JsonWebToken
Annotation literal for
Claim
This enum represents the standardized claims that the MP-JWT specification allows for in terms of interoperability.
A representation of a claim in a
JsonWebToken
Used to specify an HTTP parameter that should be sent with the outbound request.
Used to specify HTTP parameters that should be sent with the outbound request.
This interface is intended for generating or propagating HTTP headers.
A builder for a closed reactive streams graph.
A subscriber that redeems a completion stage when it completes.
Describes the Components object that holds various reusable objects for different aspects of the OpenAPI
Specification (OAS).
Components
Resolves the property value by searching through all configured
ConfigSources
.A builder for manually creating a configuration instance.
Holding all available config keys
Retrieve a number of related configuration properties with the specified prefix into a property class.
Support inline instantiation of the
ConfigProperties
qualifier.Binds the injection point with a configured value.
This is the central class to access a
Config
.The service provider for implementations of the MicroProfile Configuration specification.
A configuration source which provides configuration values from a specific place.
A provider for configuration source instances.
The ConfigValue holds additional information after the lookup of a configuration property and is itself immutable.
Operators for connecting different graphs together.
Qualifier used on connector implementations to indicate the associated underlying transport.
Connector implementor can use this annotation to document attributes supported by their connector.
Attribute direction.
This class is used to allow multiple
ConnectorAttribute
declarations.Parent class for
IncomingConnectorFactory
and OutgoingConnectorFactory
.Supports inline instantiation of the
Connector
qualifier.Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
Operators for completing a stream.
Contact information for the exposed API.
This interface represents the Contact information for the exposed API.
This object provides schema and examples for a particular media type.
Content
ContextManager
instances can be used to create ContextManager.newManagedExecutorBuilder()
or ContextManager.newThreadContextBuilder()
.Use this class to configure instances of
ContextManager
.ContextManagerExtension
instances receive
notification upon creation of each ContextManager
.A provider implementation supplied by the
container, which creates and caches instances of
ContextManager
per class loader,
which in turn create new instances of
ManagedExecutor.Builder
and
ThreadContext.Builder
.This class gives the container that registered a
ContextManagerProvider
exclusive control over unregistering it.A mechanism for converting configured values from
String
to any Java type.Annotation provides way how to set custom date format to field or JavaBean property.
This class propagates Jakarta RESTful Web Services headers whose names are specified using the MicroProfile Config
property,
org.eclipse.microprofile.rest.client.propagateHeaders
.Controls the mapping of a method's parameter to an argument of a GraphQL operation (query/mutation/subscription).
A property name and an associated list of other property names.
A property name and an associated schema.
Sets the description in the GraphQL schema for the target field, type, parameter, etc.
Discriminator
This object maps payload values to a particular Schema.
Interface used to feed a channel from an imperative piece of code.
Single encoding definition to be applied to single Schema Object
Encoding
Maps of the annotated Java enum to a GraphQL enum.
Operators for handling errors in streams.
Example
This object illustrates an example of a particular content
The execution context for the method being executed.
Enumeration used to define the value of Explode property.
The base interface for OpenAPI model objects that can contain extensions.
A named extension that should be added to the OpenAPI definition.
This object represents an array of extensions that can be added to the element.
This annotation allows referencing an external resource for extended documentation.
ExternalDocumentation
The fallback annotation to define the fallback handler class so that a failure can be handled properly.
Create a default class so the value is not required to be set all the time.
The handler instance used by the container to service a fallback invocation is a non-contextual instance created
using the CDI SPI.
The exception should be thrown when the definition of any Fault Tolerance annotations is invalid.
The exception should be thrown when the maximum retries is reached or overall retry duration is reached, circuit
breaker is open, timeout occurred.
Operations for transforming a stream.
A graph.
Marks a class as a GraphQL Endpoint.
A GraphQLException is used to pass error information back to the client.
Describes a single header object
Header
Controls the style of serialization.
The health check procedure interface.
The response to a health check invocation.
A builder to construct a health check procedure response.
Reserved for implementors as means to supply their own HealthCheckResponseBuilder.
Marks a field as a ID Scalar Type.
Excludes an otherwise mapped element.
Used to signify a subscriber to incoming messages.
SPI used to implement a connector managing a source of messages for a specific transport.
This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
This interface represents all the metadata about the API.
Maps the annotated class to a GraphQL input type.
A read-only interface for the the claims required by Eclipse MicroProfile conforming tokens.
License information for the exposed API.
This interface represents the License information for the exposed API.
The Link object represents a possible design-time link for a response.
Link
Represents a parameter to pass to an operation as specified with operationId or identified via operationRef.
This qualifier is used to define a liveness Health Check procedure
Support inline instantiation of the
Liveness
qualifier.A security annotation describing the authentication method and the associated realm name that should be used for this
application.
A container-managed executor service that creates instances of CompletableFuture,
which it backs as the default asynchronous execution facility, both for the
CompletableFuture itself as well as all dependent stages created from it,
as well as all dependent stages created from those, and so on.
Builder for
ManagedExecutor
instances.MediaType
A message envelope.
Specifies that the annotated method provides the implementation (ie.
Allows users to name a field or argument in the GraphQL Schema
For example, a user might annotate a method's parameter as such:
For example, a user might annotate a method's parameter as such:
Constants for the names of the MP-config properties that MP-JWT implementations must support externalization of to
ensure portable setup of MP-JWT implementations.
Specifies that the GraphQL type and/or input type represented by the Java field this annotation is applied to must be
marked as non-null in the schema.
Annotation provides way how to set custom number format to field or JavaBean property.
Configurable properties in MicroProfile OpenAPI
This class allows application developers to build new OpenAPI model elements.
This class is not intended to be used by end-users.
This interface allows application developers to filter different parts of the OpenAPI model tree.
This interface allows application developers to programmatically contribute an OpenAPI model tree.
Configuration details for a supported OAuth Flow.
Configuration details for a supportde OAuthFlow
Allows configuration of the supported OAuth Flows.
Configuration of the supported OAuthFlows
Represents an OAuth scope.
Configures the back pressure policy on an injected
Emitter
:The back pressure strategy.
OpenAPI
OpenAPI
Describes a single API operation on a path.
Operation
Used to signify a publisher of outgoing messages.
SPI used to implement a connector managing a sink of messages for a specific transport.
Describes a single operation parameter
Parameter
The values allowed for the in field.
The values allowed for the style field.
This object encapsulates input parameters
Describes a set of operations available on a single path.
PathItem
All of the possible types of HTTP operations for this path
Describes an Operation
Paths
A regular expression and an associated schema.
Operations for peeking at elements and signals in the stream, without impacting the stream itself.
A builder for a
Processor
.A stream that completes with a single result.
A builder for a
Publisher
.Specifies that the annotated method provides the implementation (ie.
A QueryParamStyle enum is used to specify how multiple values are handled when constructing the query portion of the
URI.
Primary entry point into the Reactive Streams utility API.
An engine for turning reactive streams graphs into Reactive Streams publishers/subscribers.
Factory interface for providing the implementation of the static factory methods in
ReactiveStreams
.This class is not intended to be used by end-users but for portable container integration purpose only.
This qualifier is used to define a readiness Health Check procedure
Support inline instantiation of the
Readiness
qualifier.Base interface for OpenAPI model objects that can make reference to other objects.
Used to specify that a
ClientHeadersFactory
should be used to generate or propagate HTTP headers on the
outbound request.When annotation is placed at the interface level of a REST API definition, the providers listed will be registered
upon proxying.
When annotation is placed at the interface level of a REST API definition, the providers listed will be registered
upon proxying.
A marker annotation to register a rest client at runtime.
Describes a single request body.
This interface represents the request body of an operation in which body parameters can be specified.
Provides a reference to a class that (after introspection) describes the schema for a single request body.
Converts an Jakarta RESTful Web Services Response object into an Exception.
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.
This is the main entry point for creating a Type Safe Rest Client.
Implementations of this interface will be notified when new RestClientBuilder instances are being constructed.
Resolver for a
RestClientBuilder
implementation.This exception is thrown when the MicroProfile Rest Client implementation attempts to build a client using an invalid
interface.
Implementations of this interface will be notified when new Rest Client instances are being constructed.
The retry annotation to define the number of retries.
The Schema Object allows the definition of input and output data types.
The Schema Object allows the definition of input and output data types.
Marker class to indicate that a boolean
false
schema should be used.The values allowed for the
type
field.Marker class to indicate that a boolean
true
schema should be used.The SchemaProperty Object allows the definition of input and output data types nested within the
properties
attribute of a Schema
annotation.Specifies a security requirement for an operation.
SecurityRequirement
Container annotation for repeated
SecurityRequirement
annotations.This annotation represents a set of security requirements which permit access to an operation if all of them are
satisfied.
Represents an array of security requirement sets that apply to an operation.
Defines a security scheme that can be used by the operations.
SecurityScheme
In is a REQUIRED property that specifies the location of the API key.
Type is a REQUIRED property that specifies the type of SecurityScheme instance.
This object represents an array of SecurityScheme annotations that can be specified at the definition level.
This annotation represents a Server used in an operation or used by all operations in an OpenAPI document.
An object representing a server.
The Servers annotation is a container for @Server annotations.
An object representing a Server Variable for server URL template substitution.
An object representing a Server Variable for server URL template substitution.
Extends a GraphQL type by adding an externally defined field, effectively enabling a graph to be assembled.
A stage of a Reactive Streams graph.
A cancelling stage.
A collect stage.
Concatenate the given graphs together.
A stage that couples a wrapped subscriber graph to a wrapped publisher graph.
A stage returning a stream consisting of the distinct elements (according to
Object.equals(Object)
) of
this stream.A drop while stage.
A failed publisher.
A filter stage.
A subscriber stage that emits the first element encountered.
A flat map stage.
A flat map stage that emits and flattens
CompletionStage
.A flat map stage that emits and fattens
Iterable
.A publisher representation of a
CompletionStage
.A publisher representation of a
CompletionStage
.A limit stage.
A map stage.
A publisher of zero to many values.
A stage returning a stream containing all the elements from this stream, additionally performing the provided
action when this stream completes.
A stage returning a stream containing all the elements from this stream, additionally performing the provided
action if this stream conveys an error.
A stage to handle errors from upstream.
A stage to handle errors from upstream.
A stage returning a stream containing all the elements from this stream, additionally performing the provided
action if this stream terminates with an error, completes, or is cancelled by downstream.
A stage returning a stream containing all the elements from this stream, additionally performing the provided
action on each element.
A processor stage.
A publisher stage.
A skip stage.
A subscriber.
A take while stage.
This qualifier is used to define a Startup Health Check procedure mapped to the Startup Kubernetes probes.
Support inline instantiation of the
Startup
qualifier.A builder for a
Subscriber
and its result.A subscriber and completion stage pair.
This object represents a tag.
Tag
The Tags annotation is a container for @Tag annotations.
This interface offers various methods for capturing the context of the current thread
and applying it to various interfaces that are commonly used with completion stages
and executor services.
Builder for
ThreadContext
instances.Represents context that is applied to a particular thread, along with any
state that is associated with it or that is necessary for restoring the
previous context afterward.
Third party providers of thread context implement this interface to enable the
provided type of context to participate in thread context capture and propagation
when the
ManagedExecutor
and ThreadContext
are used to create and contextualize dependent
actions and tasks.An immutable snapshot of a particular type of thread context.
The annotation to define a method execution timeout.
The exception should be thrown when timeout is reached.
All instances of
PublisherBuilder
, ProcessorBuilder
, SubscriberBuilder
and
CompletionRunner
must implement this, to ensure that the builder can be turned into a graph by other
implementations of the API.Operations for transforming a stream.
Maps of the annotated Java class to a GraphQL type.
Exception thrown when a reactive streams engine doesn't support a stage that is passed to it.
A metadata object that allows for more fine-tuned XML model definitions.