////
This guide is maintained in the main Quarkus repository
and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/master/docs/src/main/asciidoc
////
= Quarkus - Writing Your Own Extension

:numbered:
:sectnums:
:sectnumlevels: 4
:toc:

include::./attributes.adoc[]

Quarkus extensions add a new developer focused behavior to the core offering, and consist of two distinct parts, buildtime augmentation and runtime container. The augmentation part is responsible for all metadata processing, such as reading annotations, XML descriptors etc. The output of this augmentation phase is recorded bytecode which is responsible for directly instantiating the relevant runtime services.

This means that metadata is only processed once at build time, which both saves on startup time, and also on memory
usage as the classes etc that are used for processing are not loaded (or even present) in the runtime JVM.

== Extension philosophy

This section is a work in progress and gathers the philosophy under which extensions should be designed and written.

=== Why an extension framework

Quarkus’s mission is to transform your entire application including the libraries it uses, into an artifact that uses significantly less resources than traditional approaches. These can then be used to build native applications using GraalVM.
To do this you need to analyze and understand the full "closed world" of the application.
Without the full and complete context, the best that can be achieved is partial and limited generic support.
By using the Quarkus extension approach, we can bring Java applications in line with memory footprint constrained environments like Kubernetes or cloud platforms.

The Quarkus extension framework results in significantly improved resource utilization even when GraalVM is not used (e.g. in HotSpot).
Let’s list the actions an extension performs:

* Gather build time metadata and generate code
** This part has nothing to do with GraalVM, it is how Quarkus starts frameworks “at build time”
** The extension framework facilitates reading metadata, scanning classes as well as generating classes as needed
** A small part of the extension work is executed at runtime via the generated classes, while the bulk of the work is done at build time (called deployment time)
* Enforce opinionated and sensible defaults based on the close world view of the application (e.g. an application with no `@Entity` does not need to start Hibernate ORM)
* An extension hosts Substrate VM code substitution so that libraries can run on GraalVM
** Most changes are pushed upstream to help the underlying library run on GraalVM
** Not all changes can be pushed upstream, extensions host Substrate VM substitutions - which is a form of code patching - so that libraries can run
* Host Substrate VM code substitution to help dead code elimination based on the application needs
** This is application dependant and cannot really be shared in the library itself
** For example, Quarkus optimizes the Hibernate code because it knows it only needs a specific connection pool and cache provider
* Send metadata to GraalVM for example classes in need of reflection
** This information is not static per library (e.g. Hibernate) but the framework has the semantic knowledge and knows which classes need to have reflection (for example @Entity classes)

=== Favor build time work over runtime work

As much as possible favor doing work at build time (deployment part of the extension) as opposed to let the framework do work at startup time (runtime).
The more is done there, the smaller Quarkus applications using that extension will be and the faster they will load.

=== How to expose configuration

Quarkus simplifies the most common usages.
This means that its defaults might be different than the library it integrates.

To make the simple experience easiest, unify the configuration in `application.properties` via MicroProfile Config.
Avoid library specific configuration files, or at least make them optional: e.g. `persistence.xml` for Hibernate ORM is optional.

Extensions should see the configuration holistically as a Quarkus application instead of focusing on the library experience.
For example `quarkus.database.url` and friends are shared between extensions as defining a database access is a shared task (instead of a `hibernate.` property for example).
The most useful configuration options should be exposed as `quarkus.[extension].` instead of the natural namespace of the library.
Less common properties can live in the library namespace.

To fully enable the close world assumptions that Quarkus can optimize best, it is better to consider configuration options as build time settled vs overridable at runtime.
Of course properties like host, port, password should be overridable at runtime.
But many properties like enable caching or setting the JDBC driver can safely require a rebuild of the application.

////
=== API

TODO: Describe where to put APIs
I wonder if that content should be in the technical aspects

=== Substitution and recorders

TODO: Describe where Substitutions and recorders should live
////

=== Expose your components via CDI

Since CDI is the central programming model when it comes to component composition, frameworks should expose producers that are easily consumable by user applications. +
For example, Hibernate ORM exposes `EntityManagerFactory` and `EntityManager` beans, the connection pool exposes `DataSource` beans etc.
An extension must generate these bean definitions at build time.

A very useful pattern of creating such beans but also giving application code the ability to easily override some of the beans with custom implementations, is to use
the `@DefaultBean` that Quarkus provides. This is best explained with an example.

==== Example CDI configuration using @DefaultBean

Let us assume that the Quarkus extension needs to provide a `Tracer` bean which application code is meant to inject into its own beans.

[source%nowrap,java]
----
@Dependent
public class TracerConfiguration {

    @Produces
    public Tracer tracer(Reporter reporter, Configuration configuration) {
        return new Tracer(reporter, configuration);
    }

    @Produces
    @DefaultBean
    public Configuration configuration() {
        // create a Configuration
    }

    @Produces
    @DefaultBean
    public Reporter reporter(){
        // create a Reporter
    }
}
----

If for example application code wants to use `Tracer`, but also needs to use a custom `Reporter` bean, such a requirement could easily be done using something like:


[source%nowrap,java]
----
@Dependent
public class CustomTracerConfiguration {

    @Produces
    public Reporter reporter(){
        // create a custom Reporter
    }
}
----

==== How to Override a Bean Defined by a Library/Quarkus Extension that doesn't use @DefaultBean

Although `@DefaultBean` is the recommended approach, it is also possible for application code to override beans provided by an extension by marking beans as a CDI `@Alternative` and including `@Priority` annotation.
Let's show a simple example.
Suppose we work on an imaginary "quarkus-parser" extension and we have a default bean implementation:

[source%nowrap,java]
----
@Dependent
class Parser {

  String[] parse(String expression) {
    return expression.split("::");
  }
}
----

And our extension also consumes this parser:

[source%nowrap,java]
----
@ApplicationScoped
class ParserService {

  @Inject
  Parser parser;

  //...
}
----

Now, if a user or even some other extension needs to override the default implementation of the `Parser` the simplest solution is to use CDI `@Alternative` + `@Priority`:

[source%nowrap,java]
----
@Alternative <1>
@Priority(1) <2>
@Singleton
class MyParser extends Parser {

  String[] parse(String expression) {
    // my super impl...
  }
}
----
<1> `MyParser` is an alternative bean.
<2> Enables the alternative. The priority could be any number to override the default bean but if there are multiple alternatives the highest priority wins.

NOTE: CDI alternatives are only considered during injection and type-safe resolution. For example the default implementation would still receive observer notifications.

=== Some types of extensions

There exist multiple stereotypes of extension, let's list a few.

Bare library running::
This is the less sophisticated extension.
It consists of a set of patches to make sure a library runs on GraalVM.
If possible, contribute these patches upstream, not in extensions.
Second best is to write Substrate VM substitutions, which are patches applied during native image compilation.

Get a framework running::
A framework at runtime typically reads configuration, scan the classpath and classes for metadata (annotations, getters etc), build a metamodel on top of which it runs, find options via the service loader pattern, prepare invocation calls (reflection), proxy interfaces, etc. +
These operations should be done at build time and the metamodel be passed to the recorder DSL that will generate classes that will be executed at runtime and boot the framework.

Get a CDI portable extension running::
The CDI portable extension model is very flexible.
Too flexible to benefit from the build time boot promoted by Quarkus.
Most extension we have seen do not make use of these extreme flexibilities capabilities.
The way to port a CDI extension to Quarkus is to rewrite it as a Quarkus extension which will define the various beans at build time (deployment time in extension parley).

== Technical aspect

[[bootstrap-three-phases]]
=== Three Phases of Bootstrap and Quarkus Philosophy

There are three distinct bootstrap phases of a Quarkus app:

Augmentation::
    This is the first phase, and is done by the <<Build Step Processors>>. These processors have access to Jandex annotation
    information and can parse any descriptors and read annotations, but should not attempt to load any application classes. The output of these
    build steps is some recorded bytecode, using an extension of the ObjectWeb ASM project called Gizmo(ext/gizmo), that is used to actually bootstrap the application at runtime. Depending on the `io.quarkus.deployment.annotations.ExecutionTime` value of the `@io.quarkus.deployment.annotations.Record` annotation associated with the build step,
    the step may be run in a different JVM based on the following two modes.

Static Init::
    If bytecode is recorded with `@Record(STATIC_INIT)` then it will be executed from a static init method on the main
    class. For a native executable build, this code is executed in a normal JVM as part of the native build
    process, and any retained objects that are produced in this stage will be directly serialized into the native executable via an image mapped file.
    This means that if a framework can boot in this phase then it will have its booted state directly written to the
    image, and so the boot code does not need to be executed when the image is started.
+
There are some restrictions on what can be done in this stage as the Substrate VM disallows some objects in the native executable. For example you should not attempt to listen on a port or start threads in this phase.
+
In non-native pure JVM mode, there is no real difference between Static and Runtime Init, except that Static Init is always executed first. This mode benefits from the same build phase augmentation as native mode as the descriptor parsing and annotation scanning are done
at build time and any associated class/framework dependencies can be removed from the build output jar. In servers like
WildFly, deployment related classes such as XML parsers hang around for the life of the application, using up valuable
memory. Quarkus aims to eliminate this, so that the only classes loaded at runtime are actually used at runtime.
+
As an example, the only reason that a Quarkus application should load an XML parser is if the user is using XML in their
application. Any XML parsing of configuration should be done in the Augmentation phase.

Runtime Init::
    If bytecode is recorded with `@Record(RUNTIME_INIT)` then it is executed from the application's main method. This code
    will be run on native executable boot. In general as little code as possible should be executed in this phase, and should
    be restricted to code that needs to open ports etc.

Pushing as much as possible into the `@Record(STATIC_INIT)` phase allows for two different optimizations:

1. In both native executable and pure JVM mode this allows the app to start as fast as possible since processing was done during build time. This also minimizes the classes/native code needed in the application to pure runtime related behaviors.

2. Another benefit with native executable mode is that Substrate can more easily eliminate features that are not used. If features are directly initialized via bytecode, Substrate can detect that a method is never called and eliminate
that method. If config is read at runtime, Substrate cannot reason about the contents of the config and so needs to keep all features in case they are required.


=== Maven setup

Your extension project should be setup as a multi-module project with two submodules:

1. A deployment time submodule that handles the build time processing and bytecode recording.

2. A runtime submodule that contains the runtime behavior that will provide the extension behavior in the native executable or runtime JVM.

TIP: You may want to use the `create-extension` mojo of `io.quarkus:quarkus-maven-plugin` to create these Maven modules - see the next section.

Your runtime artifact should depend on `io.quarkus:quarkus-core`, and possibly the runtime artifacts of other Quarkus
modules if you want to use functionality provided by them.
You will also need to include the `io.quarkus:quarkus-bootstrap-maven-plugin` to generate the Quarkus extension descriptor included into the runtime artifact, if you are using the Quarkus parent pom it will automatically inherit the correct configuration.
Futhermore, you'll need to configure the `maven-compiler-plugin` to detect the `quarkus-extension-processor` annotation processor.

NOTE: By convention the deployment time artifact has the `-deployment` suffix, and the runtime artifact
has no suffix (and is what the end user adds to their project).

[source%nowrap,xml]
----

