Public API and SPI
This page lists the types applications and Quarkus Modulith extensions may rely on. Their signatures are frozen: they only change in a compatible way. A method whose behavior is not implemented yet throws UnsupportedOperationException, and an annotation attribute that is not evaluated yet says so in its Javadoc. Listener attributes the dispatcher cannot honor yet fail the build rather than being ignored.
Everything in a runtime or deployment package is internal and may change in any release.
Annotations and application API
Artifact quarkus-modulith-api, a plain jar without Quarkus dependency.
| Package | Types |
|---|---|
|
|
|
|
Module model
Artifact quarkus-modulith-core, a plain jar. Package io.quarkiverse.modulith.core:
-
ApplicationModules: the model, injectable as a bean in a Quarkus application.of(Class)andof(String)will build it in a plain test. -
ApplicationModule,ApplicationModuleIdentifier -
ApplicationModuleDependencies,ApplicationModuleDependency,DependencyType,DependencyDepth -
Violations,Violation -
ModelData: the recorded form of the model. Public because the runtime buildsApplicationModulesfrom it, not meant for applications. -
The model is complete:
ApplicationModules.of(Class)andof(String)build it in a plain test (withClassLocations, ArchUnitDescribedPredicateandImportOptionoverloads), and the package also holdsApplicationModuleIdentifiers,JavaType,JavaPackage,JavaPackages,PackageName,NamedInterface,NamedInterfaces,NamedInterfacesBuilder,AllowedDependency,AllowedDependencies,ModuleBean,ArchitecturallyEvidentType,ReferenceMethod,EventType,Source,EntryPoint,EntryPointKind,FormattableType,NonModuleTypeAbbreviation,ModulithMetadata,ApplicationModuleInformation,ApplicationModuleDetectionStrategy,ApplicationModuleSource,ApplicationModuleSourceFactory,ApplicationModulesFactory,VerificationOptions,ModulithRule,Filters,ClassLocations,ApplicationRuntimeandApplicationModulesRuntime;io.quarkiverse.modulith.core.util.ApplicationModulesExporterwrites the JSON export.io.quarkiverse.modulith.core.dataholds the recordsModelDatais made of, andio.quarkiverse.modulith.core.implthe analysis, both internal. -
quarkus-modulith-flyway, packageio.quarkiverse.modulith.flyway:MigrationFilter, CDI beans that decide whether a module’s Flyway migrations run (see Module-aware Flyway).
Service provider interfaces
For Quarkus Modulith extensions, not for applications.
| Artifact | Package | Types |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
-
Event externalization:
io.quarkiverse.modulith.eventsaddsParsedRoutingTargetand implementsEventExternalizationConfigurationwith Spring Modulith’s selector and router.quarkus-modulith-eventsexposes, inio.quarkiverse.modulith.events.externalization,EventExternalizationTransport,EventExternalizer(externalizes one event, used by outbox extensions) andExternalizationStrategy(SPI for extensions that bring their own outbox), and its deployment module the build itemsExternalizationBuildItem,ExternalizationTransportBuildItem,ExternalizationStrategyBuildItemandExternalizedTypeBuildItemfor transport extensions. Types in.externalization.implare public only for generated code.quarkus-modulith-events-jobrunraddsio.quarkiverse.modulith.events.jobrunr.JobRunrExternalizationTransport.
Testing
-
quarkus-modulith-junit, packageio.quarkiverse.modulith.test:ApplicationModuleTest,ApplicationModuleTestProfile,BootstrapMode,ModuleTestExecution,Scenario,When,EventResult,StateChangeResult,ScenarioCustomizer,TransactionOperations,EnableScenarios,PublishedEvents,TypedPublishedEvents,AssertablePublishedEvents,PublishedEventsAssert,PublishedEventAssert,PublishedEventsExtension,AggregateTestUtils,ApplicationModuleComponents,TestApplicationModules. -
quarkus-modulith, packageio.quarkiverse.modulith.testing:ModuleTestRuntimeConfig, the runtime settingsquarkus-modulith-junitreads. An SPI for that module, not for applications. -
quarkus-modulith-junit-changes, packageio.quarkiverse.modulith.junit:ModulithExecutionCondition,Changes,Change; packageio.quarkiverse.modulith.junit.diff:FileModificationDetector,ModifiedFile. -
quarkus-modulith-documenter, packageio.quarkiverse.modulith.docs:Documenter,DocumenterOptions,DiagramOptions,DiagramStyle,ElementsWithoutRelationships,DiagramComponent,CanvasOptions,Grouping,JMoleculesGroupings,SpringGroupings,QuarkusGroupings,DocumentationOutput,DocumentationModel,CoreModelswithModuleDetails,ModuleType,ModuleBean,ModuleDependency,PublishedEvent,EventSource,ListenerMethod,ModuleProperty,Stereotype,ApplicationModulesJson,TypeNames; packageio.quarkiverse.modulith.docs.metadata:DocumentationSource,TypeMetadata,MethodMetadata.quarkus-modulith-apt:ModulithJavadocProcessor.quarkus-modulith-observability, packageio.quarkiverse.modulith.observability:ModulithSpanCustomizer,ModuleInvocation,ModulithEventMetrics,ModulithEventMetricsCustomizer,ModulithObservations,ModulithMetrics.quarkus-modulith, packageio.quarkiverse.modulith.runtime:ModulithCapabilities, the capability names the extensions share.quarkus-modulith-core, packageio.quarkiverse.modulith.core.util:MermaidDiagram. -
quarkus-modulith-events-tck, packageio.quarkiverse.modulith.events.tck:EventPublicationRepositoryContract, the contract tests every repository passes, andInMemoryEventPublicationRepository. Add it withtestscope.
Configuration roots
Each artifact owns its own prefix. quarkus.modulith (base package, verification) belongs to quarkus-modulith, quarkus.modulith.docs and quarkus.modulith.test to its deployment module, quarkus.modulith.events to quarkus-modulith-events, and each store or transport adds its own segment, for example quarkus.modulith.events.jdbc. See Configuration reference.
-
Event publication:
io.quarkiverse.modulith.eventsaddsAbandonedEventPublicationsandConditionalEventListener.io.quarkiverse.modulith.events.spiaddsTransactionRunner(transactions with and without Narayana) andReadOnlyTransactions(read-only listener transactions of a store).io.quarkiverse.modulith.events.coreaddsPageCriteriaandPublicationCursor, andEventPublicationRepositorygains paged reads, staleness marking and counted deletes as default methods, so existing stores keep compiling.io.quarkiverse.modulith.events.configaddsCompletionMode(withARCHIVE) andEventsFixedConfig, which now holds the completion mode because stores derive their mapping from it.quarkus-modulith-events-tckaddsDeleteCompletionModeContract,ArchiveCompletionModeContractandPublications.DefaultEventPublicationRegistryhas a public constructor for registries outside CDI. -
API freeze amendments (additive):
io.quarkiverse.modulith.events.AbandonedEventPublications,io.quarkiverse.modulith.events.ConditionalEventListener,io.quarkiverse.modulith.events.spi.TransactionRunner,io.quarkiverse.modulith.events.spi.ReadOnlyTransactionsandio.quarkiverse.modulith.events.spi.SerializationFailuresare new frozen types.IncompleteEventPublications#resubmitIncompletePublications(ResubmissionOptions)is implemented by the registry instead of a throwing default, and@ApplicationModuleListener’s `condition,propagationandreadOnlyTransactionare honored.EventPublicationRegistryandEventPublicationRepositorygainedafterCommitanddeletePublicationsCountingas default methods. -
Further amendments:
EventPublicationRepository#claim(UUID, Set<Status>, Instant, Instant)(compare-and-set claim with stale takeover),EventPublicationRepository#findIncompletePublications(PublicationTargetIdentifier, Set<Status>, PageCriteria)(one listener’s page, filtered in the database), the constantEventPublicationRepository.STALEABLE, andio.quarkiverse.modulith.events.core.ResubmissionExclusion(listeners the registry does not resubmit).