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

io.quarkus.paths.PathCollection path

No Javadoc found

A marker file that if present indicates that a given archive should be treated as an application archive.

Show more

java.lang.String file

No Javadoc found

java.util.Map<String,byte[]> resources

No Javadoc found

Allows extensions to add classes to the index available via CombinedIndexBuildItem . The classes are loaded by the Deployment ClassLoader.

Show more

java.util.Set<String> classesToIndex

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 Recorder parameters.

Show more

io.quarkus.deployment.recording.AnnotationProxyProvider provider

No Javadoc found

Indicates that a specific container image should be used to generate the AppCDS file

Show more

java.lang.String containerImage

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

java.nio.file.Path appCDSDir

Directory where various files needed for AppCDS generation will reside

A build item containing the result of the AppCDS generation process

Show more

java.nio.file.Path appCDS

The file containing the generated AppCDS

io.quarkus.bootstrap.model.ApplicationModel appModel

No Javadoc found

java.util.function.Supplier<DependencyInfoProvider> depInfoProvider

No Javadoc found

io.quarkus.deployment.ApplicationArchive root

No Javadoc found

java.util.Collection<ApplicationArchive> applicationArchives

No Javadoc found

java.util.Set<ApplicationArchive> allArchives

No Javadoc found

java.lang.String className

No Javadoc found

Makes it possible to identify wiring classes generated for classes from additional hot deployment paths.

Show more

java.util.function.Predicate<String> predicate

No Javadoc found

The Jandex index of the application root.

Show more

org.jboss.jandex.Index index

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String version

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

java.nio.file.Path archiveRoot

No Javadoc found

java.util.Collection<Path> excludedFromIndexing

No Javadoc found

io.quarkus.paths.PathCollection rootDirs

No Javadoc found

io.quarkus.paths.PathCollection paths

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

java.nio.file.Path path

No Javadoc found

java.lang.String type

No Javadoc found

java.util.Map<String,String> metadata

No Javadoc found

io.quarkus.sbom.ApplicationManifestConfig manifestConfig

No Javadoc found

BuildTimeConfigurationReader.ReadResult readResult

No Javadoc found

io.quarkus.runtime.LaunchMode launchMode

No Javadoc found

io.quarkus.dev.spi.DevModeType devModeType

No Javadoc found

java.lang.ClassValue<BooleanSupplier> suppliers

No Javadoc found

The build systems target directory. This is used to produce OutputTargetBuildItem

Show more

java.nio.file.Path outputDirectory

No Javadoc found

java.lang.String baseName

No Javadoc found

java.lang.String originalBaseName

No Javadoc found

boolean rebuild

No Javadoc found

java.util.Properties buildSystemProps

No Javadoc found

The definition of a constant that can be injected into recorders via their @Inject -annotated constructor. Compared to simply passing the value to a recorder proxy, this build item allows for injecting values into recorders without introducing new dependencies from build steps that use the recorder to build steps that create the constant value. This can be useful in complex dependency graphs.

Show more

io.quarkus.deployment.builditem.Holder<?> holder

No Javadoc found

io.quarkus.deployment.recording.ObjectLoader objectLoader

No Javadoc found

Transform a class using ASM ClassVisitor . Note that the transformation is performed after assembling the index and thus the changes won’t be visible to any processor steps relying on the index. You may consider using io.quarkus.arc.deployment.AnnotationsTransformerBuildItem if your transformation should be visible for Arc. See also I Need To Transform Annotation Metadata section of Quarkus CDI integration guide.

Show more

java.lang.String classToTransform

No Javadoc found

java.util.function.BiFunction<String,ClassVisitor,ClassVisitor> visitorFunction

No Javadoc found

java.util.function.BiFunction<String,byte[],byte[]> inputTransformer

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.

java.util.Set<String> requireConstPoolEntry

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.

boolean cacheable

No Javadoc found

int classReaderOptions

No Javadoc found

boolean continueOnFailure

No Javadoc found

int priority

No Javadoc found

Represents a technical capability that can be queried by other extensions. Build steps can inject Capabilities - a convenient build item that holds the set of registered capabilities. An extension may provide multiple capabilities. But only a single provider of a given capability is allowed in an application. If multiple providers of the same capability are detected during the build of an application, the build will fail with the corresponding error message. By default, capabilities are not displayed to users. Capabilities should follow the naming conventions of Java packages; e.g. io.quarkus.security.jpa . Capabilities provided by core extensions should be listed in the Capability interface and their name should always start with the io.quarkus prefix. @see Capabilities @see Capability

Show more

java.lang.String name

No Javadoc found

java.lang.String provider

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

java.util.Map<DotName,ClassInfo> changedClassesNewVersion

No Javadoc found

java.util.Map<DotName,ClassInfo> changedClassesOldVersion

No Javadoc found

java.util.Map<DotName,ClassInfo> deletedClasses

No Javadoc found

java.util.Map<DotName,ClassInfo> addedClasses

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 AdditionalApplicationArchiveMarkerBuildItem . Alternatively, you can index a dependency through IndexDependencyBuildItem . Compared to BeanArchiveIndexBuildItem , this index doesn’t contain all CDI-related information. On the other hand, it can contain classes from archives/dependencies that had no CDI component declared within them. The computing index can also be used to index classes on demand, when IndexView#getClassByName(DotName) is called. Note that this is a mutable index as this will add additional information, so in general this Index should only be used if you actually need it. @see AdditionalApplicationArchiveMarkerBuildItem @see IndexDependencyBuildItem

Show more

org.jboss.jandex.IndexView index

No Javadoc found

org.jboss.jandex.IndexView computingIndex

No Javadoc found

io.quarkus.deployment.pkg.builditem.JavaVersion javaVersion

No Javadoc found

java.lang.Class<?> configClass

No Javadoc found

java.util.Set<Class<?>> configComponentInterfaces

All the config interfaces registered for this config mapping (including the nested ones)

java.util.Set<Type> types

No Javadoc found

java.util.Set<String> generatedClasses

No Javadoc found

java.lang.String prefix

No Javadoc found

io.quarkus.deployment.builditem.Kind kind

No Javadoc found

org.jboss.jandex.DotName name

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

java.lang.String propertyName

No Javadoc found

java.lang.String defaultValue

No Javadoc found

java.lang.String docs

No Javadoc found

java.lang.String valueTypeName

No Javadoc found

java.util.List<String> allowedValues

No Javadoc found

io.quarkus.runtime.annotations.ConfigPhase configPhase

No Javadoc found

java.lang.Class<?> configClass

No Javadoc found

java.lang.String prefix

No Javadoc found

java.lang.Class<?> configClass

No Javadoc found

java.lang.String prefix

No Javadoc found

The build item which carries the build time configuration.

Show more

BuildTimeConfigurationReader.ReadResult readResult

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

java.lang.Class<?> valueType

No Javadoc found

org.aesh.command.container.CommandContainer consoleCommand

No Javadoc found

io.quarkus.runtime.RuntimeValue<Optional<Supplier<String>>> bannerSupplier

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

io.quarkus.deployment.IsContainerRuntimeWorking isContainerRuntimeWorking

No Javadoc found

java.lang.Boolean cachedStatus

No Javadoc found

org.jboss.threads.ContextHandler<Object> contextHandler

No Javadoc found

io.quarkus.bootstrap.model.ApplicationModel appModel

No Javadoc found

Build Item that can be used to queue shutdown tasks that are run when the io.quarkus.bootstrap.app.CuratedApplication is closed. For production applications, this will be at the end of the Maven/Gradle build. For dev mode applications, this will be when dev mode shuts down. For tests, it will generally be at the end of the test run. However, for continuous testing this will be when the outer dev mode process shuts down. For unit style tests, this will usually be the end of the test.

Show more

boolean firstRun

No Javadoc found

java.util.concurrent.CopyOnWriteArrayList<Runnable> tasks

No Javadoc found

io.quarkus.bootstrap.classloading.QuarkusClassLoader baseCl

No Javadoc found

boolean registered

No Javadoc found

java.lang.String commandName

No Javadoc found

boolean successful

No Javadoc found

java.util.List<DeployCommandActionBuildItem> commands

No Javadoc found

Way for maven and gradle plugins to discover if any declared extensions support quarkus deploy

Show more

java.lang.String name

No Javadoc found

java.util.List<String> commands

No Javadoc found

java.lang.String name

No Javadoc found

java.util.Map<String,String> labels

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String description

No Javadoc found

io.quarkus.deployment.dev.devservices.ContainerInfo containerInfo

No Javadoc found

java.util.Map<String,String> configs

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

io.quarkus.deployment.builditem.DevServicesAdditionalConfigProvider configProvider

No Javadoc found

java.util.Collection<String> triggeringKeys

No Javadoc found

java.lang.String key

No Javadoc found

java.lang.String value

No Javadoc found

java.lang.Runnable callbackWhenEnabled

No Javadoc found

Build item that contains the final results of all configuration.

Show more

java.util.Map<String,String> config

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. RunningDevService helps to manage the lifecycle of the running dev service.

Show more

java.lang.String name

No Javadoc found

java.lang.String description

No Javadoc found

java.lang.String containerId

No Javadoc found

java.util.Map<String,String> config

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

java.lang.String source

No Javadoc found

Allows disabling of instrumentation based reload if the changed class matches certain criteria

Show more

java.util.function.Predicate<ClassInfo> predicate

No Javadoc found

Allows disabling of instrumentation based reload if the index of changed classes matches certain criteria

Show more

java.util.function.Predicate<Index> predicate

No Javadoc found

None

Contains the IDE to be opened when a request to open a class is made

Show more

io.quarkus.deployment.ide.Ide ide

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

java.util.function.BiConsumer<Throwable,StackTraceElement> exceptionHandler

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 jarFile property specifies the name of the jar file or a regular expression that can be used to match multiple jar files. Matching jar files using regular expressions should be done as a last resort. The resourceName property specifies the name of the resource file or a regular expression that can be used to match multiple resource files. For the match to work, the resources need to be part of the matched jar file(s) (see jarFile ). Matching resource files using regular expressions should be done as a last resort. See https://github.com/oracle/graal/pull/3179 for more details.

Show more

java.lang.String jarFile

No Javadoc found

java.lang.String resourceName

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

java.lang.String groupId

No Javadoc found

java.lang.String artifactId

No Javadoc found

java.util.Optional<String> classifier

No Javadoc found

Carries a predicate that identifies methods that can have annotations which affect the execution model ( @Blocking , @NonBlocking , @RunOnVirtualThread ). Used to detect wrong usage of these annotations, as they are implemented directly by the various frameworks and may only be put on "entrypoint" methods. Placing these annotations on methods that can only be invoked by application code is always wrong.

Show more

java.util.function.Predicate<MethodInfo> predicate

No Javadoc found

The main executor for blocking tasks.

Show more

java.util.concurrent.ScheduledExecutorService executor

No Javadoc found

java.lang.String extension

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 - ; e.g. security-jpa . Features provided by core extensions should be listed in the Feature enum.

Show more

java.lang.String name

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 ReflectiveClassBuildItem , the weak field of that class is effectively false, no matter what value was supplied when creating ReflectiveClassBuildItem

Show more

java.lang.String className

No Javadoc found

boolean applicationClass

No Javadoc found

java.lang.String name

No Javadoc found

byte[] classData

No Javadoc found

java.lang.String source

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

java.lang.String name

No Javadoc found

byte[] classData

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

java.lang.String name

No Javadoc found

byte[] classData

No Javadoc found

java.lang.String name

No Javadoc found

byte[] data

No Javadoc found

boolean excludeFromDevCL

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 io.quarkus.vertx.http.deployment.spi.GeneratedStaticResourceBuildItem instead.

Identifies a file from a io.quarkus.bootstrap.devmode.DependenciesFilter#getReloadableModules(io.quarkus.bootstrap.model.ApplicationModel) reloadable module that, if modified, may result in a hot redeployment when in the dev mode. A file may be identified with an location or a matching predicate. See Builder#setLocation(String) and Builder#setLocationPredicate(Predicate) . The location may be:

  • a relative OS-agnostic file path where / is used as a separator; e.g. foo/bar.txt

  • an absolute OS-specific file path; e.g. /home/foo/bar.txt

  • a glob pattern as defined in java.nio.file.FileSystem#getPathMatcher(String) ; e.g. *.sample

If multiple build items match the same file then the final value of restartNeeded is computed as a logical OR of all the #isRestartNeeded() values.

Show more

java.lang.String location

No Javadoc found

java.util.function.Predicate<String> locationPredicate

No Javadoc found

boolean restartNeeded

No Javadoc found

A build item that provides the ability to detect if the current thread is an IO thread

Show more

io.quarkus.runtime.IOThreadDetector detector

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

java.lang.String groupId

No Javadoc found

java.lang.String artifactId

No Javadoc found

java.lang.String classifier

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

java.lang.String name

No Javadoc found

java.util.Optional<String> image

No Javadoc found

java.util.List<String> command

No Javadoc found

java.util.List<String> arguments