<dependencies>
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-core</artifactId>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>io.quarkus</groupId>
            <artifactId>quarkus-bootstrap-maven-plugin</artifactId>
            <!-- Executions configuration can be inherited from quarkus-build-parent -->
            <executions>
                <execution>
                    <goals>
                        <goal>extension-descriptor</goal>
                    </goals>
                    <configuration>
                         <deployment>${project.groupId}:${project.artifactId}-deployment:${project.version}</deployment>
                   </configuration>
               </execution>
           </executions>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <annotationProcessorPaths>
                    <path>
                        <groupId>io.quarkus</groupId>
                        <artifactId>quarkus-extension-processor</artifactId>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>
----

NOTE: The above `maven-compiler-plugin` configuration requires version 3.5+.

[WARNING]
====
Under no circumstances can the runtime module depend on a deployment artifact. This would result
in pulling all the deployment time code into runtime scope, which defeats the purpose of having the split.
====

Your deployment time module should depend on `io.quarkus:quarkus-core-deployment`, your runtime artifact,
and possibly the deployment artifacts of other Quarkus modules if you want to use functionality provided by them.
You will also need to configure the `maven-compiler-plugin` to detect the `quarkus-extension-processor` annotation processor.

[source%nowrap,xml]
----
<dependencies>
    <dependency>
        <groupId>io.quarkus</groupId>
        <artifactId>quarkus-core-deployment</artifactId>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <annotationProcessorPaths>
                    <path>
                        <groupId>io.quarkus</groupId>
                        <artifactId>quarkus-extension-processor</artifactId>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>
----

==== Create new extension modules using Maven

The `create-extension` mojo of `io.quarkus:quarkus-maven-plugin` can be used to generate stubs of Maven modules needed for implementing a new Quarkus extension.

WARNING: This mojo can be currently used only for adding extensions to an established source tree hosting multiple extensions in one subdirectory, such as https://github.com/quarkusio/quarkus[Quarkus] or https://github.com/apache/camel-quarkus[Camel Quarkus]. Creating extension projects from scratch is not supported yet.

As and example, let's add a new extension called `my-ext` to the Quarkus source tree:

[source, shell, subs=attributes+]
----
git clone https://github.com/quarkusio/quarkus.git
cd quarkus
cd extensions
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create-extension -N \
    -Dquarkus.artifactIdBase=my-ext \
    -Dquarkus.artifactIdPrefix=quarkus- \
    -Dquarkus.nameBase="My Extension"
----

The above sequence of commands does the following:

* Creates four new Maven modules:
** `quarkus-my-ext-parent` in the `extensions/my-ext` directory
** `quarkus-my-ext` in the `extensions/my-ext/runtime` directory
** `quarkus-my-ext-deployment` in the `extensions/my-ext/deployment` directory; a basic `MyExtProcessor` class is generated in this module.
** `quarkus-my-ext-integration-test` in the `integration-tests/my-ext/deployment` directory; an empty JAX-RS Resource class and two test classes (for JVM mode and native mode) are generated in this module.
* Links these three modules where necessary:
** `quarkus-my-ext-parent` is added to the `<modules>` of `quarkus-extensions-parent`
** `quarkus-my-ext` is added to the `<dependencyManagement>` of the runtime BOM (Bill of Materials) `bom/runtime/pom.xml`
** `quarkus-my-ext-deployment` is added to the `<dependencyManagement>` of the deployment BOM (Bill of Materials) `bom/deployment/pom.xml`
** `quarkus-my-ext-integration-test` is added to the `<modules>` of `quarkus-integration-tests-parent`

A Maven build performed immediately after generating the modules should fail due to a `fail()` assertion in one of the test classes.

There is one step (specific to the Quarkus source tree) that you should do manually when creating a new extension:
Add the extension coordinates to `devtools/common/src/main/filtered/extensions.json`.

Note that the parameters of the mojo that will be constant for all the extensions added to this source tree are configured in `extensions/pom.xml` so that they do not need to be passed on the command line each time a new extension is added:

[source,xml]
----
<plugin>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-maven-plugin</artifactId>
    <version>${quarkus.version}</version>
    <inherited>false</inherited>
    <!-- Settings for stubbing new extensions via
           mvn quarkus:create-extension -N -Dquarkus.artifactIdBase=my-ext -Dquarkus.nameBase="My Extension"
    -->
    <configuration>
        <namePrefix xml:space="preserve">Quarkus - </namePrefix>
        <runtimeBomPath>../bom/runtime/pom.xml</runtimeBomPath>
        <deploymentBomPath>../bom/deployment/pom.xml</deploymentBomPath>
        <itestParentPath>../integration-tests/pom.xml</itestParentPath>
    </configuration>
</plugin>
----

TIP: The `nameBase` parameter of the mojo is optional.
If you do not specify it on the command line, the plugin will derive it from `artifactIdBase` by replacing dashes with spaces and uppercasing each token.
So you may consider omitting explicit `nameBase` in some cases.

// The following link should point to the mojo page once https://github.com/quarkusio/quarkusio.github.io/issues/265 is fixed
Please refer to https://github.com/quarkusio/quarkus/blob/{quarkus-version}/devtools/maven/src/main/java/io/quarkus/maven/CreateExtensionMojo.java[CreateExtensionMojo JavaDoc] for all the available options of the mojo.

=== Build Step Processors

Work is done at augmentation time by _build steps_ which produce and consume _build items_.  The build steps found in
the deployment modules that correspond to the extensions in the project build are automatically wired together and executed
to produce the final build artifact(s).

==== Build steps

A _build step_ is a method which is annotated with the `@io.quarkus.deployment.annotations.BuildStep` annotation.  Each
build step may <<consuming-values,consume>> items that are produced by earlier stages, and <<producing-values,produce>> items
that can be consumed by later stages. Build steps are normally only run when they produce a build item that is
ultimately consumed by another step.

Build steps are normally placed on plain classes within an extension's deployment module.  The classes are automatically
instantiated during the augment process and utilize <<injection,injection>>.

[id='build-items']
==== Build items

Build items are concrete, final subclasses of the abstract `io.quarkus.builder.item.BuildItem` class.  Each build item represents
some unit of information that must be passed from one stage to another.  The base `BuildItem` class may not itself be directly
subclassed; rather, there are abstract subclasses for each of the kinds of build item subclasses that _may_ be created:
<<simple-build-items,simple>>, <<multi-build-items,multi>>, and <<empty-build-items,empty>>.

Think of build items as a way for different extensions to communicate with one another.  For example, a build item can:

- expose the fact that a database configuration exists
- consume that database configuration (e.g. a connection pool extension or an ORM extension)
- ask an extension to do work for another extension: e.g. an extension wanting to define a new CDI bean and asking the ArC extension
to do so

This is a very flexible mechanism.

NOTE: `BuildItem` instances should be immutable, as the producer/consumer model does not allow for mutation to be correctly
ordered. This is not enforced but failure to adhere to this rule can result in race conditions.

[id='simple-build-items']
===== Simple build items

Simple build items are final classes which extend `io.quarkus.builder.item.SimpleBuildItem`.  Simple build items may only
be produced by one step in a given build; if multiple steps in a build declare that they produce the same simple build item,
an error is raised.  Any number of build steps may consume a simple build item.  A build step which consumes a simple
build item will always run _after_ the build step which produced that item.

.Example of a single build item
[source%nowrap,java]
----
/**
 * The build item which represents the Jandex index of the application,
 * and would normally be used by many build steps to find usages
 * of annotations.
 */
public final class ApplicationIndexBuildItem extends SimpleBuildItem {

    private final Index index;

    public ApplicationIndexBuildItem(Index index) {
        this.index = index;
    }

    public Index getIndex() {
        return index;
    }
}
----


[id='multi-build-items']
===== Multi build items

Multiple or "multi" build items are final classes which extend `io.quarkus.builder.item.MultiBuildItem`.  Any number of
multi build items of a given class may be produced by any number of steps, but any steps which consume multi build items
will only run _after_ every step which can produce them has run.

.Example of a multiple build item
[source%nowrap,java]
----
public final class ServiceProviderBuildItem extends MultiBuildItem {
    private final String serviceName;
    private final List<String> implementations;

    public ServiceProviderBuildItem(String serviceName, String... implementations) {
        this.serviceName = serviceName;
        // Make sure it's immutable
        this.implementations = Collections.unmodifiableList(
            Arrays.asList(
                implementations.clone()
            )
        );
    }

    public String getServiceName() {
        return serviceName;
    }

    public List<String> getImplementations() {
        return implementations;
    }
}
----

.Example of multiple build item usage
[source%nowrap,java]
----
/**
 * This build step produces a single multi build item that declares two
 * providers of one configuration-related service.
 */
@BuildStep
public ServiceProviderBuildItem registerOneService() {
    return new ServiceProviderBuildItem(
        Converter.class.getName(),
        MyFirstConfigConverterImpl.class.getName(),
        MySecondConfigConverterImpl.class.getName()
    );
}

/**
 * This build step produces several multi build items that declare multiple
 * providers of multiple configuration-related services.
 */
@BuildStep
public void registerSeveralSerivces(
    BuildProducer<ServiceProviderBuildItem> providerProducer
) {
    providerProducer.produce(new ServiceProviderBuildItem(
        Converter.class.getName(),
        MyThirdConfigConverterImpl.class.getName(),
        MyFourthConfigConverterImpl.class.getName()
    ));
    providerProducer.produce(new ServiceProviderBuildItem(
        ConfigSource.class.getName(),
        MyConfigSourceImpl.class.getName()
    ));
}

/**
 * This build step aggregates all the produced service providers
 * and outputs them as resources.
 */
@BuildStep
public void produceServiceFiles(
    List<ServiceProviderBuildItem> items,
    BuildProducer<GeneratedResourceBuildItem> resourceProducer
) throws IOException {
    // Aggregate all of the providers

    Map<String, Set<String>> map = new HashMap<>();
    for (ServiceProviderBuildItem item : items) {
        String serviceName = item.getName();
        for (String implName : item.getImplementations()) {
            map.computeIfAbsent(
                serviceName,
                (k, v) -> new LinkedHashSet<>()
            ).add(implName);
        }
    }

    // Now produce the resource(s) for the SPI files
    for (Map.Entry<String, Set<String>> entry : map.entrySet()) {
        String serviceName = entry.getKey();
        try (ByteArrayOutputStream os = new ByteArrayOutputStream()) {
            try (OutputStreamWriter w = new OutputStreamWriter(os, StandardCharsets.UTF_8)) {
                for (String implName : entry.getValue()) {
                    w.write(implName);
                    w.write(System.lineSeparator());
                }
            }
            w.flush();
            resourceProducer.produce(
                new GeneratedResourceBuildItem(
                    "META-INF/services/" + serviceName,
                    os.toByteArray()
                )
            );
        }
    }
}
----

[id='empty-build-items']
===== Empty build items

Empty build items are final (usually empty) classes which extend `io.quarkus.builder.item.EmptyBuildItem`.
They represent build items that don't actually carry any data, and allow such items to be produced and consumed
without having to instantiate empty classes.  They cannot themselves be instantiated.

