Index
All Classes and Interfaces|All Packages
A
- andKey(String) - Method in class org.springframework.modulith.events.RoutingTarget.RoutingTargetBuilder
-
Returns a new
RoutingTargetwith the already configured target and the given key. - annotatedAsExternalized() - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
A
Predicateto select all events annotated as to be externalized. - AnnotationTargetLookup - Class in org.springframework.modulith.events
-
An annotation based target lookup strategy to enable caching of the function lookups that involve classpath checks.
- ApplicationModuleListener - Annotation Interface in org.springframework.modulith.events
-
An
ApplicationModuleListeneris anAsyncSpringTransactionalEventListenerthat runs in a transaction itself.
B
- build() - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Creates a new
EventExternalizationConfigurationreflecting the current configuration. - builder() - Static method in class org.springframework.modulith.events.DefaultEventExternalizationConfiguration
-
Returns a new
EventExternalizationConfiguration.Selectorinstance to build up a new configuration. - byApplicationLocalName(Collection<String>) - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Creates a new routing that uses the application-local type name as target
- byExternalizedAnnotations() - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Returns a
Functionthat looks up the target from the supported externalization annotations. - byFullyQualifiedTypeName() - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Returns a
Functionthat looks up the target from the fully-qualified type name of the event's type.
C
- compareTo(EventPublication) - Method in interface org.springframework.modulith.events.EventPublication
- CompletedEventPublications - Interface in org.springframework.modulith.events
-
All
EventPublications that have already been completed. - condition() - Element in annotation interface org.springframework.modulith.events.ApplicationModuleListener
-
Spring Expression Language (SpEL) attribute used for making the event handling conditional.
D
- DefaultEventExternalizationConfiguration - Class in org.springframework.modulith.events
-
Default implementation of
EventExternalizationConfiguration. - DefaultEventExternalizationConfiguration(Predicate<Object>, Function<Object, Object>, Function<Object, RoutingTarget>, Function<Object, Map<String, Object>>) - Constructor for class org.springframework.modulith.events.DefaultEventExternalizationConfiguration
-
Creates a new
DefaultEventExternalizationConfiguration - defaults(String...) - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Creates a default
DefaultEventExternalizationConfigurationwith the following characteristics: Only events that reside in any of the given packages and that are annotated with any supportedExternalizedannotation will be considered. Routing information is discovered from the {code Externalized} annotation and, if missing, will default to the application-local name of the event type. - defaults(Collection<String>) - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Creates a default
DefaultEventExternalizationConfigurationwith the following characteristics: Only events that reside in any of the given packages and that are annotated with any supportedExternalizedannotation will be considered. Routing information is discovered from the {code Externalized} annotation and, if missing, will default to the application-local name of the event type. - deletePublications(Predicate<EventPublication>) - Method in interface org.springframework.modulith.events.CompletedEventPublications
-
Deletes all
EventPublications matching the givenPredicate. - deletePublicationsOlderThan(Duration) - Method in interface org.springframework.modulith.events.CompletedEventPublications
-
Deletes all
EventPublications whose completion date is older than the givenDuration. - determineTarget(Object) - Method in class org.springframework.modulith.events.DefaultEventExternalizationConfiguration
- determineTarget(Object) - Method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Determines the
RoutingTargetfor the given event based on the current configuration. - disabled() - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Disables event externalization by not matching any events at all.
E
- equals(Object) - Method in class org.springframework.modulith.events.EventExternalized
- equals(Object) - Method in class org.springframework.modulith.events.RoutingTarget
- equals(Object) - Method in class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
- EventExternalizationConfiguration - Interface in org.springframework.modulith.events
-
Configuration for externalizing application events to messaging infrastructure.
- EventExternalizationConfiguration.Router - Class in org.springframework.modulith.events
-
API to define the event routing.
- EventExternalizationConfiguration.Selector - Class in org.springframework.modulith.events
-
API to define which events are supposed to be selected for externalization.
- EventExternalized<S,
T> - Class in org.springframework.modulith.events -
An infrastructure event signaling that an application event has been externalized with a particular, broker-specific result.
- EventExternalized(S, Object, RoutingTarget, T) - Constructor for class org.springframework.modulith.events.EventExternalized
-
Creates a new
EventExternalizedevent for the given source event, its mapped derivative,RoutingTargetand broker result. - EventPublication - Interface in org.springframework.modulith.events
-
An event publication.
- Externalized - Annotation Interface in org.springframework.modulith.events
-
Marks domain events as to be externalized.
- externalizing() - Static method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Creates a new
EventExternalizationConfiguration.Selectorto define which events to externalize.
F
- findAll() - Method in interface org.springframework.modulith.events.CompletedEventPublications
-
Returns all
EventPublications that have already been completed. - forTarget(String) - Static method in class org.springframework.modulith.events.RoutingTarget
-
Creates a new
RoutingTarget.RoutingTargetBuilderfor the given target.
G
- get() - Method in class org.springframework.modulith.events.AnnotationTargetLookup
- getApplicationEvent() - Method in interface org.springframework.modulith.events.EventPublication
-
Returns the event as Spring
ApplicationEvent, effectively wrapping it into aPayloadApplicationEventin case it's not one already. - getBrokerResult() - Method in class org.springframework.modulith.events.EventExternalized
-
Returns the broker result.
- getCompletionDate() - Method in interface org.springframework.modulith.events.EventPublication
-
Returns the completion date of the publication.
- getEvent() - Method in class org.springframework.modulith.events.EventExternalized
-
Returns the source event.
- getEvent() - Method in interface org.springframework.modulith.events.EventPublication
-
Returns the event that is published.
- getEventType() - Method in class org.springframework.modulith.events.EventExternalized
-
Returns the type of the source event.
- getHeadersFor(Object) - Method in class org.springframework.modulith.events.DefaultEventExternalizationConfiguration
- getHeadersFor(Object) - Method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Returns the headers to be attached to the message sent out for the given event.
- getIdentifier() - Method in interface org.springframework.modulith.events.EventPublication
-
Returns a unique identifier for this publication.
- getKey() - Method in class org.springframework.modulith.events.RoutingTarget
-
Returns the routing key.
- getKey() - Method in class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
- getMapped() - Method in class org.springframework.modulith.events.EventExternalized
-
Returns the mapped event.
- getPublicationDate() - Method in interface org.springframework.modulith.events.EventPublication
-
Returns the time the event is published at.
- getResolvableType() - Method in class org.springframework.modulith.events.EventExternalized
- getTarget() - Method in class org.springframework.modulith.events.EventExternalized
-
Returns the routing target.
- getTarget() - Method in class org.springframework.modulith.events.RoutingTarget
-
Returns the routing target.
- getTarget() - Method in class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
H
- hasExpression() - Method in class org.springframework.modulith.events.RoutingTarget
-
Returns whether either the target or key is using a SpEL expression.
- hasExternalizedAnnotation(Object) - Static method in class org.springframework.modulith.events.AnnotationTargetLookup
-
Returns whether the given event is annotated with a supported
Externalizedannotation. - hashCode() - Method in class org.springframework.modulith.events.EventExternalized
- hashCode() - Method in class org.springframework.modulith.events.RoutingTarget
- hashCode() - Method in class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
- hasKeyExpression() - Method in class org.springframework.modulith.events.RoutingTarget
-
Returns whether the routing key is a SpEL expression.
- headers(Class<T>, Function<T, Map<String, Object>>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Registers the given type-specific function to extract headers from the events to be externalized.
- headers(Function<Object, Map<String, Object>>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Registers the given function to extract headers from the events to be externalized.
I
- id() - Element in annotation interface org.springframework.modulith.events.ApplicationModuleListener
-
An optional identifier for the listener, defaulting to the fully-qualified signature of the declaring method (e.g.
- IncompleteEventPublications - Interface in org.springframework.modulith.events
-
All uncompleted event publications.
- isCompleted() - Method in interface org.springframework.modulith.events.EventPublication
-
Returns whether the publication of the event has completed.
- isPublicationCompleted() - Method in interface org.springframework.modulith.events.EventPublication
-
Deprecated.
M
- map(Object) - Method in class org.springframework.modulith.events.DefaultEventExternalizationConfiguration
- map(Object) - Method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Map the event to be externalized before publishing it.
- mapping(Class<T>, Function<T, Object>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Registers a type-specific mapping function.
- mapping(Function<Object, Object>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Registers a new mapping
Functionreplacing the old one entirely.
O
- of(Class<?>) - Static method in class org.springframework.modulith.events.AnnotationTargetLookup
-
Returns the
AnnotationTargetLookupfor the given type. - org.springframework.modulith.events - package org.springframework.modulith.events
-
API of the event publication registry abstraction.
P
- parse(String) - Static method in class org.springframework.modulith.events.RoutingTarget
-
Creates a new
RoutingTarget.ParsedRoutingTargetby parsing the given source. - ParsedRoutingTarget(String, String) - Constructor for class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
- propagation() - Element in annotation interface org.springframework.modulith.events.ApplicationModuleListener
-
The transaction propagation type.
R
- readOnlyTransaction() - Element in annotation interface org.springframework.modulith.events.ApplicationModuleListener
-
Whether the transaction to be run for the event listener is supposed to be read-only (default false).
- resubmitIncompletePublications(Predicate<EventPublication>) - Method in interface org.springframework.modulith.events.IncompleteEventPublications
-
Triggers the re-submission of events for which incomplete
EventPublications are registered. - resubmitIncompletePublicationsOlderThan(Duration) - Method in interface org.springframework.modulith.events.IncompleteEventPublications
-
Triggers the re-submission of events for which incomplete
EventPublications are registered that exceed a certain age regarding their original publication date. - route(Class<T>, Function<T, RoutingTarget>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Registers a router function for the events of the given specific type.
- routeAll(Function<Object, RoutingTarget>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Routes all events based on the given function.
- routeAllByType(Function<Class<?>, RoutingTarget>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Routes all messages based on the event type only.
- routeKey(Class<T>, Function<T, String>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Registers a
BiFunctionto resolve the key for aRoutingTargetbased on the event instance. - routeMapped() - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Configures the routing to rather use the mapping result rather than the original event instance.
- routeOptional(Function<Object, Optional<RoutingTarget>>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Routes by extracting an
Optionalroute from the event. - routeOptionalByType(Function<Class<?>, Optional<RoutingTarget>>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Routes by extracting an
Optionalroute from the event type. - Router(Predicate<Object>) - Constructor for class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Creates a new
EventExternalizationConfiguration.Routerfor the given selector filter. - Router(Predicate<Object>, Function<Object, Object>, Function<Object, RoutingTarget>, Function<Object, Map<String, Object>>) - Constructor for class org.springframework.modulith.events.EventExternalizationConfiguration.Router
-
Creates a new
EventExternalizationConfiguration.Routerfor the given selectorPredicateand mapper and routerFunctions. - RoutingTarget - Class in org.springframework.modulith.events
-
A
String-based routing target that supports a::delimiter to separate the sole target from an additional key. - RoutingTarget.ParsedRoutingTarget - Class in org.springframework.modulith.events
-
A parsed routing target that can have null target and key values.
- RoutingTarget.RoutingTargetBuilder - Class in org.springframework.modulith.events
-
An intermediary to ultimately create
RoutingTargetinstances.
S
- select(Predicate<Object>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events to externalize by applying the given
Predicate. - selectAndRoute(Class<T>, BiFunction<Object, T, RoutingTarget>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events by the presence of an annotation of the given type and routes based on the given router
BiFunctionthat also gets the event type to build up a completeRoutingTarget. - selectAndRoute(Class<T>, Function<T, String>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events by the presence of an annotation of the given type and routes based on the given router
Function. - selectByAnnotation(Class<? extends Annotation>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events to be externalized by inspecting the event type for the given annotation.
- selectByPackage(Class<?>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events to externalize by the package of the given type and all sub-packages.
- selectByPackage(String) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events to externalize by the given base package and all sub-packages.
- selectByPackagesAndFilter(Collection<String>, Predicate<Object>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events to externalize by the given base packages (and their sub-packages) that match the given filter
Predicate. - selectByType(Class<?>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events to be externalized by type.
- selectByType(Predicate<Class<?>>) - Method in class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Selects events to be externalized by the given
Predicate. - Selector() - Constructor for class org.springframework.modulith.events.EventExternalizationConfiguration.Selector
-
Creates a new
EventExternalizationConfiguration.Selector. - spring.modulith.events.api - module spring.modulith.events.api
- supports(Object) - Method in class org.springframework.modulith.events.DefaultEventExternalizationConfiguration
- supports(Object) - Method in interface org.springframework.modulith.events.EventExternalizationConfiguration
-
Whether the configuration supports the given event.
T
- target() - Element in annotation interface org.springframework.modulith.events.Externalized
-
The logical target name.
- toRoutingTarget() - Method in class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
- toString() - Method in class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
- toString() - Method in class org.springframework.modulith.events.RoutingTarget
V
- value() - Element in annotation interface org.springframework.modulith.events.Externalized
-
The logical target name.
- verify() - Method in class org.springframework.modulith.events.RoutingTarget
W
- withFallback(RoutingTarget) - Method in class org.springframework.modulith.events.RoutingTarget.ParsedRoutingTarget
- withKey(String) - Method in class org.springframework.modulith.events.RoutingTarget
-
Creates a new
RoutingTargetwith the same target but the given routing key. - withoutKey() - Method in class org.springframework.modulith.events.RoutingTarget.RoutingTargetBuilder
-
Returns a new
RoutingTargetwithout a key. - withTarget(String) - Method in class org.springframework.modulith.events.RoutingTarget
All Classes and Interfaces|All Packages
EventPublication.isCompleted()instead.