No Javadoc found

java.util.Map<String,String> taskEnvVars

No Javadoc found

java.util.Map<String,String> appEnvVars

No Javadoc found

boolean sharedEnvironment

No Javadoc found

boolean sharedFilesystem

No Javadoc found

A symbolic class that represents that an initialization task has been completed. Similar to ServiceStartBuildItem but focused on initialization tasks (e.g. db migrations etc) that are run during runtime just before the application starts. The build item is used, so that we can track when all initialization tasks have been completed.

Show more

java.lang.String name

No Javadoc found

If present, will force the addition of the -H:+InlineBeforeAnalysis flag during native image build

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

java.lang.String moduleName

No Javadoc found

java.lang.String packageName

No Javadoc found

GraalVM.Version exportSince

No Javadoc found

GraalVM.Version exportBefore

No Javadoc found

java.nio.file.Path path

No Javadoc found

java.nio.file.Path originalArtifact

No Javadoc found

java.nio.file.Path libraryDir

No Javadoc found

PackageConfig.JarConfig.JarType type

No Javadoc found

java.lang.String classifier

No Javadoc found

io.quarkus.sbom.ApplicationManifestConfig manifestConfig

No Javadoc found

java.lang.String path

No Javadoc found

java.util.List<String> libraryPaths

No Javadoc found

Used to register a class for JNI runtime access.

Show more

java.util.List<String> className

No Javadoc found

boolean constructors

No Javadoc found

boolean methods

No Javadoc found

boolean fields

No Javadoc found

JNI access registration fine-grained to single fields for a given class.

Show more

java.lang.String declaringClass

No Javadoc found

java.lang.String name

No Javadoc found

JNI access registration fine-grained to single methods for a given class.

Show more

java.lang.String declaringClass

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String[] params

No Javadoc found

Used to register a lambda capturing type in native mode

Show more

java.lang.String className

No Javadoc found

Indicates the type of launch.

Show more

io.quarkus.runtime.LaunchMode launchMode

No Javadoc found

java.util.Optional<DevModeType> devModeType

No Javadoc found

boolean auxiliaryApplication

No Javadoc found

java.util.Optional<DevModeType> auxiliaryDevModeType

No Javadoc found

boolean test

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

boolean liveReload

No Javadoc found

java.util.Set<String> changedResources

No Javadoc found

java.util.Map<Class<?>,Object> reloadContext

No Javadoc found

io.quarkus.bootstrap.app.ClassChangeInformation changeInformation

No Javadoc found

Establish the default log level of a log category.

Show more

java.lang.String category

No Javadoc found

java.util.logging.Level level

No Javadoc found

boolean setMinLevelDefault

No Javadoc found

java.util.Map<String,InheritableLevel> content

No Javadoc found

Declare that a log filter should be applied to the specified loggerName, provided the message starts with messageStart. @author Stéphane Épardaud

Show more

io.quarkus.runtime.logging.LogCleanupFilterElement filterElement

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

io.quarkus.runtime.RuntimeValue<Optional<Formatter>> formatterValue

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

io.quarkus.runtime.RuntimeValue<Optional<Formatter>> formatterValue

No Javadoc found

A build item for adding additional logging handlers.

Show more

io.quarkus.runtime.RuntimeValue<Optional<Handler>> handlerValue

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

io.quarkus.runtime.RuntimeValue<Optional<Formatter>> formatterValue

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

java.nio.file.Path srcMainJava

No Javadoc found

org.jboss.jandex.CompositeIndex knowClassesIndex

No Javadoc found

None

io.quarkus.deployment.recording.BytecodeRecorderImpl bytecodeRecorder

No Javadoc found

java.lang.String generatedStartupContextClassName

No Javadoc found

java.lang.String className

No Javadoc found

java.lang.String path

No Javadoc found

io.quarkus.deployment.metrics.MetricsCapability<String> metricsCapability

No Javadoc found

A metrics provider will iterate over all MetricsFactory consumers, allowing them to register metrics via bytecode recording

Show more

java.util.function.Consumer<MetricsFactory> factoryConsumer

No Javadoc found

io.quarkus.deployment.annotations.ExecutionTime executionTime

No Javadoc found

A build item for adding additional named logging handlers.

Show more

io.quarkus.runtime.RuntimeValue<Map<String,Handler>> namedHandlersMap

No Javadoc found

Native configuration generated by native image agent can be integrated directly into subsequence native build steps, if the user enables NativeConfig#agentConfigurationApply() . This build item is used to transfer the native configuration folder path onto the io.quarkus.deployment.pkg.steps.NativeImageBuildStep . If the build item is passed, the directory is added to the native image build execution.

Show more

java.lang.String directory

No Javadoc found

Do not use directly: use io.quarkus.deployment.builditem.nativeimage.NativeImageAllowIncompleteClasspathBuildItem instead.

Show more

boolean allow

No Javadoc found

java.nio.file.Path path

No Javadoc found

io.quarkus.deployment.pkg.builditem.GraalVMVersion graalVMVersion

No Javadoc found

boolean reused

No Javadoc found

java.util.Set<String> runtimeInitializedClasses

No Javadoc found

java.util.Set<String> runtimeReinitializedClasses

No Javadoc found

java.util.Set<String> resourceBundles

No Javadoc found

java.util.Set<List<String>> proxyDefinitions

No Javadoc found

java.util.Map<String,String> nativeImageSystemProperties

No Javadoc found

None

Represents a GraalVM Feature to be passed to native-image through the --features options.

Show more

java.lang.String qualifiedName

No Javadoc found

A build item that represents a java.lang.reflect.Proxy definition that will be required in native mode. This definition takes the form of an ordered list of interfaces that this proxy will implement.

Show more

java.util.List<String> classes

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 / -separated path name (with the same semantics as the parameters) passed to java.lang.ClassLoader#getResources(String) . Related build items:

  • Use NativeImageResourceDirectoryBuildItem if you need to add a directory of resources

  • Use NativeImageResourcePatternsBuildItem to select resource paths by regular expressions or globs

Show more

java.util.List<String> resources

No Javadoc found

Indicates that a resource bundle should be included in the native image

Show more

java.lang.String bundleName

No Javadoc found

java.lang.String moduleName

No Javadoc found

A build item that indicates that directory resources should be included in the native image Related build items:

  • Use NativeImageResourceBuildItem if you need to add a single resource

  • Use NativeImageResourcePatternsBuildItem to select resource paths by regular expressions or globs

Show more

java.lang.String path

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 includeGlob*() methods of the Builder are transformed to regular expressions internally. See NativeConfig.ResourcesConfig#includes for the supported glob syntax. The patterns are passed to the native image builder using resource-config.json . The same mechanism (and regular expression syntax) is used by native-image 's -H:ResourceConfigurationFiles , -H:IncludeResources and -H:ExcludeResources (since GraalVM 20.3.0) command line options. Related build items:

  • Use NativeImageResourceBuildItem if you need to add a single resource

  • Use NativeImageResourceDirectoryBuildItem if you need to add a directory of resources

Show more

java.util.List<String> excludePatterns

No Javadoc found

java.util.List<String> includePatterns

No Javadoc found

The resolved factory for the native image runner. Warning: This build item should not be consumed without the use of io.quarkus.deployment.pkg.steps.NativeOrNativeSourcesBuild in the onlyIf method of io.quarkus.builder.BuildStep because that leads to Quarkus having to resolve the container image runtime unnecessarily.

Show more

io.quarkus.deployment.pkg.steps.NativeImageBuildRunner buildRunner

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

java.lang.String securityProvider

No Javadoc found

A jar that is build to run the native image

Show more

java.nio.file.Path path

No Javadoc found

java.nio.file.Path libraryDir

No Javadoc found

A system property that will be set at native image build time

Show more

java.lang.String key

No Javadoc found

java.lang.String value

No Javadoc found

A build item that indicates the minimal acceptable JDK version the native-image tool was bundled with.

Show more

Runtime.Version minVersion

No Javadoc found

java.lang.String warning

No Javadoc found

Used to capture object substitution information for non-serializable classes.

Show more

io.quarkus.deployment.builditem.Holder<?,?> holder

No Javadoc found

The location that output artifacts should be created in.

Show more

java.nio.file.Path outputDirectory

No Javadoc found

java.lang.String baseName

No Javadoc found

java.lang.String originalBaseName

No Javadoc found

boolean rebuild

No Javadoc found

java.util.Properties buildSystemProperties

No Javadoc found

java.util.Optional<Set<ArtifactKey>> includedOptionalDependencies

No Javadoc found

None

Class to be preloaded in static initialization phase of Quarkus.

Show more

java.lang.String className

No Javadoc found

Extension build steps can produce this if preloading classes is enabled.

Show more

boolean initialize

No Javadoc found

A build item, which indicates that the ProcessBuilder#inheritIO() will not work for processes launched by build steps and instead the build step will have to explicitly stream the newly launched process' STDOUT/STDERR, if the data generated on the STDOUT/STDERR of the launched process needs to be made available @see io.quarkus.deployment.util.ProcessUtil

Show more

None

java.lang.String className

No Javadoc found

java.util.List<Closeable> closeables

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 Supplier<String[]> . No filtering is done on these parameters.

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 RecordableConstructorBuildItem for when the objects cannot be annotated

Show more

java.lang.Class<?> clazz

No Javadoc found

Used to register a class for reflection in native mode

Show more

java.util.List<String> className

No Javadoc found

boolean methods

No Javadoc found

boolean queryMethods

No Javadoc found

boolean fields

No Javadoc found

boolean classes

No Javadoc found

boolean constructors

No Javadoc found

boolean queryConstructors

No Javadoc found

boolean weak

No Javadoc found

boolean serialization

No Javadoc found

boolean unsafeAllocated

No Javadoc found

java.lang.String reason

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

java.lang.String className

No Javadoc found

java.lang.String typeReachable

No Javadoc found

Used by io.quarkus.deployment.steps.ReflectiveHierarchyStep to determine whether the final fields of the class should be writable (which they aren’t by default) If any one of the predicates returns true for a class, then ReflectiveHierarchyStep uses that true value

Show more

java.util.function.Predicate<ClassInfo> predicate

No Javadoc found

java.lang.String declaringClass

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String reason

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

org.jboss.jandex.Type type

No Javadoc found

org.jboss.jandex.IndexView index

No Javadoc found

java.util.function.Predicate<DotName> ignoreTypePredicate

No Javadoc found

java.util.function.Predicate<FieldInfo> ignoreFieldPredicate

No Javadoc found

java.util.function.Predicate<MethodInfo> ignoreMethodPredicate

No Javadoc found

java.lang.String source

No Javadoc found

boolean serialization

No Javadoc found

Used by io.quarkus.deployment.steps.ReflectiveHierarchyStep to ignore reflection warning deliberately

Show more

java.util.function.Predicate<DotName> predicate

No Javadoc found

java.lang.String declaringClass

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String[] params

No Javadoc found

boolean queryOnly

No Javadoc found

java.lang.String reason

No Javadoc found

Represents resources to be removed from a dependency when packaging the application.

Show more

io.quarkus.maven.dependency.ArtifactKey artifact

No Javadoc found

java.util.Set<String> resources

No Javadoc found

java.lang.String commandName

No Javadoc found

java.util.List<String> args

No Javadoc found

java.nio.file.Path workingDirectory

No Javadoc found

java.lang.String startedExpression

No Javadoc found

java.nio.file.Path logFile

No Javadoc found

boolean needsLogfile

No Javadoc found

java.util.List<RunCommandActionBuildItem> commands

No Javadoc found

Provides a way to register a io.quarkus.runtime.configuration.ConfigBuilder in RUNTIME.

Show more

java.lang.String builderClassName

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 ConfigItem#defaultValue() .

Show more

java.lang.String key

No Javadoc found

java.lang.String value

No Javadoc found

A build item that carries all the "fake" run time config objects for use by recorders.

Show more

java.util.Map<Class<?>,Object> objects

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 ShutdownContextBuildItem however it applies to tasks on the 'build' side, so if a processor wants to close something after the application has completed this item lets it do this. This has no effect for production applications, and is only useful in dev/test mode. The main use case for this is for shutting down deployment side test utilities at the end of a test run.

Show more

java.lang.Runnable closeTask

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

java.lang.String className

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

java.lang.String packageName

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

java.lang.String className

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

io.quarkus.bootstrap.app.SbomResult result

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 #providers() for reflection (instantiation only).

Show more

java.lang.String serviceInterface

No Javadoc found

java.util.List<String> providers

No Javadoc found

A symbolic class that represents a service start. StartupEvent is fired after all services are started.

Show more

java.lang.String name

No Javadoc found

A build item that can be used to register shutdown tasks in runtime recorders.

Show more

None

io.quarkus.runtime.shutdown.ShutdownListener shutdownListener

No Javadoc found

Allows extensions to set a default value for enabling SnapStart.

Show more

boolean defaultValue

No Javadoc found

Marker item to specify that SnapStart is enabled.

Show more

None