.Example of an empty build item
[source%nowrap,java]
----
public final class NativeImageBuildItem extends EmptyBuildItem {
    // empty
}
----

Empty build items can represent "barriers" which can impose ordering between steps.  They can also be used in
the same way that popular build systems use "pseudo-targets", which is to say that the build item can represent a
conceptual goal that does not have a concrete representation.

.Example of usage of an empty build item in a "pseudo-target" style
[source%nowrap,java]
----
/**
 * Contrived build step that produces the native image on disk.  The main augmentation
 * step (which is run by Maven or Gradle) would be declared to consume this empty item,
 * causing this step to be run.
 */
@BuildStep
@Produces(NativeImageBuildItem.class)
void produceNativeImage() {
    // ...
    // (produce the native image)
    // ...
}
----

.Example of usage of an empty build item in a "barrier" style
[source%nowrap,java]
----
/**
 * This would always run after {@link #produceNativeImage()} completes, producing
 * an instance of {@code SomeOtherBuildItem}.
 */
@BuildStep
@Consumes(NativeImageBuildItem.class)
SomeOtherBuildItem secondBuildStep() {
    return new SomeOtherBuildItem("foobar");
}
----

[id='injection']
==== Injection

Classes which contain build steps support the following types of injection:

- Constructor parameter injection
- Field injection
- Method parameter injection (for build step methods only)

Build step classes are instantiated and injected for each build step invocation, and are discarded afterwards.  State
should only be communicated between build steps by way of build items, even if the steps are on the same class.

NOTE: Final fields are not considered for injection, but can be populated by way of constructor parameter injection
if desired.  Static fields are never considered for injection.

The types of values that can be injected include:

- <<build-items,Build items>> produced by previous build steps
- <<producing-values,Build producers>> to produce items for subsequent build steps
- <<configuration-roots,Configuration root>> types
- Template objects for <<bytecode-recording,bytecode recording>>

WARNING: Objects which are injected into a build step method or its class _must not_ be used outside of that method's
execution.

NOTE: Injection is resolved at compile time via an annotation processor,
and the resulting code does not have permission to inject private fields or invoke private methods.

[id='producing-values']
==== Producing values

A build step may produce values for subsequent steps in several possible ways:

- By returning a <<simple-build-items,simple build item>> or <<multi-build-items,multi build item>> instance
- By returning a `List` of a multi build item class
- By injecting a `BuildProducer` of a simple or multi build item class
- By annotating the method with `@io.quarkus.deployment.annotations.Produces`, giving the class name of a
<<empty-build-items,empty build item>>

If a simple build item is declared on a build step, it _must_ be produced during that build step, otherwise an error
will result.  Build producers which are injected into steps _must not_ be used outside of that step.

Note that a `@BuildStep` method will only be called if it produces something that another consumer or the final output
requires. If there is no consumer for a particular item then it will not be produced. What is required will depend on
the final target that is being produced.  For example, when running in developer mode the final output will not ask
for GraalVM-specific build items such as `ReflectiveClassBuildItem`, so methods that only produce these
items will not be invoked.

[id='consuming-values']
==== Consuming values

A build step may consume values from previous steps in the following ways:

- By injecting a <<simple-build-items,simple build item>>
- By injecting an `Optional` of a simple build item class
- By injecting a `List` of a <<multi-build-items,multi build item>> class
- By annotating the method with `@io.quarkus.deployment.annotations.Consumes`, giving the class name of a
<<empty-build-items,empty build item>>

Normally it is an error for a step which is included to consume a simple build item that is not produced by any other
step.  In this way, it is guaranteed that all of the declared values will be present and non-`null` when a step is run.

Sometimes a value isn't necessary for the build to complete, but might inform some behavior of the build step if it is
present.  In this case, the value can be optionally injected.

NOTE: Multi build values are always considered _optional_.  If not present, an empty list will be injected.

[id='producing-weak-values']
===== Weak value production

Normally a build step is included whenever it produces any build item which is in turn consumed by any other build step.  In this way,
only the steps necessary to produce the final artifact(s) are included, and steps which pertain to extensions which are
not installed or which only produce build items which are not relevant for the given artifact type are excluded.

For cases where this is not desired behavior, the `@io.quarkus.deployment.annotations.Weak` annotation may be used.  This
annotation indicates that the build step should not automatically be included solely on the basis of producing the annotated value.

.Example of producing a build item weakly
[source%nowrap,java]
----
/**
 * This build step is only run if something consumes the ExecutorClassBuildItem.
 */
@BuildStep
void createExecutor(
        @Weak BuildProducer<GeneratedClassBuildItem> classConsumer,
        BuildProducer<ExecutorClassBuildItem> executorClassConsumer
) {
        ClassWriter cw = new ClassWriter(Opcodes.ASM7);
        String className = generateClassThatCreatesExecutor(cw); // <1>
        classConsumer.produce(new GeneratedClassBuildItem(true, className, cw.toByteArray()));
        executorClassConsumer.produce(new ExecutorClassBuildItem(className));
}
----
<1> This method (not provided in this example) would generate the class using the ASM API.

Certain types of build items are generally always consumed, such as generated classes or resources.
An extension might produce a build item along with a generated class to facilitate the usage
of that build item.  Such a build step would use the `@Weak` annotation on the generated class build item, while normally
producing the other build item.  If the other build item is ultimately consumed by something, then the step would run
and the class would be generated.  If nothing consumes the other build item, the step would not be included in the build
process.

In the example above, `GeneratedClassBuildItem` would only be produced if `ExecutorClassBuildItem` is consumed by
some other build step.

Note that when using <<bytecode-recording,bytecode recording>>, the implicitly generated class can be declared to be weak by
using the `optional` attribute of the `@io.quarkus.deployment.annotations.Record` annotation.

.Example of using a bytecode recorder where the generated class is weakly produced
[source%nowrap,java]
----
/**
 * This build step is only run if something consumes the ExecutorBuildItem.
 */
@BuildStep
@Record(value = ExecutionTime.RUNTIME_INIT, optional = true) // <1>
ExecutorBuildItem createExecutor( // <2>
        ExecutorTemplate executorTemplate,
        ThreadPoolConfig threadPoolConfig
) {

    return new ExecutorBuildItem(
        setupTemplate.setupRunTime(
            shutdownContextBuildItem,
            threadPoolConfig,
            launchModeBuildItem.getLaunchMode()
        )
    );
}
----
<1> Note the `optional` attribute.
<2> This example is using recorder proxies; see the section on <<bytecode-recording,bytecode recording>> for more information.

==== Capabilities

The `@BuildStep` annotation has a `providesCapabilities` property that can be used to provide capability information
to other extensions about what is present in the current application. Capabilities are simply strings that are used to
describe an extension. Capabilities should generally be named after an extensions root package, for example the transactions
extension will provide `io.quarkus.transactions`.

To check if a capability is present you can inject the `io.quarkus.deployment.Capabilities` object and call
`isCapabilityPresent`.

Capabilities should be used when checking for the presence of an extension rather than class path based checks.

==== Application Archives

The `@BuildStep` annotation can also register marker files that determine which archives on the class path are considered
to be 'Application Archives', and will therefore get indexed. This is done via the `applicationArchiveMarkers`. For
example the ArC extension registers `META-INF/beans.xml`, which means that all archives on the class path with a `beans.xml`
file will be indexed.

=== Configuration

Configuration in Quarkus is based on SmallRye Config, an implementation of the MicroProfile Config specification.
All of the standard features of MP-Config are supported; in addition, there are several extensions which are made available
by the SmallRye Config project as well as by Quarkus itself.

The value of these properties is configured in a `application.properties` file that follows the MicroProfile config format.

Configuration of Quarkus extensions is injection-based, using annotations.

==== Configuration Keys

Leaf configuration keys are mapped to non-`private` fields via the `@io.quarkus.runtime.annotations.ConfigItem` annotation.

NOTE: Though the SmallRye Config project is used for implementation, the standard `@ConfigProperty` annotation does not have the
same semantics that are needed to support configuration within extensions.

Configuration keys are normally derived from the field names that they are tied to.  This is done by de-camel-casing the name and then
joining the segments with hyphens (`-`).  Some examples:

* `bindAddress` becomes `bind-address`
* `keepAliveTime` becomes `keep-alive-time`
* `requestDNSTimeout` becomes `request-dns-timeout`

The name can also be explicitly specified by giving a `name` attribute to the `@ConfigItem` annotation.

NOTE: Though it is possible to override the configuration key name using the `name` attribute of `@ConfigItem`,
normally this should only be done in cases where (for example) the configuration key name is the same as a Java keyword.

==== Configuration Value types

The type of the field with the `@ConfigItem` annotation determines the conversion that is applied to it.  Quarkus
extensions may use the full range of configuration types made available by SmallRye Config, which includes:

* All primitive types and primitive wrapper types
* `String`
* Any type which has a constructor accepting a single argument of type `String` or `CharSequence`
* Any type which has a static method named `of` which accepts a single argument of type `String`
* Any type which has a static method named `valueOf` or `parse` which accepts a single argument of type `CharSequence` or `String`
* `java.time.Duration`
* `java.util.regex.Pattern`
* `java.nio.file.Path`
* `io.quarkus.runtime.configuration.MemorySize` to represent data sizes
* `java.net.InetSocketAddress`, `java.net.InetAddress` and `org.wildfly.common.net.CidrAddress`
* A `List` or `Optional` of any of the above types
* `OptionalInt`, `OptionalLong`, `OptionalDouble`

In addition, custom converters may be registered by adding their fully qualified class name in file
`META-INF/services/org.eclipse.microprofile.config.spi.Converter`.

Though these implicit converters use reflection, Quarkus will automatically ensure that they are loaded at the appropriate time.

==== Configuration Groups

Configuration values are always collected into grouping classes which are marked with the `@io.quarkus.runtime.annotations.ConfigGroup`
annotation.  These classes contain a field for each key within its group.  In addition, configuration groups can be nested.

==== Configuration Maps

A `Map` can be used for configuration at any position where a configuration group would be allowed.  The key type of such a
map *must* be `String`, and its value may be either a configuration group class or a valid leaf type.  The configuration
key segment following the map's key segment will be used as the key for map values.

[id='configuration-roots']
==== Configuration Roots

Configuration roots are configuration groups that appear in the root of the configuration tree.  A configuration property's full
name is determined by joining the string `quarkus.` with the hyphenated name of the fields that form the path from the root to the
leaf field.  For example, if I define a configuration root group called `ThreadPool`, with a nested group in a field named `sizing`
that in turn contains a field called `minSize`, the final configuration property will be called `quarkus.thread-pool.sizing.min-size`.

A configuration root's name can be given with the `name` property, or it can be inferred from the class name.  If the latter,
then the configuration key will be the class name, minus any `Config` or `Configuration` suffix, broken up by camel-case,
lowercased, and re-joined using hyphens (`-`).

A configuration root's class name can contain an extra suffix segment for the case where there are configuration
roots for multiple <<Configuration Root Phases>>.  Classes which correspond to the `BUILD_TIME` and `BUILD_AND_RUN_TIME_FIXED`
may end with `BuildTimeConfig` or `BuildTimeConfiguration`, and classes which correspond to the `RUN_TIME` phase
may end with `RunTimeConfig` or `RunTimeConfiguration`.

