Build Items
Here you can find a list of Build Items and the extension that provides them.
Build item can’t be instantiated directly, but can be extended/inherited from
Core
Class Name |
Attributes |
---|---|
An additional application archive. This build item can only be consumed, it should not be produced by build steps. Show more |
No Javadoc found |
A marker file that if present indicates that a given archive should be treated as an application archive. Show more |
No Javadoc found |
No Javadoc found |
|
Allows extensions to add classes to the index available via Show more |
No Javadoc found |
Build item that will allow the use of JNDI by default. This should only be provided by extensions that rely on JNDI as a core part of the extension (e.g. if LDAP is a core part of what the extension does). Show more |
None |
Create annotation proxies that can be used as Show more |
No Javadoc found |
Indicates that a specific container image should be used to generate the AppCDS file Show more |
No Javadoc found |
If this build item is generated, then it means that there is a recorder step that can be used as a point at which the application loading during AppCDS generation can be stopped safely, therefore allowing Quarkus to not have to stop loading the application in the static init phase which is the default approach for AppCDS generation. Show more |
None |
Build item to indicate to the various steps that AppCDS generation has been requested Show more |
Directory where various files needed for AppCDS generation will reside |
A build item containing the result of the AppCDS generation process Show more |
The file containing the generated AppCDS |
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
Makes it possible to identify wiring classes generated for classes from additional hot deployment paths. Show more |
No Javadoc found |
The Jandex index of the application root. Show more |
No Javadoc found |
No Javadoc found
No Javadoc found |
|
A symbolic class that is produced after the startup event has been fired. At this point it should be safe to open sockets and begin processing requests. Show more |
None |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Represents a runnable artifact, such as an uberjar or thin jar. Most artifacts will also produce a more specialized build item, to allow them to be consumed by other build steps. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
The build systems target directory. This is used to produce Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
The definition of a constant that can be injected into recorders via their Show more |
No Javadoc found |
No Javadoc found |
|
Transform a class using ASM Show more |
No Javadoc found
No Javadoc found
Function that can be applied to the input bytes before it is passed into ASM. This should only be used in very specific circumstances. At the moment the only known valid use case is JaCoCo, which needs access to the unmodified class file bytes.
A set of class names that need to be present in the const pool for the transformation to happen. These need to be in JVM internal format. The transformation is only applied if at least one of the entries in the const pool is present. Note that this is an optimisation, and if another transformer is transforming the class anyway then this transformer will always be applied.
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Represents a technical capability that can be queried by other extensions.
Build steps can inject Show more |
No Javadoc found
No Javadoc found |
Represents the differences between classes in a dev mode restart. This can be used to avoid repeating work on restart, e.g. re-using old proxy definitions if nothing has changed for a given class. This will not always be present, it must be injected as an optional dependency. This will never be generated if the previous restart was a failure to avoid issues with inconsistent application state. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
An index of application classes which is built from archives and dependencies that contain a certain marker file. These files include but are not limited to - beans.xml, jandex.idx and config properties. Additional marker files can be declared via Show more |
No Javadoc found
No Javadoc found |
No Javadoc found |
|
No Javadoc found
All the config interfaces registered for this config mapping (including the nested ones)
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
A build item that is not part of the standard build, but is only used to generate example config files and docs. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
The build item which carries the build time configuration. Show more |
No Javadoc found |
The configuration type build item. Every configuration type should be registered using this build item to ensure that the converter is properly loaded in the native image case. Show more |
No Javadoc found |
No Javadoc found |
|
No Javadoc found |
|
Build item that signifies that the interactive console is ready. This will not always be present, as the console may not be installed Show more |
None |
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
|
Build Item that can be used to queue shutdown tasks that are run when the Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
Way for maven and gradle plugins to discover if any declared extensions support quarkus deploy Show more |
No Javadoc found |
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
An additional configuration property to set when a dev service sets another, specific configuration property. Quarkus will make sure the relevant settings are present in both JVM and native modes. This is used to change the defaults of extension configuration when dev services are in use, for example to enable schema management in the Hibernate ORM extension. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Build item that contains the final results of all configuration. Show more |
No Javadoc found |
BuildItem for running dev services. Combines injected configs to the application with container id (if it exists). Processors are expected to return this build item not only when the dev service first starts, but also if a running dev service already exists. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
A marker build item that indicates, if any instances are provided during the build, the containers started by DevServices may use a shared network. This is mainly useful in integration tests where the application container needs to be able to communicate with the service containers. Show more |
No Javadoc found |
Allows disabling of instrumentation based reload if the changed class matches certain criteria Show more |
No Javadoc found |
Allows disabling of instrumentation based reload if the index of changed classes matches certain criteria Show more |
No Javadoc found |
None |
|
Contains the IDE to be opened when a request to open a class is made Show more |
No Javadoc found |
Allows for a handler to be registered when exceptions are logged. This is intended for use in dev/test mode to allow Quarkus to help the developer handle the issue. Show more |
No Javadoc found |
A build item that allows extension to configure the native-image compiler to effectively ignore certain configuration files in specific jars. The Show more |
No Javadoc found
No Javadoc found |
Build item that defines dependencies that should not be indexed. This can be used when a dependency contains a marker file (e.g. META-INF/beans.xml). Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Carries a predicate that identifies methods that can have annotations which affect the execution model ( Show more |
No Javadoc found |
No Javadoc found |
|
No Javadoc found |
|
Represents functionality provided by an extension. The name of the feature gets displayed in the log during application bootstrap.
An extension should provide at most one feature. The name must be unique. If multiple extensions register a feature of the same name the build fails.
The name of the feature should only contain lowercase characters, words are separated by dash Show more |
No Javadoc found |
Forces classes that have been registered for reflection using weak semantics, to revert to normal reflection registration semantics. Essentially if this build item is used for a class that has been registered with Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Used when resources generated by the build should not end up in the produced runnable artifact, but in the file system inside the output directory of OutputTargetBuildItem. This is written to the file system for normal and dev mode, but not for test mode. Show more |
No Javadoc found
No Javadoc found |
Marker used only to ensure that the file system resources where properly written in dev mode. Show more |
None |
A generated class that is only applicable to native images. Show more |
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
This option is only meant to be set by extensions that also generated the resource on the file system and must rely on Quarkus not getting in the way of loading that resource. It is currently used by Kogito to get serving of static resources in Dev Mode by Vert.x @deprecated If you want to serve static resources use |
|
Identifies a file from a
If multiple build items match the same file then the final value of Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
A build item that provides the ability to detect if the current thread is an IO thread Show more |
No Javadoc found |
Build item that defines dependencies that should be indexed. This can be used when a dependency does not contain a marker file (e.g. META-INF/beans.xml). Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Represents an initialization task for the application. Often extensions perform some sort of initialization as part of the application startup. There are cases where we want to externalize the initialization (e.g. in a pipeline). Often the task is run using the same artifact as the application but using a different command or arguments. In the later case it might be desirable to pass additional environment variables to both the init tasks (to enable init) and the application (to disable the init). Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
A symbolic class that represents that an initialization task has been completed. Similar to Show more |
No Javadoc found |
If present, will force the addition of the Show more |
None |
A build item that indicates that a Java package should be exported using '-J—add-exports' option to become visible to native-image Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
|
Used to register a class for JNI runtime access. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
JNI access registration fine-grained to single fields for a given class. Show more |
No Javadoc found
No Javadoc found |
JNI access registration fine-grained to single methods for a given class. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Used to register a lambda capturing type in native mode Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
A build item that can be used to query the live reload state. It can also be used to store context information that is persistent between hot reloads. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Establish the default log level of a log category. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found |
|
Declare that a log filter should be applied to the specified Show more |
No Javadoc found |
The log console format build item. Producing this item will cause the logging subsystem to disregard its console logging formatting configuration and use the formatter provided instead. If multiple formatters are enabled at run time, a warning message is printed and only one is used. Show more |
No Javadoc found |
The log file format build item. Producing this item will cause the logging subsystem to disregard its file logging formatting configuration and use the formatter provided instead. If multiple formatters are enabled at runtime, a warning message is printed and only one is used. Show more |
No Javadoc found |
A build item for adding additional logging handlers. Show more |
No Javadoc found |
None |
|
The syslog format build item. Producing this item will cause the logging subsystem to disregard its syslog logging formatting configuration and use the formatter provided instead. If multiple formatters are enabled at runtime, a warning message is printed and only one is used. Show more |
No Javadoc found |
Contains information to decorate the Log output. Can be used by extensions that output the log / stacktraces, for example the error page. Also see io.quarkus.runtime.logging.DecorateStackUtil to assist with the decoration Show more |
No Javadoc found
No Javadoc found |
None |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
A metrics provider will iterate over all MetricsFactory consumers, allowing them to register metrics via bytecode recording Show more |
No Javadoc found
No Javadoc found |
A build item for adding additional named logging handlers. Show more |
No Javadoc found |
Native configuration generated by native image agent can be integrated directly into subsequence native build steps, if the user enables Show more |
No Javadoc found |
Do not use directly: use Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
None |
|
Represents a GraalVM Show more |
No Javadoc found |
A build item that represents a Show more |
No Javadoc found |
A build item that indicates that a static resource should be included in the native image.
A static resource is a file that is not processed by the build steps, but is included in the native image as-is. The resource path passed to the constructor is a
Show more |
No Javadoc found |
Indicates that a resource bundle should be included in the native image Show more |
No Javadoc found
No Javadoc found |
A build item that indicates that directory resources should be included in the native image Related build items:
Show more |
No Javadoc found |
A build item that indicates that a set of resource paths defined by regular expression patterns or globs should be included in the native image.
Globs passed to the
Show more |
No Javadoc found
No Javadoc found |
The resolved factory for the native image runner.
Warning: This build item should not be consumed without the use of Show more |
No Javadoc found |
A build item that indicates that a security provider should be included in the native image using '-H:AdditionalSecurityProviders' option Show more |
No Javadoc found |
A jar that is build to run the native image Show more |
No Javadoc found
No Javadoc found |
A system property that will be set at native image build time Show more |
No Javadoc found
No Javadoc found |
A build item that indicates the minimal acceptable JDK version the native-image tool was bundled with. Show more |
No Javadoc found
No Javadoc found |
Used to capture object substitution information for non-serializable classes. Show more |
No Javadoc found |
The location that output artifacts should be created in. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
None |
|
Class to be preloaded in static initialization phase of Quarkus. Show more |
No Javadoc found |
Extension build steps can produce this if preloading classes is enabled. Show more |
No Javadoc found |
A build item, which indicates that the Show more |
None |
No Javadoc found |
|
No Javadoc found |
|
A build item that represents the raw command line arguments as they were passed to the application. This can be passed directly to bytecode recorders that take a Show more |
None |
Indicates that the given class should be instantiated with the constructor with the most parameters when the object is bytecode recorded. An alternative to Show more |
No Javadoc found |
Used to register a class for reflection in native mode Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Used to define a condition to register a class for reflection in native mode only when a specific type is reachable Show more |
No Javadoc found
No Javadoc found |
Used by Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found |
|
Attempts to register a complete type hierarchy for reflection. This is intended to be used to register types that are going to be serialized, e.g. by Jackson or some other JSON mapper. This will do 'smart discovery' and in addition to registering the type itself it will also attempt to register the following: - Superclasses - Component types of collections - Types used in bean properties (if method reflection is enabled) - Field types (if field reflection is enabled) This discovery is applied recursively, so any additional types that are registered will also have their dependencies discovered Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Used by Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Represents resources to be removed from a dependency when packaging the application. Show more |
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
Provides a way to register a Show more |
No Javadoc found |
A build item which specifies a configuration default value for run time, which is used to establish a default other than the one given for Show more |
No Javadoc found
No Javadoc found |
A build item that carries all the "fake" run time config objects for use by recorders. Show more |
No Javadoc found |
Build Item that can be used to queue shutdown tasks that are run when the runtime application shuts down. This is similar to Show more |
No Javadoc found |
Marker used by Build Steps that consume runtime configuration to ensure that they run after the runtime config has been set up. Show more |
None |
A class that will be initialized at runtime in native mode. Show more |
No Javadoc found |
A package that will be initialized at runtime in native mode. WARNING: this build item should not be used in Quarkus itself and is only provided to simplify the early stages of external extensions development. For Quarkus development, please take the time to surgically mark individual classes as runtime initialized. Show more |
No Javadoc found |
A class that will be reinitialized at runtime in native mode. This will result in the static initializer running twice. Show more |
No Javadoc found |
Aggregates SBOMs generated for packaged applications. The API around this is still in development and will likely change in the near future. Show more |
No Javadoc found |
Represents a Service Provider registration. When processed, it embeds the service interface descriptor (META-INF/services/…) in the native image and registers the classes returned by Show more |
No Javadoc found
No Javadoc found |
A symbolic class that represents a service start.
Show more |
No Javadoc found |
A build item that can be used to register shutdown tasks in runtime recorders. Show more |
None |
No Javadoc found |
|
Allows extensions to set a default value for enabling SnapStart. Show more |
No Javadoc found |
Marker item to specify that SnapStart is enabled. Show more |
None |
No Javadoc found |
|
No Javadoc found |
|
Provides a way to register a Show more |
No Javadoc found |
A build item for adding the dev stream log via mutiny. Show more |
No Javadoc found |
Allows extensions to suppress the runtime warning that Quarkus emits on startup when a non-runtime configuration option is different at runtime than build time. An example usage of this is when a user provides some test value in Show more |
No Javadoc found |
Represents a system property that will be set immediately on application startup. Show more |
No Javadoc found
No Javadoc found |
This is an optional build item that allows us to track annotations that will define test classes. It is only available during tests. Show more |
No Javadoc found |
This is an optional build item that allows us to track additional test classes that will become beans. It is only available during tests. Show more |
No Javadoc found |
This is an optional build item that allows extensions to distinguish test classes from application classes. It is only available during tests. Show more |
No Javadoc found |
No Javadoc found |
|
This is an optional build item that represents the current test profile. It is only available during tests. Show more |
No Javadoc found |
Virtual build item that is used to signify that a step must be run to set up continuous testing Show more |
None |
No Javadoc found |
|
The results of applying bytecode transformation to a class. Note that this has also been abused somewhat to also represent removed resources, as the logic is the same, and it avoids having two separate mechanisms that essentially do the same thing. Show more |
No Javadoc found
No Javadoc found |
Ignore resources when building an Uber Jar Show more |
No Javadoc found |
Merge duplicate resources from multiple JARs when building an Uber Jar Show more |
No Javadoc found |
No Javadoc found
No Javadoc found |
|
Native-image might not be supported for a particular extension on a given OS or architecture. Show more |
No Javadoc found
No Javadoc found |
A marker build item that is used to indicate that UPX compression was performed Show more |
None |
Agroal - SPI
Class Name |
Attributes |
---|---|
A build item for JDBC datasources. If you inject this build item when recording runtime init template calls, you are guaranteed the datasources configuration has been injected and datasources can be created. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
A build item which can be used to order build processors which need a datasource’s schema to be ready (which really means that the tables have been created and any migration run on them) for processing. Show more |
No Javadoc found |
Register a JDBC driver for the Agroal extension. It allows to resolve automatically the driver from the kind, thus users don’t have to set the driver anymore, except if they want to use a specific one. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found |
|
Marker build item that indicates that the OpenTelemetry extension has been initialized. Show more |
None |
Amazon Lambda
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found |
Amazon Lambda - Common Deployment
Class Name |
Attributes |
---|---|
No Javadoc found |
|
No Javadoc found Show more |
None |
Handler provided by another extension i.e. AWS Lambda HTTP Show more |
No Javadoc found
No Javadoc found |
ArC
Class Name |
Attributes |
---|---|
This build item is used to specify one or more additional bean classes to be analyzed during bean discovery.
By default, the resulting beans may be removed if they are considered unused and Generated ClassesThis build item should never be produced for a generated class - Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Make it possible to add, remove or alter annotations on various components. The provided transformer uses Show more |
No Javadoc found |
No Javadoc found |
|
This build item can be used to turn a class that is not annotated with a CDI scope annotation into a bean, i.e. the default scope annotation is added automatically if all conditions are met. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
This build item can be used to define annotations that will turn a non-static field into an injection point even if no Show more |
No Javadoc found |
Represent a Jandex Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
By default, only explicit/implicit bean archives (as defined by the spec) are considered during the bean discovery. However, extensions can register a logic to identify additional bean archives. Show more |
No Javadoc found |
A build item that represents the fully initialized CDI bean container. This item is produced as the last step of the ArC bootstrap process. Show more |
No Javadoc found |
Build item that registers a listener which gets notified as soon as the CDI bean container is initialized. This is a convenient way to get access to beans and configure them as soon as the container is started. An instance of the running Show more |
No Javadoc found |
This build item is used to specify additional bean defining annotations. See also 2.5.1. Bean defining annotations.
By default, the resulting beans must not be removed even if they are considered unused and Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Consumers of this build item can easily inspect all class-based beans, observers and injection points registered in the application. Synthetic beans and observers are not included. If you need to consider synthetic components as well use the Show more |
None |
Bean registration phase can be used to register synthetic beans.
An extension that needs to produce other build items during the "bean registration" phase should use this build item. The build step should produce a Show more |
No Javadoc found
No Javadoc found |
No Javadoc found |
|
A type of build item that contains only declaring classes, methods and fields that have been annotated with unsuccessful build time conditions. It aims to be used to manage the exclusion of the annotations thanks to the build time conditions also known as Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found |
|
This build item hold the "final" predicate that is used to distinguish application classes from framework/library classes. Show more |
No Javadoc found |
Represents a mandatory config property that needs to be validated at runtime. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Context registration phase can be used to register custom CDI contexts.
An extension that needs to produce other build items during the "context registration" phase should use this build item. The build step should produce a Show more |
No Javadoc found
No Javadoc found |
An extension can provide a custom Show more |
No Javadoc found |
Holds information about all known custom scopes in the deployment and has utility methods allowing to check whether given class has some scope annotation. Show more |
No Javadoc found |
An extension that registers a custom CDI context via Show more |
No Javadoc found |
This build item is used to specify types to be excluded from discovery. An element value can be:
If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type. Show more |
No Javadoc found |
A generated CDI bean. If this is produced then a Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Allows extensions to programmatically exclude certain packages from split package detection which is executed by
Show more |
No Javadoc found |
Make it possible to programmatically modify qualifiers on an injection point. Show more |
No Javadoc found |
Represents an intercepted static method. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Marker build item to signal that bytecode transformers used for static method interception were registered. ASM class visitors produced by transformers registered by consumers of this build item will be run before visitors used for static method interception. Show more |
None |
Makes it possible to register annotations that should be considered interceptor bindings but are not annotated with Show more |
No Javadoc found |
Holds a reference to the interceptor resolver. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Provides access to Show more |
No Javadoc found |
Marks a bean archive with given coordinates (groupId, artifactId and optionally classifier) as known compatible with Quarkus. This is only useful for bean archives whose Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
An extension that needs to produce other build items during the "synthetic observer registration" phase should use this build item. The build step should produce a Show more |
No Javadoc found
No Javadoc found |
This build item is used to register an Show more |
No Javadoc found |
A build item that represents the fully initialized CDI bean container. This item is produced immediately before Show more |
No Javadoc found |
Makes it possible to register annotations that should be considered qualifiers but are not annotated with Show more |
No Javadoc found |
This build item instructs ArC to produce a Show more |
No Javadoc found |
It’s made public so that you can make use of the abstraction. e.g. if you need to do a similar inspection over Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
This build item is used to specify resource annotations that makes it possible to resolve non-CDI injection points, such as Java EE resources. Show more |
No Javadoc found |
Makes it possible to register annotations that should be considered stereotypes but are not annotated with Show more |
No Javadoc found |
Consumers of this build item can easily inspect all beans, observers and injection points registered in the application. Synthetic beans and observers are included. If interested in class-based components only you can use the Show more |
None |
Makes it possible to register a synthetic bean.
Bean instances can be easily produced through a recorder and set via Show more |
No Javadoc found |
This build item should be consumed by build steps that require RUNTIME_INIT synthetic beans to be initialized. @see SyntheticBeanBuildItem Show more |
None |
Makes it possible to query transformed annotations for a given annotation target. @see AnnotationsTransformer Show more |
No Javadoc found |
This build item is used to exclude beans that would be normally removed if the config property
Show more |
No Javadoc found
No Javadoc found |
Validation phase can be used to validate the deployment.
An extension that needs to produce other build items during the "validation" phase should use this build item. The build step should produce a Show more |
No Javadoc found
No Javadoc found |
Azure Functions
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
Cache
Class Name |
Attributes |
---|---|
This build item is used to pass the full list of cache names from the validation step to the recording step. Show more |
No Javadoc found |
Cache - SPI
Class Name |
Attributes |
---|---|
Build item used to ensure that a cache of the specified name is created at runtime. This is used in order to create caches when means other than the standard cache annotations are used. Show more |
No Javadoc found |
A build item that makes sure a Show more |
No Javadoc found |
A build item that can be used by extensions to determine what kind of cache backend is configured. This is useful for cases where caching extensions specific data does not make sense for remote cache backends Show more |
No Javadoc found |
Container Image - SPI
Class Name |
Attributes |
---|---|
No Javadoc found |
|
No Javadoc found |
|
None |
|
A Show more |
No Javadoc found |
This Show more |
No Javadoc found |
The container registry to use
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
A label to be added to the built container image This will only have an effect if the extension building the container image supports adding custom labels (like the Jib extension) Show more |
No Javadoc found
No Javadoc found |
None |
|
No Javadoc found |
|
There are cases where a single segment image (an image without group) is preferred. This build item is used to express this preferrence. Show more |
None |
Datasource
Class Name |
Attributes |
---|---|
A build item that represents the "quarkus.datasource.db-kind" value. This is generated by specific extensions that are meant to take away the burden of configuring anything datasource related from the user. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
A handler that can map an automatic datasource to the relevant config properties. Show more |
The type of database this is for
The function that provides the runtime config given a running DevServices database
Function that checks if a given datasource has been configured. If it has been configured generally the DevServices will not be started. |
A provider that knows how to start a database of a specific type. Show more |
No Javadoc found
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
DevServices - Keycloak
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found |
|
A marker build item signifying that integrating extensions (like OIDC and OIDC client) are enabled. The Keycloak Dev Service will be started in DEV mode if at least one item is produced and the Dev Service is not disabled in other fashion. Show more |
No Javadoc found |
Elasticsearch REST client common
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Elytron Security
Class Name |
Attributes |
---|---|
None |
|
None |
|
This represents a {@linkplain SecurityDomain} instance output by a build step. Show more |
No Javadoc found |
A build item for the {@linkplain SecurityRealm} runtime values created for the deployment. These are combined into a single {@linkplain org.wildfly.security.auth.server.SecurityDomain} by the {@linkplain ElytronDeploymentProcessor} . Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Funqy Server Common
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
None |
gRPC
Class Name |
Attributes |
---|---|
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
Hibernate ORM
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Quarkus attempts to automatically define a persistence unit when the Hibernate ORM extension is enabled, a default datasource is defined, and there are mapped entities. This build item represents the decision about creating such an implied persistence unit; it’s modelled as a BuildItem so that other extensions can be aware of such a persistence unit being defined (e.g. Hibernate Reactive needs to know). Show more |
No Javadoc found |
Internal model to represent which objects are likely needing enhancement via HibernateEntityEnhancer. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Provides the Jandex index of the application, combined with the index of additional JPA components that might have been generated. @author Sanne Grinovero <sanne@hibernate.org> Show more |
No Javadoc found |
Provides configuration specific to a persistence unit and necessary to build the JPA model. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Internal model to hold the mapping linking a JPA entity to its corresponding persistence units. Show more |
No Javadoc found |
Indicates that the Hibernate ORM persistence units have been started. Show more |
None |
Not to be confused with PersistenceXmlDescriptorBuildItem, which holds items of the same type. This build item represents a later phase, and might include the implicit configuration definitions that are automatically defined by Quarkus. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Provides instances of Show more |
No Javadoc found |
Hibernate ORM - SPI
Class Name |
Attributes |
---|---|
Additional Jpa model class that we need to index @author Stéphane Épardaud Show more |
No Javadoc found |
An Hibernate Dialect associated with a database kind. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Hibernate ORM with Panache
Class Name |
Attributes |
---|---|
Used to record that a specific JPA entity is associated with a specific persistence unit Show more |
No Javadoc found
No Javadoc found |
Represents a regular Panache entity class. Show more |
No Javadoc found |
Hibernate Reactive with Panache
Class Name |
Attributes |
---|---|
Represents a regular Panache entity class. Show more |
No Javadoc found |
Hibernate Search - ORM + Elasticsearch
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Hibernate Search - Standalone + Elasticsearch
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Hibernate Validator - SPI
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found |
|
BuildItem used to publish the list of detected Bean Validation annotations for consumption by other extensions. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Infinispan - Client
Class Name |
Attributes |
---|---|
Provide the Infinispan clients as RuntimeValue’s. Show more |
No Javadoc found
No Javadoc found |
Represents the values of the Show more |
No Javadoc found |
No Javadoc found |
|
No Javadoc found
No Javadoc found |
Info - SPI
Class Name |
Attributes |
---|---|
Allows for extensions to include their own Show more |
No Javadoc found |
Allows for extensions to include their properties into the info endpoint Show more |
No Javadoc found
No Javadoc found |
Jackson
Class Name |
Attributes |
---|---|
Used when an extension needs to inform the Jackson extension that a class should not be registered for reflection even if it annotated with @JsonDeserialize Show more |
No Javadoc found |
Jackson - SPI
Class Name |
Attributes |
---|---|
BuildItem used to signal that some Jackson module has been detected on the classpath The modules are then registered with the ObjectMapper. Note: Modules are assumed to have a default constructor Show more |
No Javadoc found |
BuildItem used to create a Jackson SimpleModule for the purpose of registering serializers and deserializers Serializers and deserializers MUST contain a public no-args constructor Show more |
No Javadoc found
No Javadoc found |
Jakarta REST Client
Class Name |
Attributes |
---|---|
BuildItem to register a Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found
No Javadoc found |
No Javadoc found Show more |
No Javadoc found
No Javadoc found |
JAX-RS - SPI
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found |
JAXB
Class Name |
Attributes |
---|---|
List of classes to be bound in the JAXB context. Aggregates all classes passed via Show more |
No Javadoc found |
List of class names to be bound in the JAXB context. Note that some of the class names can be removed via Show more |
No Javadoc found |
A location that should be scanned for jaxb.index files Show more |
No Javadoc found |
JMS - SPI
Class Name |
Attributes |
---|---|
A build item that can be used to wrap the JMS ConnectionFactory Show more |
No Javadoc found |
JSON-B - SPI
Class Name |
Attributes |
---|---|
BuildItem used to register a custom JsonbDeserializer with the default Jsonb bean Serializers and deserializers MUST contain a public no-args constructor Show more |
No Javadoc found |
BuildItem used to register a custom JsonbSerializer with the default Jsonb bean Serializers and deserializers MUST contain a public no-args constructor Show more |
No Javadoc found |
Kubernetes - SPI
Class Name |
Attributes |
---|---|
A build item that wraps around ConfigurationSupplier objects. The purpose of those build items is influence the configuration that will be feed to the generator process. Show more |
The configuration supplier |
A build item that wraps around Configurator objects. The purpose of those build items is influence the configuration that will be feed to the generator process. ConfigurationRegistry are similar to decorators, but are applied to configuration instead of generated resources. Show more |
The configurator |
Build item that allows us to supply a custom output dir instead of defaulting to {project.target.dir}/kubernetes It’s different from the Show more |
No Javadoc found |
Build item that allows us to supply a custom project root instead of allowing dekorate to figure out the project root based on its own rules Show more |
No Javadoc found |
A build item that wraps around Decorator objects. The purpose of those build items is to perform modification on the generated resources. Show more |
The group the decorator will be applied to.
The decorator |
Produce this build item to expose the Dekorate project and Dekorate session. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Represents a resource generated by the quarkus-kubernetes extension Show more |
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found |
|
Produce this build item to request the Kubernetes extension to generate a Kubernetes Show more |
Name of the generated
RoleRef configuration.
The target subjects.
The labels of the cluster role resource. |
Produce this build item to request the Kubernetes extension to generate a Kubernetes Show more |
Name of the generated
The |
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
Used to control which Kubernetes targets have their files generated and which get deployed Since these can be generated by various locations, code that needs the "final" set of items, should use the Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
This build item is produced once the effective service account used for the generated resources is computed. Useful for downstream extensions that need to know this information to wait until it is made available. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
|
A Built item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container. Env vars specified through this build item, will take precedence over inherited ones. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
A Built item for generating init containers. The generated container will have the specified fields and may optionally inherit env vars and volumes from the app container. Env vars specified through this build item, will take precedence over inherited ones. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
A build item that extension can use to mark a specific resource definition as optional. An optional resource, when fails to get deployed, will not cause the entire deployment process to fail, but will log a warning instead. Show more |
No Javadoc found
No Javadoc found |
Contains the effective output directory where to find the generated kubernetes resources. Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
Indicates when the port is enabled vs simply configured. For example the presence
No Javadoc found |
|
A build item for selecting which port to use for probes using an {@literal HTTP get} action. Show more |
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Produce this build item to request the Kubernetes extension to generate a Kubernetes Show more |
Name of the generated
No Javadoc found
RoleRef configuration.
The target subjects.
The labels of the cluster role resource. |
Produce this build item to request the Kubernetes extension to generate a Kubernetes Show more |
Name of the generated
Namespace of the generated
The |
Produce this build item to request the Kubernetes extension to generate a Kubernetes Show more |
Name of the generated
Namespace of the generated
Labels of the generated
If true, this service account will be used in the generated Deployment resources. |
Kubernetes - Vanilla
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found |
A build item that is used to prevent the Kubernetes processing from requesting a container image push request. This is useful for cases where the kubernetes cluster is local and the container image is built directly into a context (i.e. a docker daemon) which the cluster has access to. Show more |
None |
No Javadoc found Show more |
No Javadoc found |
Kubernetes Client - SPI
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
Kubernetes Service Binding - SPI
Class Name |
Attributes |
---|---|
Build item that describes a service that the application needs to bind to. The qualifier does not encapsulate the target service coordinates, but information that given the right context can be mapped to coordinates. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Build item that describes a kubernetes resource that the application needs to bind to. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Messaging
Class Name |
Attributes |
---|---|
Represents an application channel. These channels can be declared using Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Represents a reactive messaging connector. It contains the name (like Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Represents a channel managed by a connector. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Represents a channel injection. Show more |
The name of the channel. |
Represents an emitter injection. Show more |
The name of the stream the emitter is connected to.
The name of the overflow strategy. Valid values are
The buffer size, used when
Whether the emitter uses the
The emitter type
If the emitter uses the |
Represents a method annotated with Show more |
No Javadoc found
No Javadoc found |
Represents an outbound channel without downstream or an inbound channel without upstream. In other words, this class represents channels that should be managed by connectors. Show more |
No Javadoc found
No Javadoc found |
Micrometer
Class Name |
Attributes |
---|---|
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found |
MongoDB Client
Class Name |
Attributes |
---|---|
Register additional BsonDiscriminator’s for the MongoDB clients. Show more |
No Javadoc found |
Register additional Show more |
No Javadoc found |
Register additional Show more |
No Javadoc found |
Register additional Show more |
No Javadoc found |
Provide the MongoDB clients as RuntimeValue’s. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Represents the values of the Show more |
No Javadoc found
No Javadoc found |
Register additional Show more |
No Javadoc found |
If generated, all the Mongo clients need to be unremovable Show more |
None |
Register additional Show more |
No Javadoc found |
MongoDB with Panache - Common Deployment
Class Name |
Attributes |
---|---|
Represents a regular Panache entity class. Show more |
No Javadoc found |
Narayana JTA
Class Name |
Attributes |
---|---|
Marker build item that indicates that the Narayana JTA extension has been initialized. Show more |
None |
Netty
Class Name |
Attributes |
---|---|
Provides suppliers that return EventLoopGroup used by the application. See EventLoopSupplierBuildItem to register custom EventLoopGroup Show more |
No Javadoc found
No Javadoc found |
Register EventLoopGroup suppliers to be used to produce main EventLoopGroup and boss EventLoopGroup annotated beans. If not provided, both will be created from a default supplier. See EventLoopGroupBuildItem for actual supplier instances Show more |
No Javadoc found
No Javadoc found |
Build item to specify the minimal required Show more |
No Javadoc found |
Observability Dev Services
Class Name |
Attributes |
---|---|
Build item used to carry running DevService values to Dev UI. Show more |
No Javadoc found |
OpenID Connect Client
Class Name |
Attributes |
---|---|
Represents one Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Contains non-default names of OIDC Clients. Show more |
No Javadoc found |
OpenTelemetry
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found |
No Javadoc found |
|
Build item to be used by Quarkiverse exporters to register themselves as an external exporter. Show more |
No Javadoc found |
Panache - Common
Class Name |
Attributes |
---|---|
Build item to indicate that those classes are Panache-enhanced and will get getters/setters generated for public fields, even if they’re not visible in the index. Show more |
No Javadoc found |
Build item to declare that a Show more |
No Javadoc found |
Panache - Hibernate - Common
Class Name |
Attributes |
---|---|
Purely marker build item so that you can register enhancers after Hibernate registers its enhancers, which would make your enhancers run before the Hibernate enhancers Show more |
None |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
Qute
Class Name |
Attributes |
---|---|
No Javadoc found |
|
Represents a method of a class annotated with Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
List of template locations in form of RegEx located by custom locators that must not be validated as custom locators are not available at build time. Show more |
No Javadoc found |
Holds a name of a generated Show more |
No Javadoc found |
This build item can be used to register an implicit value resolver for the specified class. It is also possible to specify the synthetic Show more |
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Represents a message bundle method. Note that templates that contain no expressions/sections don’t need to be validated. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Represents a template extension method. @see TemplateExtension Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Holds all template file paths, including the versions without suffixes configured via Show more |
No Javadoc found |
Represents a global variable field/method. @see TemplateGlobal Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found |
|
Discovered template. Templates backed by files located in a template root are discovered automatically. Furthermore, extensions can produce this build item in order to provide a template that is not backed by a file. @see TemplateRootBuildItem Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
This build item represents a source of template files.
By default, the templates are found in the Show more |
No Javadoc found |
No Javadoc found |
|
No Javadoc found |
|
Represents the result of analysis of all templates. Show more |
No Javadoc found |
Makes it possible to intentionally ignore some parts of an expression when performing type-safe validation. @see TypeCheck Show more |
No Javadoc found
No Javadoc found |
This build item can be used to hook into the parser logic during validation at build time. Validation parser hooks are never used at runtime. Show more |
No Javadoc found |
Reactive DB2 Client
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
Reactive Microsoft SQL Server Client
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
Reactive MySQL Client
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
Reactive Oracle Client
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
Reactive PostgreSQL Client
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
Reactive Routes
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
If true, always attempt to authenticate user right before the body handler is run |
Redis Client
Class Name |
Attributes |
---|---|
No Javadoc found |
|
Request the creation of the Redis client with the given name. Show more |
No Javadoc found |
REST
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found
No Javadoc found |
No Javadoc found |
|
A marker build item signifying that observability features have been integrated Show more |
None |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
Provides a list of entries for each JAX-RS Resource Methods created during the indexing process. Each entry also contains the information about the Java class and method that correspond to the JAX-RS Resource Method, giving extensions access to the entire set of metadata thus allowing them to build additionally build-time functionality. Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
REST - Common
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
This contains all the parameter containers (bean param classes and records) as well as resources/endpoints
This contains all the non-record parameter containers (bean param classes only) as well as resources/endpoints |
No Javadoc found Show more |
No Javadoc found |
Represents the index that is going to be used to look up JAX-RS Resources. This index contains both code that is present on disk at build time, and code that is generated by other extensions. Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
Enable the registration of additional default produces handlers for server endpoints Show more |
No Javadoc found |
REST - Common Jackson Bits
Class Name |
Attributes |
---|---|
A BuildItem to mark that the server side jackson provider is defined. If not "emitted" by any of the processors, the reactive rest client (if used) will add its own jackson provider Show more |
None |
REST - Jackson
Class Name |
Attributes |
---|---|
Contains the special Jackson features required by the application Show more |
No Javadoc found |
Used to pass info about a JAX-RS resource method that needs to perform custom serialization Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
REST - Server - SPI
Class Name |
Attributes |
---|---|
A build item which extensions can generate when they want to allow RESTEasy Reactive methods with parameters that are annotated with not REST annotations. This allows RESTEasy Reactive to let mixed parameters coexist within resource methods signature Show more |
None |
Make it possible to add, remove or alter annotations on various components. The provided transformer uses Show more |
No Javadoc found |
Register types that should be available for injection into JAX-RS methods via Show more |
No Javadoc found |
Build time that allows extensions to register a way to provide a value for configuration that is provided at runtime and that is needed by implementations of Show more |
The runtime configuration class
A supplier of the runtime value of the configuration class. This supplier is meant to be provided by a recorder |
No Javadoc found |
|
A build item that allows extension to define a Show more |
No Javadoc found
No Javadoc found |
A marker build item which extensions can generate when they want to force RESTEasy Reactive to not reply with 404 when it does not handle the path and instead just pass control onto the next Vert.x handler Show more |
None |
If an extension generates this, then Quarkus will make JAX-RS Resources beans as well Show more |
None |
When an Show more |
No Javadoc found |
REST - SPI
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Can be used by extensions that want to make classes not annotated with JAX-RS Show more |
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Build item used to register classes that are annotated with Show more |
No Javadoc found |
Build item used to register classes that are annotated with Show more |
No Javadoc found |
Build item used to register classes that are annotated with Show more |
No Javadoc found |
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Represents a JAX-RS resource that is generated. Meant to be used by extension that generate JAX-RS resources as part of their build time processing Show more |
No Javadoc found
No Javadoc found |
Marker build item that can be used by advanced extensions that can make sure that mixing RESTEasy Classic and RESTEasy Reactive dependencies will not cause problems Show more |
None |
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found |
|
None |
|
None |
REST Client
Class Name |
Attributes |
---|---|
A Build Item that is used to register annotations that are used by the client to register services into the client context. Show more |
No Javadoc found
No Javadoc found |
A Build Item that is used to capture the information of usages equivalent to Show more |
No Javadoc found
No Javadoc found |
Contains information about the REST Clients that have been discovered via Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
REST Client - SPI
Class Name |
Attributes |
---|---|
Make it possible to add, remove or alter annotations on various components. The provided transformer uses Show more |
No Javadoc found |
Represents the data necessary for creating a Http proxy for a REST Client Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
REST data with Panache
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
|
No Javadoc found Show more |
No Javadoc found
No Javadoc found |
No Javadoc found |
RESTEasy Classic
Class Name |
Attributes |
---|---|
A build item that holds Non jax-rs classes Show more |
No Javadoc found |
RESTEasy Classic - Common
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
Used to mark a class as a potential REST client interface consumed by the MicroProfile REST client. Useful when you want to apply different behaviors to REST resources and REST clients. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Gives access to the configured Show more |
No Javadoc found |
RESTEasy Classic - Common - SPI
Class Name |
Attributes |
---|---|
No Javadoc found |
|
A build item that represents a JAX-RS provider class. Show more |
No Javadoc found |
RESTEasy Classic - Server common
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
|
A build item that is meant to customize the RESTEasy Deployment before it has been finalized This gives extensions to ability to add stuff to the Deployment Show more |
No Javadoc found |
A build item that represents the configuration of the RESTEasy server. Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
A build item that represents a path mapping from web.xml Show more |
No Javadoc found |
RESTEasy Classic - Server common - SPI
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found |
The package prefix of any annotations that have to be compatible with JaxRs resource class to allow constructor injection. Show more |
No Javadoc found |
A build item that represents a JAX-RS config. Show more |
No Javadoc found
No Javadoc found |
RESTEasy Classic’s REST Client
Class Name |
Attributes |
---|---|
Used to mark a custom annotation and its associated JAX-RS client provider Show more |
No Javadoc found
No Javadoc found |
Register provider against every Rest client matching predicate. Show more |
No Javadoc found
No Javadoc found |
RESTEasy Client - OpenID Connect Filter
Class Name |
Attributes |
---|---|
Contains a list of all Rest clients annotated with @OidcClientFilter("someClientName"). Show more |
No Javadoc found |
Scheduler
Class Name |
Attributes |
---|---|
This build item holds all discovered Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
A marker item which forces Quarkus Scheduler initialization regardless of presence of any Show more |
None |
An extension that provides an implementation of Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Security
Class Name |
Attributes |
---|---|
Used as an integration point when extensions need to customize the security behavior of a bean The ResultHandle that is returned by function needs to be an instance of SecurityCheck Show more |
No Javadoc found
No Javadoc found |
No Javadoc found |
|
No Javadoc found |
|
Marker build item that is used to indicate that there are Show more |
None |
Metadata for the names of JCA {@linkplain java.security.Provider} to register for reflection Show more |
No Javadoc found
No Javadoc found |
Security - SPI
Class Name |
Attributes |
---|---|
Contains classes that need to have @DenyAll on all methods that don’t have security annotations
@deprecated use Show more |
No Javadoc found
No Javadoc found |
Contains methods that need to have Show more |
No Javadoc found
No Javadoc found |
Allows integrating extensions to signal they provide their own security annotation. Standard security annotations cannot be combined and when two different annotations are applied, one on the class level and second on the method level, the method level must win. Without this build item, the Quarkus Security extension won’t know about your security annotation integration. Please beware that integrating extension-specific security annotation is responsibility of that extension. This build item is intended for very specialized Quarkus core use cases, like integration of the authorization policy in the Vert.x HTTP extension. Show more |
No Javadoc found |
This item allows to enhance properties of security events produced by SecurityConstrainer. The SecurityConstrainer is usually invoked when CDI request context is already fully setup, and the additional properties can be added based on the active context. Show more |
No Javadoc found |
Allows to create additional security checks for standard security annotations defined on a class level. We strongly recommended to secure CDI beans with Show more |
No Javadoc found |
Security check storage containing additional security checks created for secured classes matching one of the Show more |
No Javadoc found |
Registers default SecurityCheck with the SecurityCheckStorage. Please make sure this build item is produced exactly once or validation will fail and exception will be thrown. Show more |
No Javadoc found |
Contains transitive Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Provides a way to transform roles allowed specified as configuration expressions in annotations to runtime configuration values. Show more |
No Javadoc found
No Javadoc found |
Security Jakarta Persistence - Common
Class Name |
Attributes |
---|---|
This build items holds Show more |
No Javadoc found |
Build item to evaluate whether the class is a Panache model class. Show more |
No Javadoc found |
SmallRye Context Propagation
Class Name |
Attributes |
---|---|
Marker build item for build ordering. Signifies that CP is set up and ready for use. Show more |
None |
SmallRye Context Propagation - SPI
Class Name |
Attributes |
---|---|
This build item can be used to register a Show more |
No Javadoc found |
SmallRye Fault Tolerance
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found |
SmallRye GraphQL
Class Name |
Attributes |
---|---|
Used to create the publisher for the graphql trafic log in dev ui Show more |
No Javadoc found |
SmallRye GraphQL Client
Class Name |
Attributes |
---|---|
This marks that the SmallRye GraphQL Client configurations have been processed and initialized. Show more |
None |
SmallRye Health - SPI
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
SmallRye OpenAPI
Class Name |
Attributes |
---|---|
The filtered Jandex index of the OpenApi Show more |
No Javadoc found |
SmallRye OpenAPI - SPI
Class Name |
Attributes |
---|---|
No Javadoc found Show more |
No Javadoc found |
Ignore a static OpenAPI document included in extension and/or dependencies. Supports regular expressions. Show more |
No Javadoc found |
The final OpenAPI Document as generated by the Extension. Show more |
No Javadoc found |
Spring - DI
Class Name |
Attributes |
---|---|
The purpose of this bean is to map the names of the Spring Beans to their associated DotName This info is needed when trying to convert SpEL expressions that reference beans by name, to bytecode Show more |
No Javadoc found |
Spring - Scheduling
Class Name |
Attributes |
---|---|
Build Item recording all the methods that have been effectively annotated with Show more |
No Javadoc found |
Spring Security
Class Name |
Attributes |
---|---|
Build Item recording all the methods that have been effectively annotated with Show more |
No Javadoc found |
Swagger UI
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
TLS Registry
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found |
|
A build item that indicates that the TLS registry has been initialized. Show more |
No Javadoc found |
Undertow - SPI
Class Name |
Attributes |
---|---|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
A generated static resource that will be served by the web container This is automatically registered in native mode Show more |
No Javadoc found
No Javadoc found |
No Javadoc found |
|
No Javadoc found Show more |
No Javadoc found |
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
No Javadoc found |
Vert.x
Class Name |
Attributes |
---|---|
No Javadoc found |
|
A build item that can be used to retrieve the number of events loops that have been configured/calculated Show more |
No Javadoc found |
Carries all types for which the Show more |
No Javadoc found |
No Javadoc found
No Javadoc found |
|
Marker build item used to force the re-initialization of Vert.x JSON handling in native-image Show more |
None |
No Javadoc found |
|
Provide a consumer of VertxOptions to allow customization of Vert.x system behavior, e.g. setting MetricsOptions to enable and configure a metrics provider. Consumers will be called in priority order (lowest to highest) after VertxConfiguration has been read and applied. Show more |
No Javadoc found
No Javadoc found |
Vert.x - HTTP
Class Name |
Attributes |
---|---|
Carries all gathered Show more |
Contains: - Methods annotated with |
No Javadoc found |
|
Write javascript file containing const vars with build time data Show more |
No Javadoc found |
A build item that represents a handler for the default route Show more |
No Javadoc found |
Hold add discovered build time methods that can be executed via json-rpc Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found |
|
Provides a way for extensions to register eager security interceptor. For example, the Vert.x HTTP extension registers Show more |
No Javadoc found
No Javadoc found
No Javadoc found
If this interceptor is always accompanied by |
Bears collected intercepted methods annotated with registered security annotation. Security interceptor needs to be created and applied for each intercepted method. @see EagerSecurityInterceptorBindingBuildItem for more information on security filters Show more |
Annotation binding value: '@HttpAuthenticationMechanism("custom")' ⇒ 'custom'; mapped to annotated methods
Interceptor binding annotation name, like
If this interceptor is always accompanied by |
Allows extensions to contribute an action (button) to the error page Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found
No Javadoc found
No Javadoc found |
|
Register Show more |
Annotation name, for example
Authentication mechanism scheme, as defined by |
Normalized from quarkus.http.root-path. This path will always end in a slash |
|
Used internally to define some of our own imports Show more |
No Javadoc found |
Used internally to define some of our own pages Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
Simple holder for all discovered Json RPC Methods Show more |
No Javadoc found |
A handler that is applied to the management interface route Show more |
No Javadoc found
No Javadoc found |
No Javadoc found |
|
Normalized of quarkus.http.root-path. Must end in a slash
Normalized from quarkus.http.non-application-root-path
Normalized from quarkus.management.root-path
Non-Application root path is distinct from HTTP root path.
No Javadoc found |
|
No Javadoc found Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
Used internally to relocate namespaces for backward compatibility Show more |
No Javadoc found |
This is a marker that indicates that the body handler should be installed on all routes, as an extension requires the request to be fully buffered. Show more |
No Javadoc found |
Marker class that can be used to force the socket to open even when using virtual HTTP. There are some use cases that may want to handle both real and virtual HTTP requests, such as mapping incoming gRPC requests onto JAX-RS handlers. Show more |
None |
Marker class to turn on virtual http channel Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
No Javadoc found |
|
Contains information on the security model used in the application Show more |
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found |
|
Used to create the publisher for the vertx access log in dev ui Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
|
ArtifactKey pointing to the web jar. Has to be one of the applications dependencies.
Root inside the webJar starting from which resources are unpacked.
Only copy resources of the webjar which are either user overridden, or contain variables.
Defines whether Quarkus can override resources of the webjar with Quarkus internal files.
No Javadoc found |
|
Holds the complete result after applying every Show more |
No Javadoc found |
No Javadoc found |
Vert.x - HTTP - Dev UI SPI
Class Name |
Attributes |
---|---|
For All DEV UI Build Item, we need to distinguish between the extensions, and the internal usage of Dev UI Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found
No Javadoc found |
|
Holds any Build time actions for Dev UI the extension has Show more |
No Javadoc found
No Javadoc found |
Add a page (or section) to the Dev UI. This is typically the middle part of the screen. This will also add links to this pages Show more |
No Javadoc found |
No Javadoc found
No Javadoc found
No Javadoc found |
|
None |
|
This allows you to register a class that will provide data during runtime for JsonRPC Requests Show more |
No Javadoc found
No Javadoc found |
None |
|
Contains info on the build time template used to build static content for Dev UI All files are relative to dev-ui-templates/build-time/{extensionName} (in src/main/resources) This contain the fileName to the template, and the template data (variables) This allows extensions developers to add "static files" that they generate with Qute at build time. From a runtime p.o.v this is file served from "disk" Show more |
No Javadoc found |
Static Content generated at build time This is used to generate components that will be available in Dev UI, but generated during build. This contains the final content (no more generation) and will be served as is Show more |
No Javadoc found |
Vert.x - HTTP - SPI
Class Name |
Attributes |
---|---|
No Javadoc found |
|
This build item aims to be used by extensions to generate static resources.
Those resources will be served on the given Show more |
No Javadoc found
No Javadoc found
No Javadoc found |
A build item that represents a route that should be added to the router. Producing this build item does not mean the HTTP server is available. It will be consumed if the Quarkus Vert.x HTTP extension is present. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
No Javadoc found |
|
Marker build item indicating that the application uses a separate interface:port for the management endpoints such as metrics, health and prometheus. Show more |
None |
Vert.x - SPI
Class Name |
Attributes |
---|---|
This build item should be considered private and should not be used outside of core Quarkus. It can be changed without notice. Show more |
No Javadoc found |
Web Dependency Locator
Class Name |
Attributes |
---|---|
No Javadoc found |
|
No Javadoc found Show more |
No Javadoc found
No Javadoc found |
WebSockets Client
Class Name |
Attributes |
---|---|
A server websocket endpoint Show more |
No Javadoc found
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found Show more |
No Javadoc found |
No Javadoc found |
WebSockets Next
Class Name |
Attributes |
---|---|
A generated representation of a WebSocket endpoint. Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |
This build item represents a WebSocket endpoint class, i.e. class annotated with Show more |
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found
No Javadoc found |