java.util.Optional<Boolean> enableSslNativeConfig

No Javadoc found

io.quarkus.deployment.recording.BytecodeRecorderImpl bytecodeRecorder

No Javadoc found

Provides a way to register a io.quarkus.runtime.configuration.ConfigBuilder in STATIC INIT.

Show more

java.lang.String builderClassName

No Javadoc found

A build item for adding the dev stream log via mutiny.

Show more

io.quarkus.runtime.RuntimeValue<Optional<Handler>> handlerValue

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 application.properties for a build-time only property and only provides the actual value on the command line when starting Quarkus. In such a case we don’t want the value set at build time to be revealed at runtime as it could be sensitive.

Show more

java.lang.String configKey

No Javadoc found

Represents a system property that will be set immediately on application startup.

Show more

java.lang.String key

No Javadoc found

java.lang.String value

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

java.lang.String annotationClassName

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

java.lang.String testClassName

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

java.util.function.Predicate<String> predicate

No Javadoc found

io.quarkus.deployment.dev.testing.TestListener listener

No Javadoc found

This is an optional build item that represents the current test profile. It is only available during tests.

Show more

java.lang.String testProfileClassName

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

java.util.concurrent.ThreadFactory threadFactory

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

java.util.Map<Path,Set<TransformedClass>> transformedClassesByJar

No Javadoc found

java.util.Map<Path,Set<String>> transformedFilesByJar

No Javadoc found

Ignore resources when building an Uber Jar

Show more

java.lang.String path

No Javadoc found

Merge duplicate resources from multiple JARs when building an Uber Jar

Show more

java.lang.String path

No Javadoc found

java.lang.String declaringClass

No Javadoc found

java.lang.String fieldName

No Javadoc found

Native-image might not be supported for a particular extension on a given OS or architecture.

Show more

io.quarkus.deployment.builditem.nativeimage.Os os

No Javadoc found

java.lang.String error

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

java.lang.String name

No Javadoc found

java.lang.String dbKind

No Javadoc found

java.util.Optional<String> dbVersion

No Javadoc found

boolean transactionIntegrationEnabled

No Javadoc found

boolean isDefault

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

java.util.Collection<String> datasourceNames

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

java.lang.String dbKind

No Javadoc found

java.lang.String driverClass

No Javadoc found

java.util.Optional<String> xaDriverClass

No Javadoc found

java.lang.String databaseName

No Javadoc found

java.util.function.Supplier<String> sqlSupplier

No Javadoc found

Marker build item that indicates that the OpenTelemetry extension has been initialized.

Show more

None

Amazon Lambda

Class Name

Attributes

java.lang.String handlerClass

No Javadoc found

java.lang.String name

No Javadoc found

boolean streamHandler

No Javadoc found

Amazon Lambda - Common Deployment

Class Name

Attributes

java.util.function.Supplier<MockEventServer> server

No Javadoc found

None

Handler provided by another extension i.e. AWS Lambda HTTP

Show more

java.lang.Class handlerClass

No Javadoc found

java.lang.String provider

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 ArcConfig#removeUnusedBeans is enabled. You can change the default behavior by setting the #removable to false and via Builder#setUnremovable() . An additional bean may have the scope defaulted via #defaultScope and Builder#setDefaultScope(DotName) . The default scope is only used if there is no scope declared on the bean class. The default scope should be used in cases where a bean class source is not controlled by the extension and the scope annotation cannot be declared directly on the class.

Generated Classes

This build item should never be produced for a generated class - GeneratedBeanBuildItem and GeneratedBeanGizmoAdaptor should be used instead.

Show more

java.util.List<String> beanClasses

No Javadoc found

boolean removable

No Javadoc found

org.jboss.jandex.DotName defaultScope

No Javadoc found

Make it possible to add, remove or alter annotations on various components. The provided transformer uses AnnotationsTransformer#appliesTo(AnnotationTarget.Kind) to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access io.quarkus.arc.processor.AnnotationStore to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won’t be able to see any changes made via AnnotationsTransformer !

Show more

org.jboss.jandex.AnnotationTransformation transformer

No Javadoc found

io.quarkus.arc.deployment.devui.DevBeanInfos beanInfos

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

io.quarkus.arc.deployment.MatchPredicate matchPredicate

No Javadoc found

boolean containerServicesRequired

No Javadoc found

org.jboss.jandex.DotName defaultScope

No Javadoc found

boolean unremovable

No Javadoc found

java.lang.String reason

No Javadoc found

int priority

No Javadoc found

java.util.function.BiConsumer<DotName,String> scopeAlreadyAdded

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 Inject is declared. @see AutoInjectFieldProcessor

Show more

java.util.List<DotName> annotationNames

No Javadoc found

Represent a Jandex IndexView on the whole deployment that has a complete CDI-related information. As such, this index should be used for any CDI-oriented work. Compared to io.quarkus.deployment.builditem.CombinedIndexBuildItem this index can contain additional classes that were indexed while bean discovery was in progress. @see GeneratedBeanBuildItem @see io.quarkus.deployment.builditem.CombinedIndexBuildItem

Show more

org.jboss.jandex.IndexView index

No Javadoc found

org.jboss.jandex.IndexView immutableIndex

No Javadoc found

java.util.Set<DotName> generatedClassNames

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

java.util.function.Predicate<ApplicationArchive> predicate

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

io.quarkus.arc.runtime.BeanContainer value

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 BeanContainer is provided to the listener. @see BeanContainerListener

Show more

io.quarkus.arc.runtime.BeanContainerListener beanContainerListener

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 ArcConfig#removeUnusedBeans is enabled.

Show more

org.jboss.jandex.DotName name

No Javadoc found

org.jboss.jandex.DotName defaultScope

No Javadoc found

boolean removable

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 SynthesisFinishedBuildItem instead. Additionally, the bean resolver can be used to apply the type-safe resolution rules, e.g. to find out whether there is a bean that would satisfy certain combination of required type and qualifiers. @see SynthesisFinishedBuildItem

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 BeanConfiguratorBuildItem or at least inject a BuildProducer for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after ArcProcessor#validate(BeanRegistrationPhaseBuildItem,List,BuildProducer) . @see BeanConfiguratorBuildItem @see BeanRegistrar

Show more

io.quarkus.arc.processor.BeanProcessor beanProcessor

No Javadoc found

io.quarkus.arc.processor.BeanRegistrar.RegistrationContext context

No Javadoc found

io.quarkus.arc.processor.bcextensions.ExtensionsEntryPoint entrypoint

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 IfBuildProfile , UnlessBuildProfile , IfBuildProperty and UnlessBuildProperty @see io.quarkus.arc.deployment.PreAdditionalBeanBuildTimeConditionBuildItem @see io.quarkus.arc.profile.IfBuildProfile @see io.quarkus.arc.profile.UnlessBuildProfile @see io.quarkus.arc.properties.IfBuildProperty @see io.quarkus.arc.properties.UnlessBuildProperty

Show more

java.util.Set<String> excludedDeclaringClasses

No Javadoc found

java.util.Set<String> excludedMethods

No Javadoc found

java.util.Set<String> excludedFields

No Javadoc found

org.jboss.jandex.AnnotationTarget target

No Javadoc found

boolean enabled

No Javadoc found

This build item hold the "final" predicate that is used to distinguish application classes from framework/library classes.

Show more

java.util.function.Predicate<DotName> applicationClassPredicate

No Javadoc found

Represents a mandatory config property that needs to be validated at runtime.

Show more

java.lang.String propertyName

No Javadoc found

org.jboss.jandex.Type propertyType

No Javadoc found

java.lang.String defaultValue

No Javadoc found

io.quarkus.runtime.ExecutionMode executionMode

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 ContextConfiguratorBuildItem or at least inject a BuildProducer for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after ArcProcessor#registerBeans(ContextRegistrationPhaseBuildItem,List,BuildProducer,BuildProducer,BuildProducer) . Typical workflow involves obtaining a ContextConfigurator via getContext().configure() . Note that there is no need to invoke ContextConfigurator#done() once you are done as it is performed automatically. @see ContextConfiguratorBuildItem @see CustomScopeBuildItem

Show more

io.quarkus.arc.processor.BeanProcessor beanProcessor

No Javadoc found

ContextRegistrar.RegistrationContext context

No Javadoc found

An extension can provide a custom CurrentContextFactory .

Show more

io.quarkus.runtime.RuntimeValue<CurrentContextFactory> factory

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

java.util.Set<DotName> customScopeNames

No Javadoc found

An extension that registers a custom CDI context via ContextRegistrationPhaseBuildItem should produce this build item in order to contribute the custom scope annotation name to the set of bean defining annotations. @see CustomScopeAnnotationsBuildItem @see ContextRegistrationPhaseBuildItem

Show more

org.jboss.jandex.DotName annotationName

No Javadoc found

This build item is used to specify types to be excluded from discovery. An element value can be:

  • a fully qualified class name, i.e. org.acme.Foo

  • a simple class name as defined by Class#getSimpleName() , i.e. Foo

  • a package name with suffix . , i.e. org.acme. , matches a package

  • a package name with suffix . , i.e. org.acme. , matches a package that starts with the value

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

java.lang.String match

No Javadoc found

A generated CDI bean. If this is produced then a io.quarkus.deployment.builditem.GeneratedClassBuildItem should not be produced for the same class, as Arc will take care of this.

Show more

java.lang.String name

No Javadoc found

byte[] data

No Javadoc found

java.lang.String source

No Javadoc found

Allows extensions to programmatically exclude certain packages from split package detection which is executed by SplitPackageProcessor . Extensions are encouraged to solve split package issues and this build item should be used primarily as temporary workaround. A package string representation can be:

  • a full name of the package, i.e. org.acme.foo

  • a package name with suffix . , i.e. org.acme. , which matches a package that starts with provided value

Show more

java.util.Collection<String> excludedPackages

No Javadoc found

Make it possible to programmatically modify qualifiers on an injection point.

Show more

io.quarkus.arc.processor.InjectionPointsTransformer transformer

No Javadoc found

Represents an intercepted static method.

Show more

org.jboss.jandex.MethodInfo method

No Javadoc found

java.util.List<InterceptorInfo> interceptors

No Javadoc found

java.util.Set<AnnotationInstance> bindings

No Javadoc found

java.lang.String hash

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 jakarta.interceptor.InterceptorBinding .

Show more

io.quarkus.arc.processor.InterceptorBindingRegistrar registrar

No Javadoc found

Holds a reference to the interceptor resolver.

Show more

io.quarkus.arc.processor.InterceptorResolver resolver

No Javadoc found

java.util.Set<DotName> interceptorBindings

No Javadoc found

io.quarkus.arc.processor.BeanDeployment beanDeployment

No Javadoc found

Provides access to InvokerFactory . May only be used in the bean registration phase, observer registration phase, and validation phase (basically, until ArC generates the classes). Afterwards, any attempt to call #createInvoker(BeanInfo,MethodInfo) throws an exception.

Show more

io.quarkus.arc.processor.BeanDeployment beanDeployment

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 beans.xml defines a bean discovery mode of all ; bean archives with discovery mode of none or annotated are always compatible. If a bean archive is known to be compatible with Quarkus, no warning about all discovery is logged during application build.

Show more

java.lang.String groupId

No Javadoc found

java.lang.String artifactId

No Javadoc found

java.lang.String classifier

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 ObserverConfiguratorBuildItem or at least inject a BuildProducer for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after ArcProcessor#validate(ObserverRegistrationPhaseBuildItem,List) . @see ObserverConfiguratorBuildItem @see ObserverRegistrar

Show more

io.quarkus.arc.processor.BeanProcessor beanProcessor

No Javadoc found

io.quarkus.arc.processor.ObserverRegistrar.RegistrationContext context

No Javadoc found

This build item is used to register an ObserverTransformer instance.

Show more

io.quarkus.arc.processor.ObserverTransformer transformer

No Javadoc found

A build item that represents the fully initialized CDI bean container. This item is produced immediately before BeanContainerBuildItem in order to give recorders the chance to do something immediately before real recording steps come into play.

Show more

io.quarkus.arc.runtime.BeanContainer value

No Javadoc found

Makes it possible to register annotations that should be considered qualifiers but are not annotated with jakarta.inject.Qualifier .

Show more

io.quarkus.arc.processor.QualifierRegistrar registrar

No Javadoc found

This build item instructs ArC to produce a ReflectiveClassBuildItem for a client proxy and intercepted subclass generated for the given bean class.

Show more

org.jboss.jandex.DotName className

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 BeanDiscoveryFinishedBuildItem and SynthesisFinishedBuildItem

Show more

java.util.Collection<BeanInfo> beans

No Javadoc found

java.util.Collection<InjectionPointInfo> injectionPoints

No Javadoc found

java.util.Collection<ObserverInfo> observers

No Javadoc found

io.quarkus.arc.processor.BeanResolver beanResolver

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

org.jboss.jandex.DotName name

No Javadoc found

Makes it possible to register annotations that should be considered stereotypes but are not annotated with jakarta.enterprise.inject.Stereotype .