Note: The current implementation is still using injection site to determine the root set, so to avoid migration problems, it
is recommended that the injection site (field or parameter) have the same name as the configuration root class until
this change is complete.

===== Configuration Root Phases

A configuration root dictates when its contained keys are read from configuration, and when they are available to applications.  The phases defined by `io.quarkus.runtime.annotations.ConfigPhase` are as follows:

[cols="<3m,^1,^1,^1,^1,<8",options="header"]
|===
| Phase name
| Read & avail. at build time
| Avail. at run time
| Read during static init
| Re-read during startup (native executable)
| Notes

| BUILD_TIME
| ✓
| ✗
| ✗
| ✗
| Appropriate for things which affect build.

| BUILD_AND_RUN_TIME_FIXED
| ✓
| ✓
| ✗
| ✗
| Appropriate for things which affect build and must be visible for run time code.  Not read from config at run time.

| RUN_TIME
| ✗
| ✓
| ✓
| ✓
| Not available at build, read at start in all modes.

|===

For all cases other than the `BUILD_TIME` case, the configuration root class and all of the configuration groups and types contained therein must be located in, or reachable from, the extension's run time artifact.  Configuration roots of phase `BUILD_TIME` may be located in or reachable from either of the extension's run time or deployment artifacts.

==== Configuration Example

[source%nowrap,java]
----
import io.quarkus.runtime.annotations.ConfigItem;
import io.quarkus.runtime.annotations.ConfigGroup;
import io.quarkus.runtime.annotations.DefaultConverter

import java.io.File;
import java.util.logging.Level;

@ConfigGroup <1>
public class FileConfig {

    /**
     * Enable logging to a file.
     */
    @ConfigItem(defaultValue = "true")
    boolean enable;

    /**
     * The log format.
     */
    @ConfigItem(defaultValue = "%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{1.}] (%t) %s%e%n")
    String format;

    /**
     * The level of logs to be written into the file.
     */
    @DefaultConverter
    @ConfigItem(defaultValue = "ALL")
    Level level;

    /**
     * The name of the file in which logs will be written.
     */
    @ConfigItem(defaultValue = "application.log")
    File path;

}

/**
 * Logging configuration.
 */
@ConfigRoot(phase = ConfigPhase.RUN_TIME) <2>
public class LogConfiguration {

    // ...

    /**
     * Configuration properties for the logging file handler.
     */
    FileConfig file;
}

public class LoggingProcessor {
    // ...

    /**
     * Logging configuration.
     */
    <3>
    LogConfiguration config;
}
----

A configuration property name can be split into segments. For example, a property name like
`quarkus.log.file.enable` can be split into the following segments:

* `quarkus` - a namespace claimed by Quarkus which is a prefix for all `@ConfigRoot` classes,
* `log` - a name segment which corresponds to the `LogConfiguration` class annotated with `@ConfigRoot`,
* `file` - a name segment which corresponds to the `file` field in this class,
* `enabled` - a name segment which corresponds to `enable` field in `FileConfig` class annotated with `@ConfigGroup`.

<1> The `FileConfig` class is annotated with `@ConfigGroup` to indicate that this is an aggregate
configuration object containing a collection of configurable properties, rather than being a simple configuration
key type.
<2> The `@ConfigRoot` annotation indicates that this object is a configuration root group, in this case one which
corresponds to a `log` segment. A class name is used to link configuration root group with the segment from a
property name. The `Configuration` part is stripped off from a `LogConfiguration` class name and the remaining `Log`
is lowercased to become a `log`. Since all `@ConfigRoot` annotated classes uses `quarkus` as a prefix, this finally
becomes `quarkus.log` and represents the properties which names begin with `quarkus.log.*`.
<3> Here the `LoggingProcessor` injects a `LogConfiguration` instance automatically by detecting the `@ConfigRoot`
annotation.

A corresponding `application.properties` for the above example could be:

[source%nowrap,properties]
----
quarkus.log.file.enable=true
quarkus.log.file.level=DEBUG
quarkus.log.file.path=/tmp/debug.log
----

Since `format` is not defined in these properties, the default value from `@ConfigItem` will be used instead.

=== Conditional Step Inclusion

It is possible to only include a given `@BuildStep` under certain conditions.  The `@BuildStep` annotation
has two optional parameters: `onlyIf` and `onlyIfNot`.  These parameters can be set to one or more classes
which implement `BooleanSupplier`.  The build step will only be included when the method returns
`true` (for `onlyIf`) or `false` (for `onlyIfNot`).

The condition class can inject <<configuration-roots,configuration roots>> as long as they belong to
a build-time phase.  Run time configuration is not available for condition classes.

The condition class may also inject a value of type `io.quarkus.runtime.LaunchMode`.
Constructor parameter and field injection is supported.

.An example of a conditional build step
[source%nowrap,java]
----
@BuildStep(onlyIf = IsDevMode.class)
LogCategoryBuildItem enableDebugLogging() {
    return new LogCategoryBuildItem("org.your.quarkus.extension", Level.DEBUG);
}

static class IsDevMode implements BooleanSupplier {
    LaunchMode launchMode;

    public boolean getAsBoolean() {
        return launchMode == LaunchMode.DEVELOPMENT;
    }
}
----

==== Enhanced conversion
You can use enhanced conversion of a config item by using the `@ConvertWith` annotation which accepts a `Converter` class object.
If the annotation is present on a config item, the implicit or custom built in converter in use will be overridden by the value provided.
To do, see the example below which converts `YES` or `NO` values to `boolean`.
[source%nowrap,java]
----
@ConfigRoot
public class SomeConfig {
    /**
     * Config item with enhanced converter
     */
    @ConvertWith(YesNoConverter.class) // <1>
    @ConfigItem(defaultValue = "NO")
    Boolean answer;


    public static class YesNoConverter implements Converter<Boolean> {

        public YesNoConverter() {}

        @Override
        public Boolean convert(String s) {
            if (s == null || s.isEmpty()) {
                return false;
            }

            switch (s) {
                case "YES":
                    return true;
                case "NO":
                    return false;
            }

            throw new IllegalArgumentException("Unsupported value " + s + " given");
        }
    }
}
----
1. Override the default `Boolean` converter and use the provided converter which accepts a `YES` or `NO` config values.


The corresponding `application.properties` will look like.
[source%nowrap,properties]
----
quarkus.some.answer=YES
----

[NOTE]
=====
Enum values (config items) are translated to skewed-case (hyphenated) by default. The table below illustrates an enum name and their canonical equivalence:

|===
|Java enum| Canonical equivalent

|DISCARD
|discard

|READ_UNCOMMITTED
|read-uncommitted

|SIGUSR1
|sigusr1

|JavaEnum
|java-enum

|MAKING_LifeDifficult
|making-life-difficult

|YeOldeJBoss
|ye-olde-jboss

|camelCaseEnum
|camel-case-enum

|===

To use the default behaviour which is based on implicit converter or a custom defined one add `@DefaultConverter` annotation to the configuration item
[source%nowrap,java]
----
@ConfigRoot
public class SomeLogConfig {
    /**
     * The level of logs to be written into the file.
     */
    @DefaultConverter // <1>
    @ConfigItem(defaultValue = "ALL")
    Level level;
}
----
1. Use the default converter (built in or a custom converter) to convert `Level.class` enum.
=====


[id='bytecode-recording']
=== Bytecode Recording

One of the main outputs of the build process is recorded bytecode. This bytecode actually sets up the runtime environment. For example, in order to start Undertow, the resulting application will have some bytecode that directly registers all
Servlet instances and then starts Undertow.

As writing bytecode directly is complex, this is instead done via bytecode recorders. At deployment time,
invocations are made on recorder objects that contain the actual runtime logic, but instead of these invocations
proceeding as normal they are intercepted and recorded (hence the name). This recording is then used to generate bytecode
that performs the same sequence of invocations at runtime. This is essentially a form of deferred execution where invocations
made at deployment time get deferred until runtime.

Let's look at the classic 'Hello World' type example. To do this the Quarkus way we would create a recorder as follows:

[source%nowrap,java]
----
@Recorder
class HelloRecorder {

  public void sayHello(String name) {
    System.out.println("Hello" + name);
  }

}
----

And then create a build step that uses this recorder:

[source%nowrap,java]
----
@Record(RUNTIME_INIT)
@BuildStep
public void helloBuildStep(HelloRecorder recorder) {
    recorder.sayHello("World");
}
----

When this build step is run nothing is printed to the console. This is because the `HelloRecorder` that is injected is
actually a proxy that records all invocations. Instead if we run the resulting Quarkus program we will see 'Hello World'
printed to the console.


Methods on a recorder can return a value, which must be proxiable (if you want to return a non-proxiable item wrap it
in `io.quarkus.runtime.RuntimeValue`). These proxies may not be invoked directly, however they can be passed
into other recorder methods. This can be any recorder method, including from other `@BuildStep` methods, so a common pattern
is to produce `BuildItem` instances that wrap the results of these recorder invocations.

For instance, in order to make arbitrary changes to a Servlet deployment Undertow has a `ServletExtensionBuildItem`,
which is a `MultiBuildItem` that wraps a `ServletExtension` instance. I can return a `ServletExtension` from a recorder
in another module, and Undertow will consume it and pass it into the recorder method that starts Undertow.

At runtime the bytecode will be invoked in the order it is generated. This means that build step dependencies implicitly
control the order that generated bytecode is run. In the example above we know that the bytecode that produces a
`ServletExtensionBuildItem` will be run before the bytecode that consumes it.


==== RecorderContext

`io.quarkus.deployment.recording.RecorderContext` provides some convenience methods to enhance bytecode recording,
this includes the ability to register creation functions for classes without no-arg constructors, to register an object
substitution (basically a transformer from a non-serializable object to a serializable one and vice versa), and to create
a class proxy. This interface can be directly injected as a method parameter into any `@Record` method.

Calling `classProxy` with a given class name will create a `Class` that can be passed into recorder
methods, and at runtime will be substituted with the class whose name was passed in to `classProxy`. This is basically a
convenience to avoid the need to explicitly load classes in the recorders.

////
TODO: config integration
////
=== Contexts and Dependency Injection

==== Extension Points

As a CDI based runtime, Quarkus extensions often make CDI beans available as part of the extension behavior.
However, Quarkus DI solution does not support CDI Portable Extensions.
Instead, Quarkus extensions can make use of various link:cdi-reference.html[Build Time Extension Points].

=== Extension Health Check

Health checks are provided via the `quarkus-smallrye-health` extension. It provides both liveness and readiness checks capabilities.

When writing an extension, it's beneficial to provide health checks for the extension, that can be automatically included without the developer needing to write their own.

In order to provide a health check, you should do the following:

- Import the `quarkus-smallrye-health` extension as an **optional** dependency in your runtime module so it will not impact the size of the application if
health check is not included.
- Create your health check following the link:microprofile-health.html[Quarkus - MicroProfile Health] guide. We advise providing only
readiness check for an extension (liveness check is designed to express the fact that an application is up and needs to be lightweight).
- Import the `quarkus-smallrye-health-spi` library in your deployment module.
- Add a build step in your deployment module that produces a `HealthBuildItem`.
- Add a way to disable the extension health check via a config item `quarkus.<extension>.health.enabled` that should be enabled by default.

Following is an example from the Agroal extension that provides a `DataSourceHealthCheck` to validate the readiness of a datasource.

[source%nowrap,java]
----
@BuildStep
HealthBuildItem addHealthCheck(AgroalBuildTimeConfig agroalBuildTimeConfig) {
    return new HealthBuildItem("io.quarkus.agroal.runtime.health.DataSourceHealthCheck",
            agroalBuildTimeConfig.healthEnabled, "datasource");
}
----

=== Customizing JSON handling from an extension
Extensions often need to register serializers and/or deserializers for types the extension provides.

For this, both JSON-B and Jackson extension provide a way to register serializer/deserializer from within an
extension deployment module.

Keep in mind that not everybody will need JSON, so you need to make it optional.

If an extension intends to provide JSON related customization,
it is strongly advised to provide customization for both JSON-B and Jackson.

==== Customizing JSON-B
First, add an *optional* dependency to `quarkus-jsonb` on your extension's runtime module.

[source%nowrap,xml]
----
<dependency>
  <groupId>io.quarkus</groupId>
  <artifactId>quarkus-jsonb</artifactId>
  <optional>true</optional>
</dependency>
----

Then create a serializer and/or a deserializer for JSON-B, an example of which can be seen in the `mongodb-panache` extension.

[source%nowrap,java]
----
public class ObjectIdSerializer implements JsonbSerializer<ObjectId> {
    @Override
    public void serialize(ObjectId obj, JsonGenerator generator, SerializationContext ctx) {
        if (obj != null) {
            generator.write(obj.toString());
        }
    }
}
----

Add a dependency to `quarkus-jsonb-spi` on your extension's deployment module.

[source%nowrap,xml]
----
<dependency>
  <groupId>io.quarkus</groupId>
  <artifactId>quarkus-jsonb-spi</artifactId>
</dependency>
----

Add a build step to your processor to register the serializer via the `JsonbSerializerBuildItem`.

[source%nowrap,java]
----
@BuildStep
JsonbSerializerBuildItem registerJsonbSerializer() {
    return new JsonbSerializerBuildItem(io.quarkus.mongodb.panache.jsonb.ObjectIdSerializer.class.getName()));
}
----

The JSON-B extension will then use the produced build item to register your serializer/deserializer automatically.

If you need more customization capabilities than registering a serializer or a deserializer,
you can produce a CDI bean that implements `io.quarkus.jsonb.JsonbConfigCustomizer` via an `AdditionalBeanBuildItem`.
More info about customizing JSON-B can be found on the JSON guide link:rest-json.html#configuring-json-support[Configuring JSON support]

==== Customizing Jackson

First, add an *optional* dependency to `quarkus-jackson` on your extension's runtime module.

[source%nowrap,xml]
----
<dependency>
  <groupId>io.quarkus</groupId>
  <artifactId>quarkus-jackson</artifactId>
  <optional>true</optional>
</dependency>
----

Then create a serializer or a deserializer (or both) for Jackson, an example of which can be seen in the `mongodb-panache` extension.

[source%nowrap,java]
----
public class ObjectIdSerializer extends StdSerializer<ObjectId> {
    public ObjectIdSerializer() {
        super(ObjectId.class);
    }
    @Override
    public void serialize(ObjectId objectId, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
            throws IOException {
        if (objectId != null) {
            jsonGenerator.writeString(objectId.toString());
        }
    }
}
----

Add a dependency to `quarkus-jackson-spi` on your extension's deployment module.

[source%nowrap,xml]
----
<dependency>
  <groupId>io.quarkus</groupId>
  <artifactId>quarkus-jackson-spi</artifactId>
</dependency>
----

Add a build step to your processor to register a Jackson module via the `JacksonModuleBuildItem`.
You need to name your module in a unique way across all Jackson modules.

[source%nowrap,java]
----
@BuildStep
JacksonModuleBuildItem registerJacksonSerDeser() {
    return new JacksonModuleBuildItem.Builder("ObjectIdModule")
                    .add(io.quarkus.mongodb.panache.jackson.ObjectIdSerializer.class.getName(),
                            io.quarkus.mongodb.panache.jackson.ObjectIdDeserializer.class.getName(),
                            ObjectId.class.getName())
                    .build();
}
----

The Jackson extension will then use the produced build item to register a module within Jackson automatically.

If you need more customization capabilities than registering a module,
you can produce a CDI bean that implements `io.quarkus.jackson.ObjectMapperCustomizer` via an `AdditionalBeanBuildItem`.
More info about customizing Jackson can be found on the JSON guide link:rest-json.html#configuring-json-support[Configuring JSON support]

=== Testing Extensions

Testing of extensions should be done with the `io.quarkus.test.QuarkusUnitTest` runner. This runner allows
for Arquillian-style tests that test specific functionalities. It is not intended for testing user applications, as this
should be done via `io.quarkus.test.junit.QuarkusTest`. The main difference between these test runners is that
`QuarkusTest` simply boots the application once at the start of the run, while `QuarkusUnitTest` deploys a custom
Quarkus application for each test class.

These tests should be placed in the deployment module, if additional Quarkus modules are required for testing
their deployment modules should also be added as test scoped dependencies.

Note that `QuarkusUnitTest` is in the `quarkus-junit5-internal` module.

An example test class may look like:

[source,java]
----
package io.quarkus.health.test;

import static org.junit.jupiter.api.Assertions.assertEquals;

import java.util.ArrayList;
import java.util.List;

import javax.enterprise.inject.Instance;
import javax.inject.Inject;

import org.eclipse.microprofile.health.Health;
import org.eclipse.microprofile.health.HealthCheck;
import org.eclipse.microprofile.health.HealthCheckResponse;
import io.quarkus.test.QuarkusUnitTest;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.EmptyAsset;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.restassured.RestAssured;

public class FailingUnitTest {


    @RegisterExtension                                                                  // <1>
    static final QuarkusUnitTest config = new QuarkusUnitTest()
            .setArchiveProducer(() ->
                    ShrinkWrap.create(JavaArchive.class)                                // <2>
                            .addClasses(FailingHealthCheck.class)
                            .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml")
            );
    @Inject                                                                             // <3>
    @Health
    Instance<HealthCheck> checks;

    @Test
    public void testHealthServlet() {
        RestAssured.when().get("/health").then().statusCode(503);                       // <4>
    }

    @Test
    public void testHealthBeans() {
        List<HealthCheck> check = new ArrayList<>();                                    // <5>
        for (HealthCheck i : checks) {
            check.add(i);
        }
        assertEquals(1, check.size());
        assertEquals(HealthCheckResponse.State.DOWN, check.get(0).call().getState());
    }
}
----


<1> This tells JUnit to use the Quarkus unit test runner
<2> This producer is used to build the application to be tested. It uses Shrinkwrap to create a JavaArchive to test
<3> It is possible to inject beans from our test deployment directly into the test case
<4> This method directly invokes the health check Servlet and verifies the response
<5> This method uses the injected health check bean to verify it is returning the expected result

If you want to test that an extension properly fails at build time, use the `setExpectedException` method:

[source,java]
----

package io.quarkus.hibernate.orm;

import io.quarkus.deployment.configuration.ConfigurationError;
import io.quarkus.test.QuarkusUnitTest;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

public class PersistenceAndQuarkusConfigTest {

    @RegisterExtension
    static QuarkusUnitTest runner = new QuarkusUnitTest()
            .setExpectedException(ConfigurationError.class)                     <1>
            .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
                    .addAsManifestResource("META-INF/some-persistence.xml", "persistence.xml")
                    .addAsResource("application.properties"));

    @Test
    public void testPersistenceAndConfigTest() {
        // should not be called, deployment exception should happen first:
        // it's illegal to have Hibernate configuration properties in both the
        // application.properties and in the persistence.xml
        Assertions.fail();
    }

}
----

<1> This tells JUnit that the Quarkus deployment should fail with a specific exception


=== Testing hot reload

It is also possible to write tests that verify an extension works correctly in development mode and can correctly
handle updates.

For most extensions this will just work 'out of the box', however it is still a good idea to have a smoke test to
verify that this functionality is working as expected. To test this we use `QuarkusDevModeTest`:


[source,java]
----
public class ServletChangeTestCase {

    @RegisterExtension
    final static QuarkusDevModeTest test = new QuarkusDevModeTest()
            .setArchiveProducer(new Supplier<JavaArchive>() {
                @Override
                public JavaArchive get() {
                    return ShrinkWrap.create(JavaArchive.class)   <1>
                            .addClass(DevServlet.class)
                            .addAsManifestResource(new StringAsset("Hello Resource"), "resources/file.txt");
                }
            });

    @Test
    public void testServletChange() throws InterruptedException {
        RestAssured.when().get("/dev").then()
                .statusCode(200)
                .body(is("Hello World"));

        test.modifySourceFile("DevServlet.java", new Function<String, String>() {  <2>

            @Override
            public String apply(String s) {
                return s.replace("Hello World", "Hello Quarkus");
            }
        });

        RestAssured.when().get("/dev").then()
                .statusCode(200)
                .body(is("Hello Quarkus"));
    }

    @Test
    public void testAddServlet() throws InterruptedException {
        RestAssured.when().get("/new").then()
                .statusCode(404);

        test.addSourceFile(NewServlet.class);                                       <3>

        RestAssured.when().get("/new").then()
                .statusCode(200)
                .body(is("A new Servlet"));
    }

    @Test
    public void testResourceChange() throws InterruptedException {
        RestAssured.when().get("/file.txt").then()
                .statusCode(200)
                .body(is("Hello Resource"));

        test.modifyResourceFile("META-INF/resources/file.txt", new Function<String, String>() { <4>

            @Override
            public String apply(String s) {
                return "A new resource";
            }
        });

        RestAssured.when().get("file.txt").then()
                .statusCode(200)
                .body(is("A new resource"));
    }

    @Test
    public void testAddResource() throws InterruptedException {

        RestAssured.when().get("/new.txt").then()
                .statusCode(404);

        test.addResourceFile("META-INF/resources/new.txt", "New File");  <5>

        RestAssured.when().get("/new.txt").then()
                .statusCode(200)
                .body(is("New File"));

    }
}
----

<1> This starts the deployment, your test can modify it as part of the test suite. Quarkus will be restarted between
each test method so every method starts with a clean deployment.

<2> This method allows you to modify the source of a class file. The old source is passed into the function, and the updated
source is returned.

<3> This method adds a new class file to the deployment. The source that is used will be the original source that is part
of the current project.

<4> This method modifies a static resource

<5> This method adds a new static resource

=== Native Executable Support

There Quarkus provides a lot of build items that control aspects of the native executable build. This allows for extensions
to programmatically perform tasks such as registering classes for reflection or adding static resources to the native
executable. Some of these build items are listed below:

`io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem`::
 Includes static resources into the native executable.

`io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem`::
A class that will be reinitialized at runtime by Substrate. This will result in the static initializer running twice.

`io.quarkus.deployment.builditem.nativeimage.NativeImageSystemPropertyBuildItem`::
A system property that will be set at native executable build time.

`io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBundleBuildItem`::
Includes a resource bundle in the native executable.