Show more

io.quarkus.arc.processor.StereotypeRegistrar registrar

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 BeanDiscoveryFinishedBuildItem instead. Additionally, the bean resolver can be used to apply the type-safe resolution rules, e.g. to find out whether there is a bean that would satisfy certain combination of required type and qualifiers. @see BeanDiscoveryFinishedBuildItem

Show more

None

Makes it possible to register a synthetic bean. Bean instances can be easily produced through a recorder and set via ExtendedBeanConfigurator#supplier(Supplier) , ExtendedBeanConfigurator#runtimeValue(RuntimeValue) , ExtendedBeanConfigurator#createWith(Function) and ExtendedBeanConfigurator#runtimeProxy(Object) . @see ExtendedBeanConfigurator @see BeanRegistrar

Show more

io.quarkus.arc.deployment.ExtendedBeanConfigurator configurator

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

io.quarkus.arc.processor.BeanDeployment beanDeployment

No Javadoc found

This build item is used to exclude beans that would be normally removed if the config property ArcConfig#removeUnusedBeans is set to true. Consider using one of the convenient static factory methods such as #beanTypes(Class…​) : ` @BuildStep UnremovableBeanBuildItem unremovable() { // Any bean that has MyService in its set of bean types is considered unremovable return UnremovableBeanBuildItem.beanTypes(MyService.class); }

 &#64;BuildStep UnremovableBeanBuildItem unremovable() { // A bean whose bean class FQCN is equal to org.acme.MyService is considered unremovable return new UnremovableBeanBuildItem(new BeanClassNameExclusion("org.acme.MyService")); }

Show more

java.util.function.Predicate<BeanInfo> predicate

No Javadoc found

java.util.Set<String> classNames

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 ValidationErrorBuildItem or at least inject a BuildProducer for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after ArcProcessor#generateResources(io.quarkus.arc.runtime.ArcRecorder,io.quarkus.deployment.builditem.ShutdownContextBuildItem,ValidationPhaseBuildItem,List,List,BuildProducer,BuildProducer,BuildProducer,BuildProducer,BuildProducer) . @see ValidationErrorBuildItem

Show more

io.quarkus.arc.processor.BeanProcessor beanProcessor

No Javadoc found

BeanDeploymentValidator.ValidationContext context

No Javadoc found

Azure Functions

Class Name

Attributes

java.lang.String functionName

No Javadoc found

java.lang.Class declaring

No Javadoc found

java.lang.reflect.Method method

No Javadoc found

java.lang.String appName

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

java.util.Set<String> names

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

java.lang.String name

No Javadoc found

A build item that makes sure a CacheManagerInfo is available at runtime for consideration as the cache backend

Show more

io.quarkus.cache.CacheManagerInfo info

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

io.quarkus.cache.deployment.spi.Type type

No Javadoc found

Container Image - SPI

Class Name

Attributes

java.lang.String name

No Javadoc found

java.lang.String image

No Javadoc found

None

A MultiBuildItem that represents eligible container image builders. Some extension have a dependency on external services (e.g. openshift and s2i). So, the presence of the extension alone is not enough to let the build system know that extension is usable. This build item is produced only when all environment requirements are met.

Show more

java.lang.String builder

No Javadoc found

This BuildItem can be used to override the default image name. It can be used in cases where the name of the image is customized externally. Example: The openshift extension may override the name. To ensure that things are in sync with the image name needs to be set.

Show more

java.lang.String name

No Javadoc found

java.util.Optional<String> registry

The container registry to use

java.util.Optional<String> username

No Javadoc found

java.util.Optional<String> password

No Javadoc found

java.lang.String imagePrefix

No Javadoc found

java.lang.String repository

No Javadoc found

java.lang.String tag

No Javadoc found

java.util.Set<String> additionalTags

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

java.lang.String name

No Javadoc found

java.lang.String value

No Javadoc found

None

java.lang.String registry

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

java.lang.String dbKind

No Javadoc found

java.lang.Class<?> callerClass

No Javadoc found

java.lang.String scope

No Javadoc found

A handler that can map an automatic datasource to the relevant config properties.

Show more

java.lang.String dbKind

The type of database this is for

java.util.function.BiFunction<String,DevServicesDatasourceProvider.RunningDevServicesDatasource,Map<String,String>> configProviderFunction

The function that provides the runtime config given a running DevServices database

java.util.function.Predicate<String> checkConfiguredFunction

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

java.lang.String database

No Javadoc found

io.quarkus.datasource.deployment.spi.DevServicesDatasourceProvider devDBProvider

No Javadoc found

java.util.Map<String,DbResult> dataSources

No Javadoc found

DevServices - Keycloak

Class Name

Attributes

java.util.Map<String,String> config

No Javadoc found

java.util.Map<String,Object> properties

No Javadoc found

boolean containerRestarted

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

io.quarkus.devservices.keycloak.Capability capability

No Javadoc found

Elasticsearch REST client common

Class Name

Attributes

java.lang.String hostsConfigProperty

No Javadoc found

java.lang.String version

No Javadoc found

io.quarkus.elasticsearch.restclient.common.deployment.ElasticsearchCommonBuildTimeConfig.ElasticsearchDevServicesBuildTimeConfig.Distribution distribution

No Javadoc found

Elytron Security

Class Name

Attributes

None

None

This represents a {@linkplain SecurityDomain} instance output by a build step.

Show more

io.quarkus.runtime.RuntimeValue<SecurityDomain> securityDomain

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

io.quarkus.runtime.RuntimeValue<SecurityRealm> realm

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.Runnable runtimeLoadTask

No Javadoc found

Funqy Server Common

Class Name

Attributes

java.lang.String className

No Javadoc found

java.lang.String methodName

No Javadoc found

java.lang.String descriptor

No Javadoc found

java.lang.String functionName

No Javadoc found

None

gRPC

Class Name

Attributes

java.lang.String interceptorClass

No Javadoc found

org.jboss.jandex.DotName serviceClass

No Javadoc found

java.util.List<String> blockingMethods

No Javadoc found

java.util.List<String> virtualMethods

No Javadoc found

org.jboss.jandex.ClassInfo generatedBean

No Javadoc found

org.jboss.jandex.ClassInfo userDefinedBean

No Javadoc found

java.lang.String clientName

No Javadoc found

java.util.Set<ClientInfo> clients

No Javadoc found

Hibernate ORM

Class Name

Attributes

java.lang.String integrationName

No Javadoc found

java.lang.String persistenceUnitName

No Javadoc found

io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationRuntimeInitListener initListener

No Javadoc found

java.lang.String integrationName

No Javadoc found

java.lang.String persistenceUnitName

No Javadoc found

io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationStaticInitListener initListener

No Javadoc found

boolean xmlMappingRequired

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

boolean shouldGenerateOne

No Javadoc found

Internal model to represent which objects are likely needing enhancement via HibernateEntityEnhancer.

Show more

java.util.Set<String> allModelPackageNames

No Javadoc found

java.util.Set<String> entityClassNames

No Javadoc found

java.util.Set<String> managedClassNames

No Javadoc found

java.util.Set<DotName> potentialCdiBeanClassNames

No Javadoc found

java.util.Set<String> allModelClassNames

No Javadoc found

java.util.Map<String,List<RecordableXmlMapping>> xmlMappingsByPU

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

org.jboss.jandex.CompositeIndex index

No Javadoc found

Provides configuration specific to a persistence unit and necessary to build the JPA model.

Show more

java.lang.String persistenceUnitName

No Javadoc found

java.net.URL persistenceUnitRootURL

No Javadoc found

java.util.Set<String> explicitlyListedClassNames

No Javadoc found

java.util.Set<String> explicitlyListedMappingFiles

No Javadoc found

Internal model to hold the mapping linking a JPA entity to its corresponding persistence units.

Show more

java.util.Map<String,Set<String>> entityToPersistenceUnits

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

io.quarkus.hibernate.orm.runtime.boot.QuarkusPersistenceUnitDescriptor descriptor

No Javadoc found

io.quarkus.hibernate.orm.runtime.recording.RecordedConfig config

No Javadoc found

java.lang.String multiTenancySchemaDataSource

No Javadoc found

java.util.List<RecordableXmlMapping> xmlMappings

No Javadoc found

boolean isReactive

No Javadoc found

boolean fromPersistenceXml

No Javadoc found

java.util.Optional<FormatMapperKind> jsonMapper

No Javadoc found

java.util.Optional<FormatMapperKind> xmlMapper

No Javadoc found

Provides instances of ParsedPersistenceXmlDescriptor , the raw representation of a persistence.xml file as it is after being located and parsed. Exposed as a possible integration API: other extensions can produce additional configuration instances. @author Sanne Grinovero <sanne@hibernate.org>

Show more

org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor descriptor

No Javadoc found

Hibernate ORM - SPI

Class Name

Attributes

Additional Jpa model class that we need to index @author Stéphane Épardaud

Show more

java.lang.String className

No Javadoc found

An Hibernate Dialect associated with a database kind.

Show more

java.lang.String dbKind

No Javadoc found

java.util.Optional<String> databaseProductName

No Javadoc found

java.util.Optional<String> dialect

No Javadoc found

java.util.Set<String> matchingDialects

No Javadoc found

java.util.Optional<String> defaultDatabaseProductVersion

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

java.lang.String entityClass

No Javadoc found

java.lang.String persistenceUnitName

No Javadoc found

Represents a regular Panache entity class.

Show more

org.jboss.jandex.ClassInfo entityClass

No Javadoc found

Hibernate Reactive with Panache

Class Name

Attributes

org.jboss.jandex.ClassInfo entityClass

No Javadoc found

Hibernate Search - ORM + Elasticsearch

Class Name

Attributes

java.lang.String persistenceUnitName

No Javadoc found

io.quarkus.hibernate.search.orm.elasticsearch.runtime.HibernateSearchElasticsearchBuildTimeConfigPersistenceUnit buildTimeConfig

No Javadoc found

java.util.Set<String> backendNamesForIndexedEntities

No Javadoc found

java.util.Map<String,Set<String>> backendAndIndexNamesForSearchExtensions

No Javadoc found

java.lang.String integrationName

No Javadoc found

java.lang.String persistenceUnitName

No Javadoc found

io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationRuntimeInitListener initListener

No Javadoc found

java.lang.String integrationName

No Javadoc found

java.lang.String persistenceUnitName

No Javadoc found

io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationStaticInitListener initListener

No Javadoc found

boolean xmlMappingRequired

No Javadoc found

Hibernate Search - Standalone + Elasticsearch

Class Name

Attributes

java.util.Set<String> backendNamesForIndexedEntities

No Javadoc found

java.util.Map<String,Set<String>> backendAndIndexNamesForSearchExtensions

No Javadoc found

java.util.Set<String> rootAnnotationMappedClassNames

No Javadoc found

Hibernate Validator - SPI

Class Name

Attributes

java.lang.Class<?> clazz

No Javadoc found

java.lang.String name

No Javadoc found

byte[] bytes

No Javadoc found

BuildItem used to publish the list of detected Bean Validation annotations for consumption by other extensions.

Show more

org.jboss.jandex.DotName valid

No Javadoc found

java.util.Set<DotName> constraints

No Javadoc found

java.util.Set<DotName> all

No Javadoc found

Infinispan - Client

Class Name

Attributes

Provide the Infinispan clients as RuntimeValue’s.

Show more

io.quarkus.runtime.RuntimeValue<RemoteCacheManager> client

No Javadoc found

java.lang.String name

No Javadoc found

Represents the values of the io.quarkus.infinispan.client.InfinispanClientName .

Show more

java.lang.String name

No Javadoc found

java.util.Map<String,Properties> properties

No Javadoc found

java.util.Properties properties

No Javadoc found

java.util.Map<String,Object> marshallers

No Javadoc found

Info - SPI

Class Name

Attributes

Allows for extensions to include their own InfoContributor implementations that result in inclusion of properties in the info endpoint

Show more

io.quarkus.info.runtime.spi.InfoContributor infoContributor

No Javadoc found

Allows for extensions to include their properties into the info endpoint

Show more

java.lang.String name

No Javadoc found

java.util.Map<String,Object> value

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

java.util.List<DotName> dotNames

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

java.lang.String moduleClassName

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

java.lang.String name

No Javadoc found

java.util.Collection<Item> items

No Javadoc found

Jakarta REST Client

Class Name

Attributes

BuildItem to register a JaxrsClientReactiveEnricher

Show more

io.quarkus.jaxrs.client.reactive.deployment.JaxrsClientReactiveEnricher enricher

No Javadoc found

java.lang.String defaultMediaType

No Javadoc found

int priority

No Javadoc found

java.lang.String defaultMediaType

No Javadoc found

int priority

No Javadoc found

JAX-RS - SPI

Class Name

Attributes

java.util.List<DotName> annotationClasses

No Javadoc found

JAXB

Class Name

Attributes