`io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem`::
Registers a class for reflection in Substrate. Constructors are always registered, while methods and fields are optional.

`io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem`::
A class that will be initialized at runtime rather than build time. This will cause the build to fail if the class is initialized as part of the native executable build process, so care must be taken.

`io.quarkus.deployment.builditem.nativeimage.NativeImageConfigBuildItem`::
A convenience feature that allows you to control most of the above features from a single build item.

`io.quarkus.deployment.builditem.NativeEnableAllCharsetsBuildItem`::
Indicates that all charsets should be enabled in native image.

`io.quarkus.deployment.builditem.ExtensionSslNativeSupportBuildItem`::
A convenient way to tell Quarkus that the extension requires SSL and it should be enabled during native image build.
When using this feature, remember to add your extension to the list of extensions that offer SSL support automatically on the https://github.com/quarkusio/quarkus/blob/master/docs/src/main/asciidoc/native-and-ssl.adoc[native and ssl guide].

=== IDE support tips

==== Writing Quarkus extensions in Eclipse

The only particular aspect of writing Quarkus extensions in Eclipse is that APT (Annotation Processing Tool) is required as part of extension builds, which means you need to:

- Install `m2e-apt` from https://marketplace.eclipse.org/content/m2e-apt
- Define this property in your `pom.xml`: `<m2e.apt.activation>jdt_apt</m2e.apt.activation>`, although if you rely on `io.quarkus:quarkus-build-parent` you will get it for free.
- If you have the `io.quarkus:quarkus-extension-processor` project open at the same time in your IDE (for example, if you have the Quarkus sources checked out and open in your IDE) you will need to close that project. Otherwise, Eclipse will not invoke the APT plugin that it contains.
- If you just closed the extension processor project, be sure to do `Maven > Update Project` on the other projects in order for Eclipse to pick up the extension processor from the Maven repository.

=== Troubleshooting / Debugging Tips

==== Saving Application Generated Classes to Disk

The class augmentation step of Quarkus generates classes for various purposes. Sometimes you need to view these
classes/bytecode to debug or understand an issue. Classes that are related to application augmentation are currently held in
memory in a runtime class loader.

When using the dev mode (running `mvn clean compile quarkus:dev`) you can have these classes written out to disk for inspection, for this, you need to specify the
`quarkus.debug.generated-classes-dir` system property, for example:

[source,shell]
----
./mvnw clean compile quarkus:dev -Dquarkus.debug.generated-classes-dir=app-generated-classes
----

You will see a line of log for each class outputed to the directory:

[source,shell]
----
2019-10-25 18:12:34,262 INFO  [io.qua.run.RuntimeClassLoader] (main) Wrote /path/to/my/app/target/generated-devmode/io.quarkus.runner.GeneratedMain.class
----

==== Multi-module Maven Projects and the Development Mode

It's not uncommon to develop an extension in a multi-module Maven project that also contains an "example" module.
However, if you want to run the example in the development mode then the `-DnoDeps` system property must be used in order to exclude the local project dependencies.
Otherwise, Quarkus attempts to monitor the extension classes and this may result in weird class loading issues.

[source,shell]
----
./mvnw compile quarkus:dev -DnoDeps
----

=== Sample Test Extension
We have an extension that is used to test for regressions in the extension processing. It is located in {quarkus-tree-url}/core/test-extension directory. In this section we touch on some of the tasks an extension
author will typically need to perform using the test-extension code to illustrate how the task could be done.

==== Features and Capabilities
When you start a Quarkus instance, you will see a line like the one highlighted in this example:

.Example Startup Lines
[source, bash]
----
2019-03-22 14:02:37,884 INFO  [io.quarkus] (main) Quarkus 999-SNAPSHOT started in 0.061s.
2019-03-22 14:02:37,884 INFO  [io.quarkus] (main) Installed features: [cdi, test-extension] <1>
----
<1> A list of features installed in the runtime image

The features listed reflect the types of extensions that are installed. An extension declares its display name
 using a <<Build Step Processors>> method that produces a `FeatureBuildItem` like this TestProcessor#featureBuildItem() method example:


.TestProcessor#featureBuildItem()
[source,java]
----
    /**
     * Register a extension capability and feature
     *
     * @return test-extension feature build item
     */
    @BuildStep(providesCapabilities = "io.quarkus.test-extension")
    FeatureBuildItem featureBuildItem() {
        return new FeatureBuildItem("test-extension");
    }
----

The feature name should map to a label in the extension's devtools/common/src/main/filtered/extensions.json entry so that
the feature name displayed by the startup line matches a label that one can used to select the extension when creating a project
using the Quarkus maven plugin as shown in this example taken from the Writing JSON REST Services guide where the "resteasy-jsonb" feature is referenced:

[source,shell,subs=attributes+]
----
mvn io.quarkus:quarkus-maven-plugin:{quarkus-version}:create \
    -DprojectGroupId=org.acme \
    -DprojectArtifactId=rest-json \
    -DclassName="org.acme.rest.json.FruitResource" \
    -Dpath="/fruits" \
    -Dextensions="resteasy-jsonb"
cd rest-json
----

==== Bean Defining Annotations
The CDI layer processes CDI beans that are either explicitly registered or that it discovers based on bean defining annotations as defined in http://docs.jboss.org/cdi/spec/2.0/cdi-spec.html#bean_defining_annotations">[2.5.1. Bean defining annotations]. You can expand this set of annotations to include annotations your extension processes using a `BeanDefiningAnnotationBuildItem` as shown in this `TestProcessor#registerBeanDefinningAnnotations` example:

.Register a Bean Definining Annotation
[source,java]
----
import javax.enterprise.context.ApplicationScoped;
import org.jboss.jandex.DotName;
import io.quarkus.extest.runtime.TestAnnotation;

public final class TestProcessor {
    static DotName TEST_ANNOTATION = DotName.createSimple(TestAnnotation.class.getName());
    static DotName TEST_ANNOTATION_SCOPE = DotName.createSimple(ApplicationScoped.class.getName());

...

    @BuildStep
    BeanDefiningAnnotationBuildItem registerX() {
        <1>
        return new BeanDefiningAnnotationBuildItem(TEST_ANNOTATION, TEST_ANNOTATION_SCOPE);
    }
...
}

/**
 * Marker annotation for test configuration target beans
 */
@Target({ TYPE })
@Retention(RUNTIME)
@Documented
@Inherited
public @interface TestAnnotation {
}

/**
 * A sample bean
 */
@TestAnnotation <2>
public class ConfiguredBean implements IConfigConsumer {

...
----
<1> Register the annotation class and CDI default scope using the Jandex `DotName` class.
<2> `ConfiguredBean` will be processed by the CDI layer the same as a bean annotated with the CDI standard @ApplicationScoped.

==== Parsing Config to Objects
One of the main things an extension is likely to do is completely separate the configuration phase of behavior from the runtime phase. Frameworks often do parsing/load of configuration on startup that can be done during build time to both reduce the runtime dependencies on frameworks like xml parsers as well as reducing the startup time the parsing incurs.

An example of parsing a XML config file using JAXB is shown in the `TestProcessor#parseServiceXmlConfig` method:
.Parsing an XML Configuration into Runtime XmlConfig Instance
[source,java]
----
    @BuildStep
    @Record(STATIC_INIT)
    RuntimeServiceBuildItem parseServiceXmlConfig(TestRecorder recorder) throws JAXBException {
        RuntimeServiceBuildItem serviceBuildItem = null;
        JAXBContext context = JAXBContext.newInstance(XmlConfig.class);
        Unmarshaller unmarshaller = context.createUnmarshaller();
        InputStream is = getClass().getResourceAsStream("/config.xml"); <1>
        if (is != null) {
            log.infof("Have XmlConfig, loading");
            XmlConfig config = (XmlConfig) unmarshaller.unmarshal(is); <2>
...
        }
        return serviceBuildItem;
    }

----
<1> Look for a config.xml classpath resource
<2> If found, parse using JAXB context for `XmlConfig.class`

[NOTE]
====
If there was no /config.xml resource available in the build environment, then a null `RuntimeServiceBuildItem` would be returned and no subsequent logic based on a `RuntimeServiceBuildItem` being produced would execute.
====

Typically one is loading a configuration to create some runtime component/service as `parseServiceXmlConfig` is doing. We will come back to the rest of the behavior in `parseServiceXmlConfig` in the following <<Manage Non-CDI Service>> section.

If for some reason you need to parse the config and use it in other build steps in an extension processor, you would need to create an `XmlConfigBuildItem` to pass the parsed XmlConfig instance around.

[TIP]
====
If you look at the XmlConfig code you will see that it does carry around the JAXB annotations. If you don't want these in the runtime image, you could clone the XmlConfig instance into some POJO object graph and then replace XmlConfig with the POJO class. We will do this in <<Replacing Classes in the Native Image>>.
====

==== Scanning Deployments Using Jandex
If your extension defines annotations or interfaces that mark beans needing to be processed, you can locate these beans using the Jandex API, a Java annotation indexer and offline reflection library. The following `TestProcessor#scanForBeans` method shows how to find the beans annotated with our `@TestAnnotation` that also implement the `IConfigConsumer` interface:

.Example Jandex Usage
[source,java]
----
    static DotName TEST_ANNOTATION = DotName.createSimple(TestAnnotation.class.getName());
...

    @BuildStep
    @Record(STATIC_INIT)
    void scanForBeans(TestRecorder recorder, BeanArchiveIndexBuildItem beanArchiveIndex, <1>
            BuildProducer<TestBeanBuildItem> testBeanProducer) {
        IndexView indexView = beanArchiveIndex.getIndex(); <2>
        Collection<AnnotationInstance> testBeans = indexView.getAnnotations(TEST_ANNOTATION); <3>
        for (AnnotationInstance ann : testBeans) {
            ClassInfo beanClassInfo = ann.target().asClass();
            try {
                boolean isConfigConsumer = beanClassInfo.interfaceNames()
                        .stream()
                        .anyMatch(dotName -> dotName.equals(DotName.createSimple(IConfigConsumer.class.getName()))); <4>
                if (isConfigConsumer) {
                    Class<IConfigConsumer> beanClass = (Class<IConfigConsumer>) Class.forName(beanClassInfo.name().toString());
                    testBeanProducer.produce(new TestBeanBuildItem(beanClass)); <5>
                    log.infof("Configured bean: %s", beanClass);
                }
            } catch (ClassNotFoundException e) {
                log.warn("Failed to load bean class", e);
            }
        }
    }
----
<1> Depend on a `BeanArchiveIndexBuildItem` to have the build step be run after the deployment has been indexed.
<2> Retrieve the index.
<3> Find all beans annotated with `@TestAnnotation`.
<4> Determine which of these beans also has the `IConfigConsumer` interface.
<5> Save the bean class in a `TestBeanBuildItem` for use in a latter RUNTIME_INIT build step that will interact with the bean instances.

==== Interacting With Extension Beans
You can use the `io.quarkus.arc.runtime.BeanContainer` interface to interact with your extension beans. The following `configureBeans` methods illustrate interacting with the beans scanned for in the previous section:

.Using CDI BeanContainer Interface
[source,java]
----
// TestProcessor#configureBeans
    @BuildStep
    @Record(RUNTIME_INIT)
    void configureBeans(TestRecorder recorder, List<TestBeanBuildItem> testBeans, <1>
            BeanContainerBuildItem beanContainer, <2>
            TestRunTimeConfig runTimeConfig) {

        for (TestBeanBuildItem testBeanBuildItem : testBeans) {
            Class<IConfigConsumer> beanClass = testBeanBuildItem.getConfigConsumer();
            recorder.configureBeans(beanContainer.getValue(), beanClass, buildAndRunTimeConfig, runTimeConfig); <3>
        }
    }

// TestRecorder#configureBeans
    public void configureBeans(BeanContainer beanContainer, Class<IConfigConsumer> beanClass,
            TestBuildAndRunTimeConfig buildTimeConfig,
            TestRunTimeConfig runTimeConfig) {
        log.infof("Begin BeanContainerListener callback\n");
        IConfigConsumer instance = beanContainer.instance(beanClass); <4>
        instance.loadConfig(buildTimeConfig, runTimeConfig); <5>
        log.infof("configureBeans, instance=%s\n", instance);
    }
----
<1> Consume the `TestBeanBuildItem`s produced from the scanning build step.
<2> Consume the `BeanContainerBuildItem` to order this build step to run after the CDI bean container has been created.
<3> Call the runtime recorder to record the bean interactions.
<4> Runtime recorder retrieves the bean using its type.
<5> Runtime recorder invokes the `IConfigConsumer#loadConfig(...)` method passing in the configuration objects with runtime information.

==== Manage Non-CDI Service
A common purpose for an extension is to integrate a non-CDI aware service into the CDI based Quarkus runtime. Step 1 of this task is to load any configuration needed in a STATIC_INIT build step as we did in <<Parsing Config to Objects>>. Now we need to create an instance of the service using the configuration. Let's return to the `TestProcessor#parseServiceXmlConfig` method to see how this can be done.

.Creating a Non-CDI Service
[source,java]
----
// TestProcessor#parseServiceXmlConfig
    @BuildStep
    @Record(STATIC_INIT)
    RuntimeServiceBuildItem parseServiceXmlConfig(TestRecorder recorder) throws JAXBException {
        RuntimeServiceBuildItem serviceBuildItem = null;
        JAXBContext context = JAXBContext.newInstance(XmlConfig.class);
        Unmarshaller unmarshaller = context.createUnmarshaller();
        InputStream is = getClass().getResourceAsStream("/config.xml");
        if (is != null) {
            log.infof("Have XmlConfig, loading");
            XmlConfig config = (XmlConfig) unmarshaller.unmarshal(is);
            log.infof("Loaded XmlConfig, creating service");
            RuntimeValue<RuntimeXmlConfigService> service = recorder.initRuntimeService(config); //<1>
            serviceBuildItem = new RuntimeServiceBuildItem(service); //<3>
        }
        return serviceBuildItem;
    }

// TestRecorder#initRuntimeService
    public RuntimeValue<RuntimeXmlConfigService> initRuntimeService(XmlConfig config) {
        RuntimeXmlConfigService service = new RuntimeXmlConfigService(config); //<2>
        return new RuntimeValue<>(service);
    }

// RuntimeServiceBuildItem
    final public class RuntimeServiceBuildItem extends SimpleBuildItem {
    private RuntimeValue<RuntimeXmlConfigService> service;

    public RuntimeServiceBuildItem(RuntimeValue<RuntimeXmlConfigService> service) {
        this.service = service;
    }

    public RuntimeValue<RuntimeXmlConfigService> getService() {
        return service;
    }
}
----
<1> Call into the runtime recorder to record the creation of the service.
<2> Using the parsed `XmlConfig` instance, create an instance of `RuntimeXmlConfigService` and wrap it in a `RuntimeValue`. Use a `RuntimeValue` wrapper for non-interface objects that are non-proxiable.
<3> Wrap the return service value in a `RuntimeServiceBuildItem` for use in a RUNTIME_INIT build step that will start the service.

===== Starting a Service
Now that you have recorded the creation of a service during the build phase, you need to record how to start the service at runtime during booting. You do this with a RUNTIME_INIT build step as shown in the `TestProcessor#startRuntimeService` method.

.Starting/Stopping a Non-CDI Service
[source,java]
----
// TestProcessor#startRuntimeService
    @BuildStep
    @Record(RUNTIME_INIT)
    ServiceStartBuildItem startRuntimeService(TestRecorder recorder, ShutdownContextBuildItem shutdownContextBuildItem , // <1>
            RuntimeServiceBuildItem serviceBuildItem) throws IOException { // <2>
        if (serviceBuildItem != null) {
            log.info("Registering service start");
            recorder.startRuntimeService(shutdownContextBuildItem, serviceBuildItem.getService()); // <3>
        } else {
            log.info("No RuntimeServiceBuildItem seen, check config.xml");
        }
        return new ServiceStartBuildItem("RuntimeXmlConfigService"); //<4>
    }

// TestRecorder#startRuntimeService
    public void startRuntimeService(ShutdownContext shutdownContext, RuntimeValue<RuntimeXmlConfigService> runtimeValue)
            throws IOException {
        RuntimeXmlConfigService service = runtimeValue.getValue();
        service.startService(); //<5>
        shutdownContext.addShutdownTask(service::stopService); //<6>
    }
----
<1> We consume a ShutdownContextBuildItem to register the service shutdown.
<2> We consume the previously initialized service captured in `RuntimeServiceBuildItem`.
<3> Call the runtime recorder to record the service start invocation.
<4> Produce a `ServiceStartBuildItem` to indicate the startup of a service. See <<Startup and Shutdown Events>> for details.
<5> Runtime recorder retrieves the service instance reference and calls its `startService` method.
<6> Runtime recorder registers an invocation of the service instance `stopService` method with the Quarkus `ShutdownContext`.

The code for the `RuntimeXmlConfigService` can be viewed here:
{quarkus-blob-url}/core/test-extension/runtime/src/main/java/io/quarkus/extest/runtime/RuntimeXmlConfigService.java[RuntimeXmlConfigService.java]

The testcase for validating that the `RuntimeXmlConfigService` has started can be found in the `testRuntimeXmlConfigService` test of `ConfiguredBeanTest` and `NativeImageIT`.

==== Startup and Shutdown Events
The Quarkus container supports startup and shutdown lifecycle events to notify components of the container startup
and shutdown. There are CDI events fired that components can observe are illustrated in this example:

.Observing Container Startup
[source,java]
----
import io.quarkus.runtime.ShutdownEvent;
import io.quarkus.runtime.StartupEvent;

puclic class SomeBean {
    /**
     * Called when the runtime has started
     * @param event
     */
    void onStart(@Observes StartupEvent event) { // <1>
        System.out.printf("onStart, event=%s%n", event);
    }

    /**
     * Called when the runtime is shutting down
     * @param event
    */
    void onStop(@Observes ShutdownEvent event) { // <2>
        System.out.printf("onStop, event=%s%n", event);
    }
}
----
<1> Observe a `StartupEvent` to be notified the runtime has started.
<2> Observe a 'ShutdownEvent` to be notified when the runtime is going to shutdown.

What is the relevance of startup and shutdown events for extension authors? We have already seen the use of a `ShutdownContext`
to register a callback to perform shutdown tasks in the <<Starting a Service>> section. These shutdown tasks would be called
after a `ShutdownEvent` had been sent.

A `StartupEvent` is fired after all `io.quarkus.deployment.builditem.ServiceStartBuildItem` producers have been consumed.
The implication of this is that if an extension has services that application components would expect to have been
started when they observe a `StartupEvent`, the build steps that invoke the runtime code to start those services needs
to produce a `ServiceStartBuildItem` to ensure that the runtime code is run before the `StartupEvent` is sent. Recall that
we saw the production of a `ServiceStartBuildItem` in the previous section, and it is repeated here for clarity:

.Example of Producing a ServiceStartBuildItem
[source,java]
----
// TestProcessor#startRuntimeService
    @BuildStep
    @Record(RUNTIME_INIT)
    ServiceStartBuildItem startRuntimeService(TestRecorder recorder, ShutdownContextBuildItem shutdownContextBuildItem,
            RuntimeServiceBuildItem serviceBuildItem) throws IOException {
...
        return new ServiceStartBuildItem("RuntimeXmlConfigService"); //<1>
    }
----
<1> Produce a `ServiceStartBuildItem` to indicate that this is a service starting step that needs to run before the `StartupEvent` is sent.

==== Register Resources for Use in Native Image
Not all configuration or resources can be consumed at build time. If you have classpath resources that the runtime needs to access, you need to inform the build phase that these resources need to be copied into the native image. This is done by producing one or more `NativeImageResourceBuildItem` or `NativeImageResourceBundleBuildItem` in the case of resource bundles. Examples of this are shown in this sample `registerNativeImageReources` build step:

.Registering Resources and ResourceBundles
[source,java]
----
public final class MyExtProcessor {
    @Inject
    BuildProducer<NativeImageResourceBuildItem> resource;
    @Inject
    BuildProducer<NativeImageResourceBundleBuildItem> resourceBundle;

    @BuildStep
    void registerNativeImageReources() {
        resource.produce(new NativeImageResourceBuildItem("/security/runtime.keys")); //<1>

        resource.produce(new NativeImageResourceBuildItem(
                "META-INF/services/" + io.quarkus.SomeService.class.getName())); //<2>

        resourceBundle.produce(new NativeImageResourceBuildItem("javax.xml.bind.Messages")); //<3>
    }
}
----
<1> Indicate that the /security/runtime.keys classpath resource should be copied into native image.
<2> Indicate that the `io.quarkus.SomeService` ServiceLoader resource should be copied into native image.
<3> Indicate that the "javax.xml.bind.Messages" resource bundle should be copied into native image.

==== Object Substitution
Objects created during the build phase that are passed into the runtime need to have a default constructor in order for them to be created and configured at startup of the runtime from the build time state. If an object does not have a default constructor you will see an error similar to the following during generation of the augmented artifacts:

.DSAPublicKey Serialization Error
[source,bash]
----
	[error]: Build step io.quarkus.deployment.steps.MainClassBuildStep#build threw an exception: java.lang.RuntimeException: Unable to serialize objects of type class sun.security.provider.DSAPublicKeyImpl to bytecode as it has no default constructor
	at io.quarkus.builder.Execution.run(Execution.java:123)
	at io.quarkus.builder.BuildExecutionBuilder.execute(BuildExecutionBuilder.java:136)
	at io.quarkus.deployment.QuarkusAugmentor.run(QuarkusAugmentor.java:110)
	at io.quarkus.runner.RuntimeRunner.run(RuntimeRunner.java:99)
	... 36 more
----

There is a `io.quarkus.runtime.ObjectSubstitution` interface that can be implemented to tell Quarkus how to handle such classes. An example implementation for the `DSAPublicKey` is shown here:

.DSAPublicKeyObjectSubstitution Example
[source,bash]
----
package io.quarkus.extest.runtime.subst;

import java.security.KeyFactory;
import java.security.NoSuchAlgorithmException;
import java.security.interfaces.DSAPublicKey;
import java.security.spec.InvalidKeySpecException;
import java.security.spec.X509EncodedKeySpec;
import java.util.logging.Logger;

import io.quarkus.runtime.ObjectSubstitution;

public class DSAPublicKeyObjectSubstitution implements ObjectSubstitution<DSAPublicKey, KeyProxy> {
    private static final Logger log = Logger.getLogger("DSAPublicKeyObjectSubstitution");
    @Override
    public KeyProxy serialize(DSAPublicKey obj) { //<1>
        log.info("DSAPublicKeyObjectSubstitution.serialize");
        byte[] encoded = obj.getEncoded();
        KeyProxy proxy = new KeyProxy();
        proxy.setContent(encoded);
        return proxy;
    }