List of classes to be bound in the JAXB context. Aggregates all classes passed via JaxbClassesToBeBoundBuildItem . All class names excluded via quarkus.jaxb.exclude-classes are not present in this list.

Show more

java.util.List<Class<?>> classes

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 quarkus.jaxb.exclude-classes . @see FilteredJaxbClassesToBeBoundBuildItem

Show more

java.util.List<String> classes

No Javadoc found

A location that should be scanned for jaxb.index files

Show more

java.lang.String fileRoot

No Javadoc found

JMS - SPI

Class Name

Attributes

A build item that can be used to wrap the JMS ConnectionFactory

Show more

java.util.function.Function<ConnectionFactory,Object> wrapper

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

java.util.Collection<String> deserializerClassNames

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

java.util.Collection<String> serializerClassNames

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

java.lang.Object configurationSupplier

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

java.lang.Object configurator

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 KubernetesOutputDirBuildItem as it’s used to communicate the intention to override the dir while KubernetesOutputDirBuildItem is used to communicate the effective output dir.

Show more

java.nio.file.Path outputDir

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

java.nio.file.Path root

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

java.lang.String group

The group the decorator will be applied to.

java.lang.Object decorator

The decorator

Produce this build item to expose the Dekorate project and Dekorate session.

Show more

java.lang.Object project

No Javadoc found

java.lang.Object session

No Javadoc found

java.util.List<String> generatedFiles

No Javadoc found

Represents a resource generated by the quarkus-kubernetes extension

Show more

java.lang.String name

No Javadoc found

byte[] content

No Javadoc found

java.lang.String key

No Javadoc found

java.lang.String value

No Javadoc found

java.lang.String target

No Javadoc found

Produce this build item to request the Kubernetes extension to generate a Kubernetes ClusterRoleBinding resource. The configuration here is limited; in particular, you can’t specify subjects of the role binding. The role will always be bound to the application’s service account.

Show more

java.lang.String name

Name of the generated RoleBinding resource. Can be null , in which case the resource name is autogenerated.

io.quarkus.kubernetes.spi.RoleRef roleRef

RoleRef configuration.

io.quarkus.kubernetes.spi.Subject[] subjects

The target subjects.

java.util.Map<String,String> labels

The labels of the cluster role resource.

Produce this build item to request the Kubernetes extension to generate a Kubernetes ClusterRole resource.

Show more

java.lang.String name

Name of the generated ClusterRole resource.

java.util.List<PolicyRule> rules

The PolicyRule resources for this ClusterRole .

java.util.List<String> command

No Javadoc found

java.util.List<String> args

No Javadoc found

java.lang.String kind

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 mergeList method to get a new list with merged items. Furthermore, if priorities need to be taken into account, the merged list should also be sorted

Show more

java.lang.String name

No Javadoc found

java.lang.String kind

No Javadoc found

java.lang.String group

No Javadoc found

java.lang.String version

No Javadoc found

int priority

No Javadoc found

boolean enabled

No Javadoc found

io.quarkus.kubernetes.spi.DeployStrategy deployStrategy

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

java.lang.String serviceAccountName

No Javadoc found

java.lang.String namespace

No Javadoc found

boolean wasSet

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String value

No Javadoc found

java.lang.String configmap

No Javadoc found

java.lang.String secret

No Javadoc found

java.lang.String field

No Javadoc found

io.quarkus.kubernetes.spi.EnvType type

No Javadoc found

boolean oldStyle

No Javadoc found

java.lang.String prefix

No Javadoc found

java.lang.String path

No Javadoc found

java.lang.String path

No Javadoc found

java.lang.String path

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

java.lang.String name

No Javadoc found

java.lang.String target

No Javadoc found

java.lang.String image

No Javadoc found

java.util.List<String> command

No Javadoc found

java.util.List<String> arguments

No Javadoc found

java.util.Map<String,String> envVars

No Javadoc found

boolean sharedEnvironment

No Javadoc found

boolean sharedFilesystem

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

java.lang.String name

No Javadoc found

java.lang.String target

No Javadoc found

java.lang.String image

No Javadoc found

java.util.List<String> command

No Javadoc found

java.util.List<String> arguments

No Javadoc found

java.util.Map<String,String> envVars

No Javadoc found

boolean sharedEnvironment

No Javadoc found

boolean sharedFilesystem

No Javadoc found

java.lang.String key

No Javadoc found

java.lang.String value

No Javadoc found

java.lang.String target

No Javadoc found

java.lang.String namespace

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

java.lang.String apiVersion

No Javadoc found

java.lang.String kind

No Javadoc found

Contains the effective output directory where to find the generated kubernetes resources.

Show more

java.nio.file.Path outputDirectory

No Javadoc found

int port

No Javadoc found

java.lang.String name

No Javadoc found

boolean enabled

Indicates when the port is enabled vs simply configured. For example the presence quarkus.http.ssl-port also is not enought to tell us if enabled. Still, we need to communicate its value and let quarkus-kubernetes extension decide.

java.util.Optional<Property<Integer>> source

No Javadoc found

A build item for selecting which port to use for probes using an {@literal HTTP get} action.

Show more

java.lang.String name

No Javadoc found

java.lang.String scheme

No Javadoc found

java.lang.String group

No Javadoc found

java.lang.String version

No Javadoc found

java.lang.String kind

No Javadoc found

java.lang.String name

No Javadoc found

Produce this build item to request the Kubernetes extension to generate a Kubernetes RoleBinding resource. Use KubernetesClusterRoleBindingBuildItem to generate a ClusterRoleBinding .

Show more

java.lang.String name

Name of the generated RoleBinding resource. Can be null , in which case the resource name is autogenerated.

java.lang.String namespace

No Javadoc found

io.quarkus.kubernetes.spi.RoleRef roleRef

RoleRef configuration.

io.quarkus.kubernetes.spi.Subject[] subjects

The target subjects.

java.util.Map<String,String> labels

The labels of the cluster role resource.

Produce this build item to request the Kubernetes extension to generate a Kubernetes Role resource. Note that this can’t be used to generate a ClusterRole .

Show more

java.lang.String name

Name of the generated Role resource.

java.lang.String namespace

Namespace of the generated Role resource.

java.util.List<PolicyRule> rules

The PolicyRule resources for this Role .

Produce this build item to request the Kubernetes extension to generate a Kubernetes ServiceAccount resource.

Show more

java.lang.String name

Name of the generated ServiceAccount resource.

java.lang.String namespace

Namespace of the generated ServiceAccount resource.

java.util.Map<String,String> labels

Labels of the generated ServiceAccount resource.

boolean useAsDefault

If true, this service account will be used in the generated Deployment resources.

Kubernetes - Vanilla

Class Name

Attributes

java.util.List<DeploymentTargetEntry> entriesSortedByPriority

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

io.quarkus.kubernetes.deployment.DeploymentTargetEntry entry

No Javadoc found

Kubernetes Client - SPI

Class Name

Attributes

io.fabric8.kubernetes.client.Config config

No Javadoc found

HttpClient.Factory httpClientFactory

No Javadoc found

boolean generateRbac

No Javadoc found

java.lang.String[] resourceClasses

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

java.lang.String id

No Javadoc found

java.lang.String kind

No Javadoc found

java.lang.String name

No Javadoc found

Build item that describes a kubernetes resource that the application needs to bind to.

Show more

java.lang.String binding

No Javadoc found

java.lang.String apiVersion

No Javadoc found

java.lang.String kind

No Javadoc found

java.lang.String name

No Javadoc found

Messaging

Class Name

Attributes

Represents an application channel. These channels can be declared using @Incoming , @Outgoing or injected Emitter , and @Channel .

Show more

java.lang.String name

No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.ChannelDirection direction

No Javadoc found

java.lang.String connector

No Javadoc found

Represents a reactive messaging connector. It contains the name (like smallrye-kafka ), the direction (incoming or outgoing), and the list of connector attributes (mainly for documentation and tooling purpose).

Show more

java.lang.String name

No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.ChannelDirection direction

No Javadoc found

java.util.List<ConnectorAttribute> attributes

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String connector

No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.ChannelDirection direction

No Javadoc found

java.lang.String name

The name of the channel.

java.lang.String name

The name of the stream the emitter is connected to.

java.lang.String overflow

The name of the overflow strategy. Valid values are BUFFER, DROP, FAIL, LATEST, NONE . If not set, it uses BUFFER with a default buffer size.

int bufferSize

The buffer size, used when overflow is set to BUFFER . Not that if overflow is set to BUFFER and bufferSize is not set, an unbounded buffer is used.

boolean hasBroadcast

Whether the emitter uses the io.smallrye.reactive.messaging.annotations.Broadcast annotation.

java.lang.String emitterType

The emitter type

int awaitSubscribers

If the emitter uses the io.smallrye.reactive.messaging.annotations.Broadcast annotation, indicates the number of subscribers to be expected before subscribing upstream.

Represents a method annotated with @Incoming or / and Outgoing .

Show more

io.quarkus.arc.processor.BeanInfo bean

No Javadoc found

org.jboss.jandex.MethodInfo method

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

java.lang.String name

No Javadoc found

io.quarkus.smallrye.reactivemessaging.deployment.items.ChannelDirection direction

No Javadoc found

Micrometer

Class Name

Attributes

java.lang.Class<? extends MeterRegistry> clazz

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String path

No Javadoc found

io.quarkus.runtime.RuntimeValue<MeterRegistry> value

No Javadoc found

MongoDB Client

Class Name

Attributes

Register additional BsonDiscriminator’s for the MongoDB clients.

Show more

java.util.List<String> bsonDiscriminatorClassNames

No Javadoc found

Register additional CodecProvider s for the MongoDB clients.

Show more

java.util.List<String> codecProviderClassNames

No Javadoc found

Register additional CommandListener s for the MongoDB clients.

Show more

java.util.List<String> commandListenerClassNames

No Javadoc found

Register additional ReactiveContextProvider s for the MongoDB clients.

Show more

java.util.List<String> classNames

No Javadoc found

Provide the MongoDB clients as RuntimeValue’s.

Show more

io.quarkus.runtime.RuntimeValue<MongoClient> client

No Javadoc found

io.quarkus.runtime.RuntimeValue<ReactiveMongoClient> reactive

No Javadoc found

java.lang.String name

No Javadoc found

Represents the values of the MongoClientName .

Show more

java.lang.String name

No Javadoc found

boolean addQualifier

No Javadoc found

Register additional ConnectionPoolListener s.

Show more

java.util.function.Supplier<ConnectionPoolListener> connectionPoolListener

No Javadoc found

If generated, all the Mongo clients need to be unremovable

Show more

None

Register additional PropertyCodecProvider s for the MongoDB clients.

Show more

java.util.List<String> propertyCodecProviderClassNames

No Javadoc found

MongoDB with Panache - Common Deployment

Class Name

Attributes

Represents a regular Panache entity class.

Show more

org.jboss.jandex.ClassInfo entityClass

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

java.util.function.Supplier<EventLoopGroup> bossEventLoopGroup

No Javadoc found

java.util.function.Supplier<EventLoopGroup> mainEventLoopGroup

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

java.util.function.Supplier<EventLoopGroup> mainSupplier

No Javadoc found

java.util.function.Supplier<EventLoopGroup> bossSupplier

No Javadoc found

Build item to specify the minimal required io.netty.allocator.maxOrder. Quarkus by default uses maxOrder == 1. Extensions that require a larger value can use this build item to specify it.

Show more

int maxOrder

No Javadoc found

Observability Dev Services

Class Name

Attributes

Build item used to carry running DevService values to Dev UI.

Show more

java.util.Map<String,String> config

No Javadoc found

OpenID Connect Client

Class Name

Attributes

Represents one io.quarkus.oidc.token.propagation.AccessToken annotation instance.

Show more

java.lang.String clientName

No Javadoc found

boolean tokenExchange

No Javadoc found

org.jboss.jandex.AnnotationTarget annotationTarget

No Javadoc found

Contains non-default names of OIDC Clients.

Show more

java.util.Set<String> oidcClientNames

No Javadoc found

OpenTelemetry

Class Name

Attributes

java.util.List<String> dropNames

No Javadoc found

java.util.List<String> dropNames

No Javadoc found

Build item to be used by Quarkiverse exporters to register themselves as an external exporter.

Show more

java.lang.String exporterName

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

java.util.Set<String> entityClasses

No Javadoc found

Build item to declare that a PanacheMethodCustomizer should be used on Panache-enhanced methods.

Show more

io.quarkus.panache.common.deployment.PanacheMethodCustomizer methodCustomizer

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

io.quarkus.panache.common.deployment.MetamodelInfo metamodelInfo

No Javadoc found

java.util.Set<String> managedClassNames

No Javadoc found

Qute

Class Name

Attributes

io.quarkus.qute.deployment.CheckedTemplateAdapter adapter

No Javadoc found

Represents a method of a class annotated with CheckedTemplate or a Java record that implements TemplateInstance .

Show more

java.lang.String templateId

No Javadoc found

java.lang.String fragmentId

No Javadoc found

java.util.Map<String,String> bindings