    @Override
    public DSAPublicKey deserialize(KeyProxy obj) { //<2>
        log.info("DSAPublicKeyObjectSubstitution.deserialize");
        byte[] encoded = obj.getContent();
        X509EncodedKeySpec publicKeySpec = new X509EncodedKeySpec(encoded);
        DSAPublicKey dsaPublicKey = null;
        try {
            KeyFactory kf = KeyFactory.getInstance("DSA");
            dsaPublicKey = (DSAPublicKey) kf.generatePublic(publicKeySpec);

        } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
            e.printStackTrace();
        }
        return dsaPublicKey;
    }
}
----
<1> The serialize method takes the object without a default constructor and creates a `KeyProxy` that contains the information necessary to recreate the `DSAPublicKey`.
<2> The deserialize method uses the `KeyProxy` to recreate the `DSAPublicKey` from its encoded form using the key factory.

An extension registers this substitution by producing an `ObjectSubstitutionBuildItem` as shown in this `TestProcessor#loadDSAPublicKey` fragment:

.Registering an Object Subtitution
[source,java]
----
    @BuildStep
    @Record(STATIC_INIT)
    PublicKeyBuildItem loadDSAPublicKey(TestRecorder recorder,
            BuildProducer<ObjectSubstitutionBuildItem> substitutions) throws IOException, GeneralSecurityException {
...
        // Register how to serialize DSAPublicKey
        ObjectSubstitutionBuildItem.Holder<DSAPublicKey, KeyProxy> holder = new ObjectSubstitutionBuildItem.Holder(
                DSAPublicKey.class, KeyProxy.class, DSAPublicKeyObjectSubstitution.class);
        ObjectSubstitutionBuildItem keysub = new ObjectSubstitutionBuildItem(holder);
        substitutions.produce(keysub);

        log.infof("loadDSAPublicKey run");
        return new PublicKeyBuildItem(publicKey);
    }
----

==== Replacing Classes in the Native Image
The Graal SDK supports substitutions of classes in the native image. An example of how one could replace the `XmlConfig/XmlData` classes with versions that have no JAXB annotation dependencies is shown in these example classes:

.Substitution of XmlConfig/XmlData Classes Example
[source,java]
----
package io.quarkus.extest.runtime.graal;
import java.util.Date;
import com.oracle.svm.core.annotate.Substitute;
import com.oracle.svm.core.annotate.TargetClass;
import io.quarkus.extest.runtime.config.XmlData;

@TargetClass(XmlConfig.class)
@Substitute
public final class Target_XmlConfig {

    @Substitute
    private String address;
    @Substitute
    private int port;
    @Substitute
    private ArrayList<XData> dataList;

    @Substitute
    public String getAddress() {
        return address;
    }

    @Substitute
    public int getPort() {
        return port;
    }

    @Substitute
    public ArrayList<XData> getDataList() {
        return dataList;
    }

    @Substitute
    @Override
    public String toString() {
        return "Target_XmlConfig{" +
                "address='" + address + '\'' +
                ", port=" + port +
                ", dataList=" + dataList +
                '}';
    }
}

@TargetClass(XmlData.class)
@Substitute
public final class Target_XmlData {

    @Substitute
    private String name;
    @Substitute
    private String model;
    @Substitute
    private Date date;

    @Substitute
    public String getName() {
        return name;
    }

    @Substitute
    public String getModel() {
        return model;
    }

    @Substitute
    public Date getDate() {
        return date;
    }

    @Substitute
    @Override
    public String toString() {
        return "Target_XmlData{" +
                "name='" + name + '\'' +
                ", model='" + model + '\'' +
                ", date='" + date + '\'' +
                '}';
    }
}
----

== Configuration reference documentation

The configuration is an important part of each extension and therefore needs to be properly documented.
Each configuration property should have a proper Javadoc comment.

While it is handy to have the documentation available when coding, this configuration documentation must also be available in the extension guides.
The Quarkus build automatically generates the configuration documentation for you based on the Javadoc comments but you need to explicitly include it in your guide.

In this section, we will explain everything you need to know about the configuration reference documentation.

=== Writing the documentation

For each configuration property, you need to write some Javadoc explaining its purpose.

[TIP]
====
Always make the first sentence meaningful and self-contained as it is included in the summary table.
====

You can either use standard Javadoc comments or Asciidoc directly as a Javadoc comment.

We assume you are familiar with writing Javadoc comments so let's focus on our Asciidoc support.
While standard Javadoc comments are perfectly fine for simple documentation (recommended even),
if you want to include tips, source code extracts, lists... Asciidoc comes in handy.

Here is a typical configuration property commented with Asciidoc:

[source,java]
----
/**
 * Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the
 * https://docs.jboss.org/hibernate/stable/orm/javadocs/org/hibernate/dialect/package-summary.html[Hibernate ORM JavaDoc].
 *
 * [NOTE]
 * ====
 * Not all the dialects are supported in GraalVM native executables: we currently provide driver extensions for PostgreSQL,
 * MariaDB, Microsoft SQL Server and H2.
 * ====
 *
 * @asciidoclet
 */
@ConfigItem
public Optional<String> dialect;
----

This is the simple case: you just have to write Asciidoc and mark the comment with the `@asciidoclet` tag.
This tag has two purposes: it is used as a marker for our generation tool but it is also used by the `javadoc` process for proper Javadoc generation.

Now let's consider a more complicated example:

[source,java]
----
// @formatter:off
/**
 * Name of the file containing the SQL statements to execute when Hibernate ORM starts.
 * Its default value differs depending on the Quarkus launch mode:
 *
 * * In dev and test modes, it defaults to `import.sql`.
 *   Simply add an `import.sql` file in the root of your resources directory
 *   and it will be picked up without having to set this property.
 *   Pass `no-file` to force Hibernate ORM to ignore the SQL import file.
 * * In production mode, it defaults to `no-file`.
 *   It means Hibernate ORM won't try to execute any SQL import file by default.
 *   Pass an explicit value to force Hibernate ORM to execute the SQL import file.
 *
 * If you need different SQL statements between dev mode, test (`@QuarkusTest`) and in production, use Quarkus
 * https://quarkus.io/guides/config#configuration-profiles[configuration profiles facility].
 *
 * [source,property]
 * .application.properties
 * ----
 * %dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql
 * %test.quarkus.hibernate-orm.sql-load-script = import-test.sql
 * %prod.quarkus.hibernate-orm.sql-load-script = no-file
 * ----
 *
 * [NOTE]
 * ====
 * Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines.
 * Each SQL statement must be terminated by a semicolon.
 * ====
 *
 * @asciidoclet
 */
// @formatter:on
@ConfigItem
public Optional<String> sqlLoadScript;
----

A few comments on this one:

 * Every time you will need the indentation to be respected in the Javadoc comment (think list items spread on multiple lines or indented source code),
   you will need to disable temporarily the automatic Eclipse formatter
   (this, even if you don't use Eclipse as the formatter is included in our build).
   To do so, use the `// @formatter:off`/`// @formatter:on` markers.
   Note the fact that they are separate comments and there is a space after the `//` marker. This is required.
 * As you can see, you can use the full power of Asciidoctor (except for the limitation below)

[WARNING]
====
You cannot use open blocks (`--`) in your Asciidoctor documentation.
All the other types of blocks (source, admonitions...) are supported.
====

[TIP]
====
By default, the doc generator will use the hyphenated field name as the key of a `java.util.Map` configuration item.
To override this default and have a user friendly key (independent of implementation details), you may use the `io.quarkus.runtime.annotations.ConfigDocMapKey` annotation.
See the following example,
[source,java]
----
@ConfigRoot
public class SomeConfig {
    /**
     * Namespace configuration.
     */
    @ConfigItem(name = ConfigItem.PARENT)
    @ConfigDocMapKey("cache-name") <1>
    Map<String, CaffeineNamespaceConfig> namespace;
}
----

1. This will generate a configuration map key named `quarkus.some."cache-name"` instead of `quarkus.some."namespace"`.
====

=== Writing section documentation

If you wish to generate configuration section of a given `@ConfigGroup`, Quarkus has got you covered with the `@ConfigDocSection` annotation.
See the code  example below:
[source,java]
----
/**
* Config group related configuration.
* Amazing introduction here
*/
@ConfigItem
@ConfigDocSection <1>
public ConfigGroupConfig configGroup;
----

1. This will add a section documentation for the `confgiGroup` config item in the generated documentation.
Section's title and introduction will be derived from the javadoc of the configuration item. The first sentence from the javadoc is considered as the section title and the remaining sentences used as section introduction.
You can also use the `@asciidoclet` tag as shown above.

=== Generating the documentation

Generating the documentation is easy:

 * Running `./mvnw clean install -DskipTests -DskipITs` will do.
 * You  can either do it globally or in a specific extension directory (e.g. `extensions/mailer`).

The documentation is generated in the global `target/asciidoc/generated/config/` located at the root of the project.

=== Including the documentation in the extension guide

Now that you have generated the configuration reference documentation for your extension, you need to include it in your guide (and review it).

This is simple, include the generated documentation in your guide:

[source,asciidoc]
----
\include::{generated-dir}/config/quarkus-your-extension.adoc[opts=optional, leveloffset=+1]
----

If you are interested in including the generated documentation for the config group, you can use the include statement below
[source,asciidoc]
----
\include::{generated-dir}/config/hyphenated-config-group-class-name-with-runtime-or-deployment-namespace-replaced-by-config-group-namespace.adoc[opts=optional, leveloffset=+1]
----

For example, the `io.quarkus.vertx.http.runtime.FormAuthConfig` configuration group will be generated in a file named `quarkus-vertx-http-config-group-form-auth-config.adoc`.


A few recommendations:

 * `opts=optional` is mandatory as we don't want the build to fail if only part of the configuration documentation has been generated
 * The documentation is generated with a title level of 2 (i.e. `==`).
   You usually need to adjust it.
   It can be done with `leveloffset=+N`.

It is not recommended to include the whole configuration documentation in the middle of your guide as it's heavy.
If you have an `application.properties` extract with your configuration, just do as follows.

First, include a tip just below your `application.properties` extract:

[source, asciidoc]
----
[TIP]
For more information about the extension configuration please refer to the <<configuration-reference, Configuration Reference>>.
----

Then, at the end of your documentation, include the extensive documentation:

[source, asciidoc]
----
[[configuration-reference]]
== Configuration Reference

\include::{generated-dir}/config/quarkus-your-extension.adoc[opts=optional, leveloffset=+1]
----

Finally, generate the documentation and check it out.