No Javadoc found

boolean requireTypeSafeExpressions

No Javadoc found

org.jboss.jandex.MethodInfo method

No Javadoc found

org.jboss.jandex.ClassInfo recordClass

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

java.util.Collection<Pattern> locationPatterns

No Javadoc found

Holds a name of a generated io.quarkus.qute.ValueResolver class.

Show more

java.lang.String className

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 TemplateData . If the specified class is also annotated with TemplateData the build item is ignored. If multiple build items are produced for one class and the synthetic template data is not equal the build fails. @see TemplateData @see TemplateDataBuilder

Show more

org.jboss.jandex.ClassInfo clazz

No Javadoc found

org.jboss.jandex.AnnotationInstance templateData

No Javadoc found

java.lang.String expression

No Javadoc found

java.lang.String property

No Javadoc found

java.lang.String clazz

No Javadoc found

io.quarkus.qute.TemplateNode.Origin origin

No Javadoc found

java.lang.String reason

No Javadoc found

java.lang.String name

No Javadoc found

org.jboss.jandex.ClassInfo defaultBundleInterface

No Javadoc found

java.util.Map<String,ClassInfo> localizedInterfaces

No Javadoc found

java.util.Map<String,Path> localizedFiles

No Javadoc found

java.util.Map<String,Path> mergeCandidates

No Javadoc found

java.lang.String defaultLocale

No Javadoc found

Represents a message bundle method. Note that templates that contain no expressions/sections don’t need to be validated.

Show more

java.lang.String bundleName

No Javadoc found

java.lang.String key

No Javadoc found

java.lang.String templateId

No Javadoc found

org.jboss.jandex.MethodInfo method

No Javadoc found

java.lang.String template

No Javadoc found

boolean isDefaultBundle

No Javadoc found

org.jboss.jandex.ClassInfo targetClass

No Javadoc found

java.lang.String namespace

No Javadoc found

java.lang.String[] ignore

No Javadoc found

java.util.regex.Pattern[] ignorePatterns

No Javadoc found

boolean ignoreSuperclasses

No Javadoc found

boolean properties

No Javadoc found

org.jboss.jandex.AnnotationInstance annotationInstance

No Javadoc found

Represents a template extension method. @see TemplateExtension

Show more

org.jboss.jandex.MethodInfo method

No Javadoc found

java.lang.String matchName

No Javadoc found

java.util.List<String> matchNames

No Javadoc found

java.lang.String matchRegex

No Javadoc found

java.util.regex.Pattern matchPattern

No Javadoc found

org.jboss.jandex.Type matchType

No Javadoc found

int priority

No Javadoc found

java.lang.String namespace

No Javadoc found

io.quarkus.qute.generator.ExtensionMethodGenerator.Parameters params

No Javadoc found

Holds all template file paths, including the versions without suffixes configured via QuteConfig#suffixes . For example, for the template items.html the set will contain items.html and items .

Show more

java.util.Set<String> filePaths

No Javadoc found

Represents a global variable field/method. @see TemplateGlobal

Show more

java.lang.String name

No Javadoc found

org.jboss.jandex.AnnotationTarget target

No Javadoc found

org.jboss.jandex.Type variableType

No Javadoc found

java.lang.String className

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

java.lang.String path

No Javadoc found

java.lang.String content

No Javadoc found

java.nio.file.Path fullPath

No Javadoc found

java.lang.String extensionInfo

No Javadoc found

This build item represents a source of template files. By default, the templates are found in the templates directory. However, an extension can produce this build item to register an additional root path. The path is relative to the artifact/project root and OS-agnostic, i.e. / is used as a path separator.

Show more

java.lang.String path

No Javadoc found

The set of template root paths.

Show more

java.util.Set<String> rootPaths

No Javadoc found

Holds all template variants found.

Show more

java.util.Map<String,List<String>> variants

No Javadoc found

Represents the result of analysis of all templates.

Show more

java.util.List<TemplateAnalysis> analysis

No Javadoc found

Makes it possible to intentionally ignore some parts of an expression when performing type-safe validation. @see TypeCheck

Show more

java.util.function.Predicate<TypeCheck> predicate

No Javadoc found

boolean extensionMethodPredicate

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

java.util.function.Consumer<ParserHelper> hook

No Javadoc found

Reactive DB2 Client

Class Name

Attributes

java.lang.String dataSourceName

No Javadoc found

java.util.function.Function<SyntheticCreationalContext<DB2Pool>,DB2Pool> db2Pool

No Javadoc found

Reactive Microsoft SQL Server Client

Class Name

Attributes

java.lang.String dataSourceName

No Javadoc found

java.util.function.Function<SyntheticCreationalContext<MSSQLPool>,MSSQLPool> mssqlPool

No Javadoc found

Reactive MySQL Client

Class Name

Attributes

java.lang.String dataSourceName

No Javadoc found

java.util.function.Function<SyntheticCreationalContext<MySQLPool>,MySQLPool> mysqlPool

No Javadoc found

Reactive Oracle Client

Class Name

Attributes

java.lang.String dataSourceName

No Javadoc found

java.util.function.Function<SyntheticCreationalContext<OraclePool>,OraclePool> oraclePool

No Javadoc found

Reactive PostgreSQL Client

Class Name

Attributes

java.lang.String dataSourceName

No Javadoc found

java.util.function.Function<SyntheticCreationalContext<PgPool>,PgPool> pgPool

No Javadoc found

Reactive Routes

Class Name

Attributes

io.quarkus.arc.processor.BeanInfo bean

No Javadoc found

org.jboss.jandex.AnnotationInstance routeFilter

No Javadoc found

org.jboss.jandex.MethodInfo method

No Javadoc found

io.quarkus.arc.processor.BeanInfo bean

No Javadoc found

java.util.List<AnnotationInstance> routes

No Javadoc found

org.jboss.jandex.AnnotationInstance routeBase

No Javadoc found

org.jboss.jandex.MethodInfo method

No Javadoc found

boolean blocking

No Javadoc found

io.quarkus.vertx.http.runtime.HttpCompression compression

No Javadoc found

boolean alwaysAuthenticateRoute

If true, always attempt to authenticate user right before the body handler is run

Redis Client

Class Name

Attributes

io.quarkus.runtime.RuntimeValue<ObservableRedisMetrics> metrics

No Javadoc found

Request the creation of the Redis client with the given name.

Show more

java.lang.String name

No Javadoc found

REST

Class Name

Attributes

java.lang.String readerClassName

No Javadoc found

java.lang.String overrideClassName

No Javadoc found

org.jboss.resteasy.reactive.server.model.ContextResolvers contextResolvers

No Javadoc found

A marker build item signifying that observability features have been integrated

Show more

None

org.jboss.resteasy.reactive.server.core.RequestContextFactory factory

No Javadoc found

io.quarkus.runtime.RuntimeValue<Deployment> deployment

No Javadoc found

java.lang.String applicationPath

No Javadoc found

org.jboss.resteasy.reactive.server.core.DeploymentInfo deploymentInfo

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

java.util.List<Entry> entries

No Javadoc found

org.jboss.resteasy.reactive.server.core.ServerSerialisers serialisers

No Javadoc found

java.util.List<ResourceClass> resourceClasses

No Javadoc found

java.util.List<ResourceClass> subResourceClasses

No Javadoc found

org.jboss.resteasy.reactive.common.processor.AdditionalReaders additionalReaders

No Javadoc found

org.jboss.resteasy.reactive.common.processor.AdditionalWriters additionalWriters

No Javadoc found

REST - Common

Class Name

Attributes

java.util.Set<DotName> classNames

This contains all the parameter containers (bean param classes and records) as well as resources/endpoints

java.util.Set<DotName> nonRecordClassNames

This contains all the non-record parameter containers (bean param classes only) as well as resources/endpoints

org.jboss.resteasy.reactive.common.processor.scanning.ApplicationScanningResult result

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

org.jboss.jandex.IndexView indexView

No Javadoc found

java.util.Set<DotName> classNames

No Javadoc found

org.jboss.resteasy.reactive.common.model.ResourceInterceptors resourceInterceptors

No Javadoc found

java.util.function.Consumer<ResourceInterceptors> buildTask

No Javadoc found

org.jboss.resteasy.reactive.common.processor.scanning.ResourceScanningResult result

No Javadoc found

Enable the registration of additional default produces handlers for server endpoints

Show more

org.jboss.resteasy.reactive.common.processor.DefaultProducesHandler defaultProducesHandler

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

io.quarkus.resteasy.reactive.jackson.deployment.processor.Feature feature

No Javadoc found

Used to pass info about a JAX-RS resource method that needs to perform custom serialization

Show more

org.jboss.jandex.MethodInfo methodInfo

No Javadoc found

org.jboss.jandex.ClassInfo declaringClassInfo

No Javadoc found

java.lang.Class<? extends BiFunction<ObjectMapper,Type,ObjectWriter>> customSerializationProvider

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 AnnotationsTransformer#appliesTo(AnnotationTarget.Kind) to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access AnnotationStore to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won’t be able to see any changes made via AnnotationsTransformer !

Show more

org.jboss.jandex.AnnotationTransformation transformer

No Javadoc found

Register types that should be available for injection into JAX-RS methods via Context

Show more

org.jboss.jandex.DotName type

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 org.jboss.resteasy.reactive.server.spi.GenericRuntimeConfigurableServerRestHandler . Extensions are meant to create these build items by passing the configuration class as the first constructor argument, and using a recorder to return a Supplier that will provide a value of that class as the second argument constructor. Ideally we would have used generic to make things more type safe, but generics cannot be used in build items.

Show more

java.lang.Class configClass

The runtime configuration class

java.util.function.Supplier valueSupplier

A supplier of the runtime value of the configuration class. This supplier is meant to be provided by a recorder

org.jboss.resteasy.reactive.server.processor.scanning.MethodScanner methodScanner

No Javadoc found

A build item that allows extension to define a ServerRestHandler that runs write before RESTEasy Reactive attempt to do exception mapping according to the JAX-RS spec. This is only meant to be used in very advanced use cases.

Show more

org.jboss.resteasy.reactive.server.spi.ServerRestHandler handler

No Javadoc found

int priority

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 Exception of this type is thrown and no jakarta.ws.rs.ext.ExceptionMapper exists, then RESTEasy Reactive will attempt to locate an ExceptionMapper for the cause of the Exception.

Show more

java.lang.String throwableClassName

No Javadoc found

REST - SPI

Class Name

Attributes

java.lang.String className

No Javadoc found

java.lang.Integer priority

No Javadoc found

boolean registerAsBean

No Javadoc found

java.util.Set<String> nameBindingNames

No Javadoc found

Can be used by extensions that want to make classes not annotated with JAX-RS @Path part of the ResourceClass scanning process. This will likely be used in conjunction with io.quarkus.resteasy.reactive.server.spi.AnnotationsTransformerBuildItem

Show more

org.jboss.jandex.ClassInfo classInfo

No Javadoc found

java.lang.String path

No Javadoc found

boolean preMatching

No Javadoc found

boolean nonBlockingRequired

No Javadoc found

boolean withFormRead

No Javadoc found

org.jboss.jandex.MethodInfo filterSourceMethod

No Javadoc found

org.jboss.jandex.MethodInfo filterSourceMethod

No Javadoc found

java.lang.String className

No Javadoc found

java.lang.String providedType

No Javadoc found

java.util.List<String> mediaTypes

No Javadoc found

boolean registerAsBean

No Javadoc found

Build item used to register classes that are annotated with @org.jboss.resteasy.reactive.server.ServerRequestFilter

Show more

java.lang.String className

No Javadoc found

Build item used to register classes that are annotated with @org.jboss.resteasy.reactive.server.ServerResponseFilter

Show more

java.lang.String className

No Javadoc found

Build item used to register classes that are annotated with @org.jboss.resteasy.reactive.server.ServerExceptionMapper

Show more

java.lang.String className

No Javadoc found

java.lang.String className

No Javadoc found

boolean registerAsBean

No Javadoc found

java.lang.String className

No Javadoc found

java.lang.Integer priority

No Javadoc found

java.lang.String handledExceptionName

No Javadoc found

boolean registerAsBean

No Javadoc found

org.jboss.jandex.ClassInfo declaringClass

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

java.lang.String name

No Javadoc found

byte[] data

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

java.lang.String className

No Javadoc found

boolean registerAsBean

No Javadoc found

java.lang.String className

No Javadoc found

java.lang.String handledClassName

No Javadoc found

java.util.List<String> mediaTypeStrings

No Javadoc found

jakarta.ws.rs.RuntimeType runtimeType

No Javadoc found

boolean builtin

No Javadoc found

java.lang.Integer priority

No Javadoc found

java.lang.String className

No Javadoc found

io.quarkus.resteasy.reactive.spi.MessageBodyReaderWriterOverrideData overrideData

No Javadoc found

java.lang.String className

No Javadoc found

java.lang.String handledClassName

No Javadoc found

java.util.List<String> mediaTypeStrings

No Javadoc found

jakarta.ws.rs.RuntimeType runtimeType

No Javadoc found

boolean builtin

No Javadoc found

java.lang.Integer priority

No Javadoc found

java.lang.String className

No Javadoc found

io.quarkus.resteasy.reactive.spi.MessageBodyReaderWriterOverrideData overrideData

No Javadoc found

java.lang.String className

No Javadoc found

int priority

No Javadoc found

boolean registerAsBean

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

org.jboss.jandex.DotName annotation

No Javadoc found

java.lang.Class<?> expectedReturnType

No Javadoc found

A Build Item that is used to capture the information of usages equivalent to @RegisterProvider(SomeProvider.class) . The use of the build item facilitates support for use cases that need to have the same effect as @RegisterProvider(SomeProvider.class) , but that don’t actually use the RegisterProvider annotation.

Show more

java.lang.String targetClass

No Javadoc found

org.jboss.jandex.AnnotationInstance annotationInstance

No Javadoc found

Contains information about the REST Clients that have been discovered via org.eclipse.microprofile.rest.client.inject.RegisterRestClient

Show more

org.jboss.jandex.ClassInfo classInfo

No Javadoc found

java.util.Optional<String> configKey

No Javadoc found

java.util.Optional<String> defaultBaseUri

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 AnnotationsTransformer#appliesTo(AnnotationTarget.Kind) to limit the scope of transformer to classes, fields, methods, method params or a combination of those. These metadata changes are not stored in Jandex directly (Jandex is immutable) but instead in an abstraction layer. Users/extensions can access AnnotationStore to view the updated annotation model. NOTE: Extensions that operate purely on Jandex index analysis won’t be able to see any changes made via AnnotationsTransformer !

Show more

org.jboss.jandex.AnnotationTransformation transformer

No Javadoc found

Represents the data necessary for creating a Http proxy for a REST Client

Show more

java.lang.String className

No Javadoc found

java.lang.String baseUri

No Javadoc found

java.util.Optional<String> provider

No Javadoc found

java.io.Closeable closeable

No Javadoc found

REST data with Panache

Class Name

Attributes

org.jboss.jandex.ClassInfo classInfo

No Javadoc found

org.jboss.jandex.Type entityType

No Javadoc found

java.lang.String resourceType

No Javadoc found

io.quarkus.rest.data.panache.deployment.properties.ResourceProperties resourceProperties

No Javadoc found

io.quarkus.rest.data.panache.deployment.ResourceMetadata resourceMetadata

No Javadoc found

RESTEasy Classic

Class Name

Attributes

A build item that holds Non jax-rs classes

Show more

java.util.Map<String,NonJaxRsClassMappings> nonJaxRsPaths

No Javadoc found

RESTEasy Classic - Common

Class Name

Attributes

java.util.Set<String> providers

No Javadoc found

java.util.Set<String> contributedProviders

No Javadoc found

java.util.Set<String> annotatedProviders

No Javadoc found

boolean useBuiltIn

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

java.lang.String interfaceName

No Javadoc found

org.jboss.jandex.ClassInfo classInfo

No Javadoc found

java.util.Optional<String> configKey

No Javadoc found

java.util.Optional<String> defaultBaseUri

No Javadoc found

Gives access to the configured InjectorFactory Can also be used as a marker indicating the RESTEasy injection has been properly set up

Show more

io.quarkus.runtime.RuntimeValue<InjectorFactory> injectorFactory

No Javadoc found

RESTEasy Classic - Common - SPI

Class Name

Attributes

boolean jsonDefault

No Javadoc found

A build item that represents a JAX-RS provider class.

Show more

java.lang.String name

No Javadoc found

RESTEasy Classic - Server common

Class Name

Attributes

java.lang.String rootPath

No Javadoc found

org.jboss.resteasy.spi.ResteasyDeployment deployment

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

java.util.function.Consumer<ResteasyDeployment> consumer

No Javadoc found

A build item that represents the configuration of the RESTEasy server.

Show more

java.lang.String rootPath

No Javadoc found

java.lang.String path

No Javadoc found

java.util.Map<String,String> initParameters

No Javadoc found

A build item that represents a path mapping from web.xml

Show more

java.lang.String path

No Javadoc found

RESTEasy Classic - Server common - SPI

Class Name

Attributes

org.jboss.jandex.DotName annotationClass

No Javadoc found

The package prefix of any annotations that have to be compatible with JaxRs resource class to allow constructor injection.

Show more

java.lang.String prefix

No Javadoc found

A build item that represents a JAX-RS config.

Show more

java.lang.String rootPath

No Javadoc found

java.lang.String defaultPath

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

org.jboss.jandex.DotName annotationName

No Javadoc found

java.lang.Class<?> providerClass

No Javadoc found

Register provider against every Rest client matching predicate.

Show more

java.lang.String providerClass

No Javadoc found

java.util.function.Predicate<ClassInfo> matcher

No Javadoc found

RESTEasy Client - OpenID Connect Filter

Class Name

Attributes

Contains a list of all Rest clients annotated with @OidcClientFilter("someClientName").

Show more

java.util.Set<String> namedFilterClientClasses

No Javadoc found

Scheduler

Class Name

Attributes

This build item holds all discovered io.quarkus.scheduler.Scheduler implementations sorted by priority. Higher priority goes first.

Show more

java.lang.String autoImplementation

No Javadoc found

java.util.Set<String> implementations

No Javadoc found

boolean useCompositeScheduler

No Javadoc found

A marker item which forces Quarkus Scheduler initialization regardless of presence of any io.quarkus.scheduler.Scheduled methods. This option is similar to using scheduler subsystem configuration option quarkus.scheduler.start-mode=forced .

Show more

None

An extension that provides an implementation of Scheduler must produce this build item. If multiple extensions produce this build item with the same #implementation value then the build fails.

Show more

java.lang.String implementation

No Javadoc found

org.jboss.jandex.DotName schedulerBeanClass

No Javadoc found

int priority

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

org.jboss.jandex.MethodInfo methodInfo

No Javadoc found

io.quarkus.security.spi.runtime.SecurityCheck securityCheck

No Javadoc found

boolean inFipsMode

No Javadoc found

boolean inFipsMode

No Javadoc found

Marker build item that is used to indicate that there are SupplierRolesAllowedCheck s whose roles contains config expressions that should be resolved at runtime.

Show more

None

Metadata for the names of JCA {@linkplain java.security.Provider} to register for reflection

Show more

java.lang.String providerName

No Javadoc found

java.lang.String providerConfig

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 AdditionalSecuredMethodsBuildItem

Show more

java.util.Collection<ClassInfo> additionalSecuredClasses

No Javadoc found

java.util.Optional<List<String>> rolesAllowed

No Javadoc found

Contains methods that need to have jakarta.annotation.security.DenyAll or jakarta.annotation.security.RolesAllowed .

Show more

java.util.Collection<MethodInfo> additionalSecuredMethods

No Javadoc found

java.util.Optional<List<String>> rolesAllowed

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

org.jboss.jandex.DotName securityAnnotationName

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

java.util.function.Supplier<Map<String,Object>> additionalEventPropsSupplier

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 AdditionalSecuredMethodsBuildItem if additional security is required. If you decide to use this build item, you must use class security check storage and apply checks manually. Thus, it’s only suitable for very special cases.

Show more

org.jboss.jandex.DotName classAnnotation

No Javadoc found

Security check storage containing additional security checks created for secured classes matching one of the ClassSecurityCheckAnnotationBuildItem filters during the static init.

Show more

java.util.Map<DotName,Object> classNameToSecurityCheck

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

java.util.List<String> rolesAllowed

No Javadoc found

Contains transitive io.quarkus.security.PermissionsAllowed instances. The io.quarkus.security.PermissionsAllowed annotation supports meta-annotation defined by users. Methods and classes annotated with these meta-annotations are collected and new AnnotationInstance s are created for them. Newly created instances are carried in the #transitiveInstances field.

Show more

java.util.List<DotName> metaAnnotationNames

No Javadoc found

boolean empty

No Javadoc found

java.util.List<AnnotationInstance> transitiveInstances

No Javadoc found

Provides a way to transform roles allowed specified as configuration expressions in annotations to runtime configuration values.

Show more

java.lang.String roleConfigExpr

No Javadoc found

java.util.function.BiConsumer<String,Supplier<String[]>> configValueRecorder

No Javadoc found

Security Jakarta Persistence - Common

Class Name

Attributes

This build items holds JpaSecurityDefinition common for reactive and classic Jakarta Persistence Security.

Show more

io.quarkus.security.jpa.common.deployment.JpaSecurityDefinition jpaSecurityDefinition

No Javadoc found

Build item to evaluate whether the class is a Panache model class.

Show more

java.util.Set<String> modelClasses

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 ThreadContextProvider .

Show more

java.lang.Class<? extends ThreadContextProvider> provider

No Javadoc found

SmallRye Fault Tolerance

Class Name

Attributes

int guardedMethods

No Javadoc found

SmallRye GraphQL

Class Name

Attributes

Used to create the publisher for the graphql trafic log in dev ui

Show more

io.quarkus.runtime.RuntimeValue<SubmissionPublisher<String>> publisher

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

java.lang.String healthCheckClass

No Javadoc found

boolean enabled

No Javadoc found

SmallRye OpenAPI

Class Name

Attributes

The filtered Jandex index of the OpenApi

Show more

io.smallrye.openapi.runtime.scanner.FilteredIndexView index

No Javadoc found

SmallRye OpenAPI - SPI

Class Name

Attributes

org.eclipse.microprofile.openapi.OASFilter filter

No Javadoc found

Ignore a static OpenAPI document included in extension and/or dependencies. Supports regular expressions.

Show more

java.util.regex.Pattern urlIgnorePattern

No Javadoc found

The final OpenAPI Document as generated by the Extension.

Show more

io.smallrye.openapi.api.OpenApiDocument openApiDocument

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

java.util.Map<String,DotName> map

No Javadoc found

Spring - Scheduling

Class Name

Attributes

Build Item recording all the methods that have been effectively annotated with @org.springframework.scheduling.annotation.Scheduled

Show more

java.util.Map<MethodInfo,AnnotationInstance> methodToInstanceMap

No Javadoc found

Spring Security

Class Name

Attributes

Build Item recording all the methods that have been effectively annotated with @PreAuthorize

Show more

java.util.Map<MethodInfo,AnnotationInstance> methodToInstanceMap

No Javadoc found

Swagger UI

Class Name

Attributes

java.lang.String swaggerUiFinalDestination

No Javadoc found

java.lang.String swaggerUiPath

No Javadoc found

TLS Registry

Class Name

Attributes

A build item to register a TLS certificate.

Show more

java.lang.String name

No Javadoc found

java.util.function.Supplier<TlsConfiguration> supplier

No Javadoc found

A build item that indicates that the TLS registry has been initialized.

Show more

java.util.function.Supplier<TlsConfigurationRegistry> registry

No Javadoc found

Undertow - SPI

Class Name

Attributes

java.lang.String name

No Javadoc found

java.lang.String filterClass

No Javadoc found

int loadOnStartup

No Javadoc found

boolean asyncSupported

No Javadoc found

java.util.List<FilterMappingInfo> mappings

No Javadoc found

io.undertow.servlet.api.InstanceFactory<? extends Filter> instanceFactory

No Javadoc found

java.util.Map<String,String> initParams

No Javadoc found

A generated static resource that will be served by the web container This is automatically registered in native mode

Show more

java.lang.String name

No Javadoc found

byte[] classData

No Javadoc found

io.undertow.server.HandlerWrapper value

No Javadoc found

java.lang.String sciClass

No Javadoc found

java.util.Set<String> knownFiles

No Javadoc found

java.util.Set<String> knownDirectories

No Javadoc found

java.lang.String listenerClass

No Javadoc found

java.lang.String name

No Javadoc found

java.lang.String servletClass

No Javadoc found

int loadOnStartup

No Javadoc found

boolean asyncSupported

No Javadoc found

java.util.List<String> mappings

No Javadoc found

io.undertow.servlet.api.InstanceFactory<? extends Servlet> instanceFactory

No Javadoc found

java.util.Map<String,String> initParams

No Javadoc found

jakarta.servlet.MultipartConfigElement multipartConfig

No Javadoc found

java.lang.String sciClass

No Javadoc found

java.util.Set<String> handlesTypes

No Javadoc found

java.lang.String key

No Javadoc found

java.lang.Object value

No Javadoc found

java.lang.String servletContextPath

No Javadoc found

io.undertow.servlet.api.DeploymentManager deploymentManager

No Javadoc found

io.undertow.servlet.ServletExtension value

No Javadoc found

java.lang.String key

No Javadoc found

java.lang.String value

No Javadoc found

io.quarkus.runtime.RuntimeValue<Undertow> undertow

No Javadoc found

org.jboss.metadata.web.spec.WebMetaData webMetaData

No Javadoc found

Vert.x

Class Name

Attributes

java.util.function.Supplier<Vertx> vertx

No Javadoc found

A build item that can be used to retrieve the number of events loops that have been configured/calculated

Show more

java.util.function.Supplier<Integer> eventLoopCount

No Javadoc found

Carries all types for which the io.quarkus.vertx.LocalEventBusCodec should be selected automatically.

Show more

java.util.Set<String> types

No Javadoc found

java.lang.String type

No Javadoc found

java.lang.String codec

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

Show more

io.quarkus.runtime.RuntimeValue<Vertx> vertx

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

java.util.function.Consumer<VertxOptions> optionsConsumer

No Javadoc found

int priority

No Javadoc found

Vert.x - HTTP

Class Name

Attributes

Carries all gathered io.quarkus.vertx.http.security.AuthorizationPolicy instances that should be applied.

Show more

java.util.Map<MethodInfo,String> methodToPolicyName

Contains: - Methods annotated with io.quarkus.vertx.http.security.AuthorizationPolicy - Methods of classes annotated with io.quarkus.vertx.http.security.AuthorizationPolicy that doesn’t have another standard security annotation.

io.vertx.core.Handler<RoutingContext> handler

No Javadoc found

Write javascript file containing const vars with build time data

Show more

java.util.Map<String,Object> buildTimeData

No Javadoc found

A build item that represents a handler for the default route

Show more

java.util.function.Consumer<Route> route

No Javadoc found

Hold add discovered build time methods that can be executed via json-rpc

Show more

java.util.List<String> methods

No Javadoc found

java.util.List<String> subscriptions

No Javadoc found

java.util.Map<String,RuntimeValue> recordedValues

No Javadoc found

All the routes needed for Dev UI

Show more

java.lang.String namespace

No Javadoc found

java.lang.String contextRoot

No Javadoc found

java.lang.String finalDestination

No Javadoc found

java.util.List<FileSystemStaticHandler.StaticWebRootConfiguration> webRootConfigurations

No Javadoc found

io.quarkus.maven.dependency.GACT artifactKey

No Javadoc found

java.lang.String path

No Javadoc found

Provides a way for extensions to register eager security interceptor. For example, the Vert.x HTTP extension registers HttpAuthenticationMechanism and an interceptor that sets annotation value ('@HttpAuthenticationMechanism("basic") ⇒ 'basic') as routing context attribute. With disabled proactive authentication, these interceptors are guaranteed to run before any other security code of supported extensions (currently RESTEasy Classic and RESTEasy Reactive).

Show more

org.jboss.jandex.DotName[] annotationBindings

No Javadoc found

java.util.function.Function<String,Consumer<RoutingContext>> interceptorCreator

No Javadoc found

java.util.Map<String,String> bindingToValue

No Javadoc found

boolean requiresSecurityCheck

If this interceptor is always accompanied by io.quarkus.security.spi.runtime.SecurityCheck . For example, we know that endpoint annotated with HttpAuthenticationMechanism is always secured.

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

java.util.Map<String,List<MethodInfo>> bindingValueToInterceptedMethods

Annotation binding value: '@HttpAuthenticationMechanism("custom")' ⇒ 'custom'; mapped to annotated methods

org.jboss.jandex.DotName interceptorBinding

Interceptor binding annotation name, like HttpAuthenticationMechanism .

boolean requiresSecurityCheck

If this interceptor is always accompanied by io.quarkus.security.spi.runtime.SecurityCheck . For example, we know that endpoint annotated with HttpAuthenticationMechanism is always secured.

Allows extensions to contribute an action (button) to the error page

Show more

java.util.List<ErrorPageAction> actions

No Javadoc found

java.util.List<Extension> activeExtensions

No Javadoc found

java.util.List<Extension> inactiveExtensions

No Javadoc found

java.util.List<Extension> sectionMenuExtensions

No Javadoc found

java.util.List<Extension> footerTabsExtensions

No Javadoc found

A handler that is applied to every route

Show more

io.vertx.core.Handler<RoutingContext> handler

No Javadoc found

int priority

No Javadoc found

boolean isFailureHandler

No Javadoc found

Register HttpAuthenticationMechanism meta annotations. This way, users can use BasicAuthentication instead of '@HttpAuthenticationMechanism("basic")'.

Show more

org.jboss.jandex.DotName annotationName

Annotation name, for example BasicAuthentication .

java.lang.String authMechanismScheme

Authentication mechanism scheme, as defined by HttpAuthenticationMechanism#value() .

java.net.URI rootPath

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

java.util.Map<String,String> importMap

No Javadoc found

Used internally to define some of our own pages

Show more

java.lang.String namespaceLabel

No Javadoc found

int position

No Javadoc found

java.util.List<Page> pages

No Javadoc found

java.util.Map<String,Object> buildTimeData

No Javadoc found

Simple holder for all discovered Json RPC Methods

Show more

java.util.Map<String,Map<JsonRpcMethodName,JsonRpcMethod>> extensionMethodsMap

No Javadoc found

A handler that is applied to the management interface route

Show more

io.vertx.core.Handler<RoutingContext> handler

No Javadoc found

int priority

No Javadoc found

All mvnpm jars used by Dev UI

Show more

java.util.Set<URL> mvnpmJars

No Javadoc found

java.net.URI httpRootPath

Normalized of quarkus.http.root-path. Must end in a slash

java.net.URI nonApplicationRootPath

Normalized from quarkus.http.non-application-root-path

java.net.URI managementRootPath

Normalized from quarkus.management.root-path

boolean dedicatedRouterRequired

Non-Application root path is distinct from HTTP root path.

boolean attachedToMainRouter

No Javadoc found

java.lang.String endpoint

No Javadoc found

java.lang.String description

No Javadoc found

boolean absolutePath

No Javadoc found

Used internally to relocate namespaces for backward compatibility

Show more

java.util.Map<String,String> relocations

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

java.util.function.BooleanSupplier bodyHandlerRequiredCondition

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

boolean alwaysVirtual

No Javadoc found

boolean management

No Javadoc found

java.util.function.Function<Router,Route> routeFunction

No Javadoc found

io.vertx.core.Handler<RoutingContext> handler

No Javadoc found

io.quarkus.vertx.http.runtime.HandlerType type

No Javadoc found

io.quarkus.vertx.http.deployment.RouteType routeType

No Javadoc found

io.quarkus.vertx.http.deployment.RouteType routerType

No Javadoc found

io.quarkus.vertx.http.deployment.devmode.NotFoundPageDisplayableEndpointBuildItem notFoundPageDisplayableEndpoint

No Javadoc found

io.quarkus.vertx.http.deployment.devmode.ConfiguredPathInfo configuredPathInfo

No Javadoc found

io.quarkus.vertx.http.runtime.devmode.RouteDescription description

No Javadoc found

Contains information on the security model used in the application

Show more

io.quarkus.vertx.http.deployment.SecurityModel securityModel

No Javadoc found

java.util.Optional<OpenIDConnectInformation> openIDConnectInformation

No Javadoc found

java.util.Set<String> themeVars

No Javadoc found

java.lang.String defaultValue

No Javadoc found

Used to create the publisher for the vertx access log in dev ui

Show more

io.quarkus.runtime.RuntimeValue<SubmissionPublisher<String>> publisher

No Javadoc found

io.quarkus.runtime.RuntimeValue<Router> httpRouter

No Javadoc found

io.quarkus.runtime.RuntimeValue<Router> mainRouter

No Javadoc found

io.quarkus.runtime.RuntimeValue<Router> frameworkRouter

No Javadoc found

io.quarkus.runtime.RuntimeValue<io.vertx.mutiny.ext.web.Router> mutinyRouter

No Javadoc found

io.quarkus.runtime.RuntimeValue<Router> managementRouter

No Javadoc found

BuildItem for deploying a webjar.

Show more

io.quarkus.maven.dependency.GACT artifactKey

ArtifactKey pointing to the web jar. Has to be one of the applications dependencies.

java.lang.String root

Root inside the webJar starting from which resources are unpacked.

boolean onlyCopyNonArtifactFiles

Only copy resources of the webjar which are either user overridden, or contain variables.

boolean useDefaultQuarkusBranding

Defines whether Quarkus can override resources of the webjar with Quarkus internal files.

io.quarkus.vertx.http.deployment.webjar.WebJarResourcesFilter filter

No Javadoc found

Holds the complete result after applying every WebJarBuildItem .

Show more

java.util.Map<GACT,WebJarResult> results

No Javadoc found

java.lang.String websocketSubProtocols

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

java.lang.Class<?> callerClass

No Javadoc found

java.lang.String extensionIdentifier

No Javadoc found

java.lang.String customIdentifier

No Javadoc found

Any of card, menu or footer pages

Show more

java.util.Map<String,Object> buildTimeData

No Javadoc found

java.util.List<PageBuilder> pageBuilders

No Javadoc found

Holds any Build time actions for Dev UI the extension has

Show more

java.util.List<BuildTimeAction> actions

No Javadoc found

java.util.List<BuildTimeAction> subscriptions

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

java.util.Optional<Card> optionalCard

No Javadoc found

Add a log to the footer of dev ui

Show more

java.lang.String name

No Javadoc found

java.util.function.Supplier<Flow.Publisher<String>> publisherSupplier

No Javadoc found

io.quarkus.runtime.RuntimeValue<SubmissionPublisher<String>> runtimePublisher

No Javadoc found

Add a footer tab to the Dev UI.

Show more

None

This allows you to register a class that will provide data during runtime for JsonRPC Requests

Show more

java.lang.Class jsonRPCMethodProviderClass

No Javadoc found

org.jboss.jandex.DotName defaultBeanScope

No Javadoc found

Add a menu (or section) to the Dev UI.

Show more

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

java.util.List<TemplateData> templateDatas

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

java.util.List<DevUIContent> content

No Javadoc found

Vert.x - HTTP - SPI

Class Name

Attributes

java.util.List<String> endpoints

No Javadoc found

This build item aims to be used by extensions to generate static resources. Those resources will be served on the given GeneratedStaticResourceBuildItem#endpoint . It is NOT necessary to create the file on disk. Behind the scenes the build step will take care of add those resources to the final build, through AdditionalStaticResourceBuildItem , NativeImageResourceBuildItem and io.quarkus.deployment.builditem.GeneratedResourceBuildItem build items. The value of endpoint should be prefixed with '/' .

Show more

java.lang.String endpoint

No Javadoc found

java.nio.file.Path file

No Javadoc found

byte[] content

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

io.quarkus.vertx.http.deployment.spi.RouteType typeOfRoute

No Javadoc found

java.util.OptionalInt order

No Javadoc found

java.lang.String path

No Javadoc found

java.util.function.Consumer<Route> customizer

No Javadoc found

boolean isManagement

No Javadoc found

io.vertx.core.Handler<RoutingContext> handler

No Javadoc found

io.quarkus.vertx.http.deployment.spi.HandlerType typeOfHandler

No Javadoc found

boolean displayOnNotFoundPage

No Javadoc found

java.lang.String notFoundPageTitle

No Javadoc found

java.lang.String routeConfigKey

No Javadoc found

java.util.Set<Entry> entries

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

java.util.function.BiConsumer<MethodInfo,InvokerBuilder> invokerCustomizer

No Javadoc found

Web Dependency Locator

Class Name

Attributes

java.lang.String importmap

No Javadoc found

java.lang.String provider

No Javadoc found

java.util.List<WebDependencyLibrary> webDependencyLibraries

No Javadoc found

WebSockets Client

Class Name

Attributes

java.lang.String className

No Javadoc found

boolean client

No Javadoc found

io.quarkus.runtime.RuntimeValue<ServerWebSocketContainer> container

No Javadoc found

io.quarkus.websockets.client.runtime.ServerWebSocketContainerFactory factory

No Javadoc found

io.quarkus.runtime.RuntimeValue<WebSocketDeploymentInfo> info

No Javadoc found

WebSockets Next

Class Name

Attributes

A generated representation of a WebSocket endpoint.

Show more

java.lang.String endpointId

No Javadoc found

java.lang.String endpointClassName

No Javadoc found

java.lang.String generatedClassName

No Javadoc found

java.lang.String path

No Javadoc found

boolean isClient

No Javadoc found

This build item represents a WebSocket endpoint class, i.e. class annotated with WebSocket or WebSocketClient .

Show more

boolean isClient

No Javadoc found

io.quarkus.arc.processor.BeanInfo bean

No Javadoc found

java.lang.String path

No Javadoc found

java.lang.String id

No Javadoc found

io.quarkus.websockets.next.InboundProcessingMode inboundProcessingMode

No Javadoc found

io.quarkus.websockets.next.deployment.Callback onOpen

No Javadoc found

io.quarkus.websockets.next.deployment.Callback onTextMessage

No Javadoc found

io.quarkus.websockets.next.deployment.Callback onBinaryMessage

No Javadoc found

io.quarkus.websockets.next.deployment.Callback onPongMessage

No Javadoc found

io.quarkus.websockets.next.deployment.Callback onClose

No Javadoc found

java.util.List<Callback> onErrors

No Javadoc found