Uses of Class
io.fluxcapacitor.common.api.Metadata

Packages that use Metadata

Package	Description
io.fluxcapacitor.common.api
io.fluxcapacitor.common.search
io.fluxcapacitor.javaclient
io.fluxcapacitor.javaclient.common
io.fluxcapacitor.javaclient.common.serialization
io.fluxcapacitor.javaclient.common.serialization.jackson
io.fluxcapacitor.javaclient.common.websocket
io.fluxcapacitor.javaclient.modeling
io.fluxcapacitor.javaclient.persisting.search
io.fluxcapacitor.javaclient.publishing
io.fluxcapacitor.javaclient.publishing.client
io.fluxcapacitor.javaclient.scheduling
io.fluxcapacitor.javaclient.tracking.client
io.fluxcapacitor.javaclient.tracking.handling
io.fluxcapacitor.javaclient.tracking.handling.authentication
io.fluxcapacitor.javaclient.web
io.fluxcapacitor.proxy
io.fluxcapacitor.testserver.metrics

Uses of Metadata in io.fluxcapacitor.common.api

Methods in io.fluxcapacitor.common.api that return Metadata

Modifier and Type	Method	Description
Metadata	Metadata.addIfAbsent(Object key, Object value)	Adds the specified key-value pair to the metadata if the key is not already present.
Metadata	Metadata.addIfAbsent(Map<?,?> map)	Adds all entries from the specified map to the current Metadata, ignoring keys that already exist.
static Metadata	Metadata.empty()	Creates an empty instance of the Metadata class with no entries.
Metadata	HasMetadata.getMetadata()	Returns the Metadata associated with this object.
static Metadata	Metadata.of(Object... keyValues)	Creates a new Metadata instance with the provided key-value pairs.
static Metadata	Metadata.of(Object key, Object value)	Creates a new Metadata instance with a single key-value pair.
static Metadata	Metadata.of(Map<?,?> map)	Creates a new instance of Metadata populated with the given map.
Metadata	Metadata.with(Metadata metadata)	Creates a new instance of Metadata by combining the current metadata with the given metadata.
Metadata	Metadata.with(Object... keyValues)	Creates a new Metadata instance by adding the specified key-value pairs.
Metadata	Metadata.with(Object key, Object value)	Returns a new Metadata instance with the specified key-value pair added or updated in the current entries.
Metadata	Metadata.with(Map<?,?> values)	Returns a new Metadata instance that includes all the current entries and the mappings provided in the given map.
Metadata	Metadata.without(Object key)	Returns a new Metadata instance without the specified key.
Metadata	Metadata.withoutIf(Predicate<String> check)	Returns a new instance of Metadata, excluding all entries where the provided predicate evaluates to true for the entry keys.
Metadata	Metadata.withTrace(Object key, Object value)	Adds a trace entry with the specified key and value to the metadata.

Methods in io.fluxcapacitor.common.api with parameters of type Metadata

Modifier and Type	Method	Description
boolean	Metadata.contains(@NonNull Metadata metadata)	Checks whether the current metadata contains all entries of the specified metadata.
Metadata	Metadata.with(Metadata metadata)	Creates a new instance of Metadata by combining the current metadata with the given metadata.

Constructors in io.fluxcapacitor.common.api with parameters of type Metadata

Modifier	Constructor	Description
	SerializedMessage(Data<byte[]> data, Metadata metadata, String messageId, Long timestamp)

Uses of Metadata in io.fluxcapacitor.common.search

Methods in io.fluxcapacitor.common.search with parameters of type Metadata

Modifier and Type	Method	Description
protected Stream<FacetEntry>	JacksonInverter.asFacets(Metadata metadata)
protected Set<FacetEntry>	JacksonInverter.getFacets(Object value, Metadata metadata)
SerializedDocument	Inverter.toDocument(Object object, String type, int revision, String id, String collection, Instant timestamp, Instant end, Metadata metadata)	Converts the given object into a SerializedDocument, which is suitable for indexing or storage in a document store.
SerializedDocument	JacksonInverter.toDocument(Object value, String type, int revision, String id, String collection, Instant timestamp, Instant end, Metadata metadata)

Uses of Metadata in io.fluxcapacitor.javaclient

Methods in io.fluxcapacitor.javaclient with parameters of type Metadata

Modifier and Type	Method	Description
static void	FluxCapacitor.publishEvent(Object payload, Metadata metadata)	Publishes an event with given payload and metadata.
static void	FluxCapacitor.publishMetrics(Object payload, Metadata metadata)	Publishes a metrics event with given payload and metadata.
static <R> CompletableFuture<R>	FluxCapacitor.query(Request<R> payload, Metadata metadata)	Sends a query with given payload and metadata and returns a future that will be completed with the query's result.
static <R> CompletableFuture<R>	FluxCapacitor.query(Object payload, Metadata metadata)	Sends a query with given payload and metadata and returns a future that will be completed with the query's result.
static <R> R	FluxCapacitor.queryAndWait(Request<R> payload, Metadata metadata)	Sends a query with given payload and metadata and returns the query's result.
static <R> R	FluxCapacitor.queryAndWait(Object payload, Metadata metadata)	Sends a query with given payload and metadata and returns the query's result.
static void	FluxCapacitor.sendAndForgetCommand(Object payload, Metadata metadata)	Sends a command with given payload and metadata and don't wait for a result.
static void	FluxCapacitor.sendAndForgetCommand(Object payload, Metadata metadata, Guarantee guarantee)	Sends a command with given payload and metadata and don't wait for a result.
static <R> CompletableFuture<R>	FluxCapacitor.sendCommand(Request<R> payload, Metadata metadata)	Sends a command with given payload and metadata and returns a future that will be completed with the command's result.
static <R> CompletableFuture<R>	FluxCapacitor.sendCommand(Object payload, Metadata metadata)	Sends a command with given payload and metadata and returns a future that will be completed with the command's result.
static <R> R	FluxCapacitor.sendCommandAndWait(Request<R> payload, Metadata metadata)	Sends a command with given payload and metadata and returns a future that will be completed with the command's result.
static <R> R	FluxCapacitor.sendCommandAndWait(Object payload, Metadata metadata)	Sends a command with given payload and metadata and returns a future that will be completed with the command's result.

Uses of Metadata in io.fluxcapacitor.javaclient.common

Methods in io.fluxcapacitor.javaclient.common with parameters of type Metadata

Modifier and Type	Method	Description
Message	Message.addMetadata(Metadata metadata)	Returns a new message with the combined metadata.

Constructors in io.fluxcapacitor.javaclient.common with parameters of type Metadata

Modifier	Constructor	Description
	Message(Object payload, Metadata metadata)	Constructs a message with the given payload and metadata.
	Message(Object payload, Metadata metadata, String messageId, Instant timestamp)	Full constructor for internal use and deserialization.

Uses of Metadata in io.fluxcapacitor.javaclient.common.serialization

Methods in io.fluxcapacitor.javaclient.common.serialization that return Metadata

Modifier and Type	Method	Description
Metadata	DeserializingMessage.getMetadata()

Methods in io.fluxcapacitor.javaclient.common.serialization with parameters of type Metadata

Modifier and Type	Method	Description
DeserializingMessage	DeserializingMessage.withMetadata(Metadata metadata)

Uses of Metadata in io.fluxcapacitor.javaclient.common.serialization.jackson

Methods in io.fluxcapacitor.javaclient.common.serialization.jackson with parameters of type Metadata

Modifier and Type	Method	Description
SerializedDocument	JacksonSerializer.toDocument(Object value, String id, String collection, Instant timestamp, Instant end, Metadata metadata)

Uses of Metadata in io.fluxcapacitor.javaclient.common.websocket

Methods in io.fluxcapacitor.javaclient.common.websocket that return Metadata

Modifier and Type	Method	Description
protected Metadata	AbstractWebsocketClient.metricsMetadata()

Methods in io.fluxcapacitor.javaclient.common.websocket with parameters of type Metadata

Modifier and Type	Method	Description
protected void	AbstractWebsocketClient.tryPublishMetrics(JsonType message, Metadata metadata)

Uses of Metadata in io.fluxcapacitor.javaclient.modeling

Methods in io.fluxcapacitor.javaclient.modeling that return Metadata

Modifier and Type	Method	Description
Metadata	DefaultEntityHelper.MessageWithEntity.getMetadata()

Methods in io.fluxcapacitor.javaclient.modeling with parameters of type Metadata

Modifier and Type	Method	Description
default Entity<T>	Entity.apply(Object event, Metadata metadata)	Applies an event and associated metadata to produce a resulting entity.
default Entity<T>	Entity.assertAndApply(Object payload, Metadata metadata)	Verifies that the provided update is legal given the current state of the aggregate and on success applies it to the aggregate.

Uses of Metadata in io.fluxcapacitor.javaclient.persisting.search

Methods in io.fluxcapacitor.javaclient.persisting.search that return Metadata

Modifier and Type	Method	Description
Metadata	IndexOperation.metadata()	Returns the configured metadata.

Methods in io.fluxcapacitor.javaclient.persisting.search with parameters of type Metadata

Modifier and Type	Method	Description
default IndexOperation	IndexOperation.addMetadata(@NonNull Metadata metadata)	Adds metadata to the index operation, merging with any previously set metadata.
CompletableFuture<Void>	DefaultDocumentStore.index(@NonNull Object object, Object id, Object collection, Instant begin, Instant end, Metadata metadata, Guarantee guarantee, boolean ifNotExists)
CompletableFuture<Void>	DocumentStore.index(@NotNull Object object, Object id, Object collection, Instant begin, Instant end, Metadata metadata, Guarantee guarantee, boolean ifNotExists)	Indexes a document with the specified guarantees, metadata, and if-not-exists condition.
IndexOperation	IndexOperation.metadata(Metadata metadata)	Replaces all metadata in this operation with the given metadata.
SerializedDocument	DocumentSerializer.toDocument(Object value, String id, String collection, Instant timestamp, Instant end, Metadata metadata)	Serializes a given value into a SerializedDocument, using the specified identifiers, timestamps, and metadata.

Uses of Metadata in io.fluxcapacitor.javaclient.publishing

Methods in io.fluxcapacitor.javaclient.publishing with parameters of type Metadata

Modifier and Type	Method	Description
protected SerializedMessage	DefaultResultGateway.interceptDispatch(Object payload, Metadata metadata)
CompletableFuture<Void>	DefaultMetricsGateway.publish(Object payload, Metadata metadata, Guarantee guarantee)
default void	EventGateway.publish(Object payload, Metadata metadata)	Publishes an event with the specified payload and metadata.
default void	MetricsGateway.publish(Object payload, Metadata metadata)	Publishes a metrics payload with the specified metadata and a Guarantee.NONE delivery guarantee.
CompletableFuture<Void>	MetricsGateway.publish(Object payload, Metadata metadata, Guarantee guarantee)	Publishes a metrics message with the specified metadata and delivery guarantee.
CompletableFuture<Void>	DefaultErrorGateway.report(Object payload, Metadata metadata, Guarantee guarantee)
default void	ErrorGateway.report(Object payload, Metadata metadata)	Reports an error with the given payload and metadata using the default Guarantee.NONE.
CompletableFuture<Void>	ErrorGateway.report(Object payload, Metadata metadata, Guarantee guarantee)	Reports an error with the given payload, metadata, and delivery guarantee.
CompletableFuture<Void>	DefaultResultGateway.respond(Object payload, Metadata metadata, String target, Integer requestId, Guarantee guarantee)
CompletableFuture<Void>	ResultGateway.respond(Object payload, Metadata metadata, String target, Integer requestId, Guarantee guarantee)	Sends a response with the specified payload, metadata, target, request ID, and delivery guarantee.
<R> CompletableFuture<R>	CommandGateway.send(Request<R> payload, Metadata metadata)	Sends a typed request command with metadata and returns a future for the result.
<R> CompletableFuture<R>	CommandGateway.send(Object payload, Metadata metadata)	Sends a command with metadata and returns a future for the result.
default <R> CompletableFuture<R>	GenericGateway.send(Request<R> payload, Metadata metadata)	Sends a Request with metadata and returns a future with its response.
default <R> CompletableFuture<R>	GenericGateway.send(Object payload, Metadata metadata)	Sends a message with custom metadata and returns a future with its response.
<R> CompletableFuture<R>	QueryGateway.send(Request<R> payload, Metadata metadata)	Sends a typed Request query with additional metadata and returns a future with the result.
<R> CompletableFuture<R>	QueryGateway.send(Object payload, Metadata metadata)	Sends the given query along with metadata asynchronously and returns a future representing the result.
void	CommandGateway.sendAndForget(Object payload, Metadata metadata)	Sends a command with metadata without waiting for a result.
void	CommandGateway.sendAndForget(Object payload, Metadata metadata, Guarantee guarantee)	Sends a command with metadata and delivery guarantee, without waiting for a result.
default void	GenericGateway.sendAndForget(Object payload, Metadata metadata)	Sends a message with custom payload and metadata asynchronously.
default void	GenericGateway.sendAndForget(Object payload, Metadata metadata, Guarantee guarantee)	Sends a message with payload, metadata, and delivery guarantee asynchronously.
<R> R	CommandGateway.sendAndWait(Request<R> payload, Metadata metadata)	Sends a typed request command with metadata and waits for the result.
<R> R	CommandGateway.sendAndWait(Object payload, Metadata metadata)	Sends a command with metadata and waits for the result.
default <R> R	GenericGateway.sendAndWait(Request<R> payload, Metadata metadata)	Sends a Request with metadata and blocks for a response.
default <R> R	GenericGateway.sendAndWait(Object payload, Metadata metadata)	Sends a message with metadata and blocks for a response.
<R> R	QueryGateway.sendAndWait(Request<R> payload, Metadata metadata)	Sends a typed Request query with metadata and waits for the result.
<R> R	QueryGateway.sendAndWait(Object payload, Metadata metadata)	Sends the given query and metadata, then waits for the result.

Uses of Metadata in io.fluxcapacitor.javaclient.publishing.client

Methods in io.fluxcapacitor.javaclient.publishing.client that return Metadata

Modifier and Type	Method	Description
protected Metadata	WebsocketGatewayClient.metricsMetadata()

Uses of Metadata in io.fluxcapacitor.javaclient.scheduling

Methods in io.fluxcapacitor.javaclient.scheduling with parameters of type Metadata

Modifier and Type	Method	Description
Schedule	Schedule.addMetadata(Metadata metadata)	Returns a new schedule with additional metadata.
default void	MessageScheduler.schedule(Object schedulePayload, Metadata metadata, String scheduleId, Duration delay)	Schedule a message with payload and metadata using a delay, using the Guarantee.SENT guarantee.
default void	MessageScheduler.schedule(Object schedulePayload, Metadata metadata, String scheduleId, Instant deadline)	Schedule a message with payload and metadata, using the Guarantee.SENT guarantee.
default void	MessageScheduler.scheduleCommand(Object schedulePayload, Metadata metadata, String scheduleId, Duration delay)	Schedule a command with metadata and delay, using the Guarantee.SENT guarantee.
default void	MessageScheduler.scheduleCommand(Object schedulePayload, Metadata metadata, String scheduleId, Instant deadline)	Schedule a command message with attached metadata, using the Guarantee.SENT guarantee.
Schedule	Schedule.withMetadata(Metadata metadata)	Returns a new instance with the given metadata.

Constructors in io.fluxcapacitor.javaclient.scheduling with parameters of type Metadata

Modifier	Constructor	Description
	Schedule(Object payload, Metadata metadata, String scheduleId, Instant deadline)	Full constructor specifying payload, metadata, scheduleId, and deadline.
	Schedule(Object payload, Metadata metadata, String messageId, Instant timestamp, String scheduleId, Instant deadline)	Full constructor including message ID and timestamp.

Uses of Metadata in io.fluxcapacitor.javaclient.tracking.client

Methods in io.fluxcapacitor.javaclient.tracking.client that return Metadata

Modifier and Type	Method	Description
protected Metadata	WebsocketTrackingClient.metricsMetadata()

Uses of Metadata in io.fluxcapacitor.javaclient.tracking.handling

Methods in io.fluxcapacitor.javaclient.tracking.handling with parameters of type Metadata

Modifier and Type	Method	Description
Message	DefaultResponseMapper.map(Object response, Metadata metadata)
Message	ResponseMapper.map(Object response, Metadata metadata)	Maps the given response object and metadata to a Message.

Uses of Metadata in io.fluxcapacitor.javaclient.tracking.handling.authentication

Methods in io.fluxcapacitor.javaclient.tracking.handling.authentication that return Metadata

Modifier and Type	Method	Description
Metadata	AbstractUserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)	Adds a User to the metadata using the configured key.
Metadata	DelegatingUserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)
Metadata	NoOpUserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)
default Metadata	UserProvider.addToMetadata(Metadata metadata, User user)	Adds user-related metadata to a message, overwriting existing values if present.
Metadata	UserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)	Adds user-related metadata to a message.
Metadata	AbstractUserProvider.removeFromMetadata(Metadata metadata)	Removes the user entry from the metadata.
Metadata	DelegatingUserProvider.removeFromMetadata(Metadata metadata)
Metadata	NoOpUserProvider.removeFromMetadata(Metadata metadata)
Metadata	UserProvider.removeFromMetadata(Metadata metadata)	Removes any user-related metadata entries from the given Metadata.

Methods in io.fluxcapacitor.javaclient.tracking.handling.authentication with parameters of type Metadata

Modifier and Type	Method	Description
Metadata	AbstractUserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)	Adds a User to the metadata using the configured key.
Metadata	DelegatingUserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)
Metadata	NoOpUserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)
default Metadata	UserProvider.addToMetadata(Metadata metadata, User user)	Adds user-related metadata to a message, overwriting existing values if present.
Metadata	UserProvider.addToMetadata(Metadata metadata, User user, boolean ifAbsent)	Adds user-related metadata to a message.
boolean	AbstractUserProvider.containsUser(Metadata metadata)	Returns true if the metadata contains a user entry under the configured key.
boolean	DelegatingUserProvider.containsUser(Metadata metadata)
boolean	NoOpUserProvider.containsUser(Metadata metadata)
boolean	UserProvider.containsUser(Metadata metadata)	Checks if the given metadata contains user information that can be resolved by this provider.
Metadata	AbstractUserProvider.removeFromMetadata(Metadata metadata)	Removes the user entry from the metadata.
Metadata	DelegatingUserProvider.removeFromMetadata(Metadata metadata)
Metadata	NoOpUserProvider.removeFromMetadata(Metadata metadata)
Metadata	UserProvider.removeFromMetadata(Metadata metadata)	Removes any user-related metadata entries from the given Metadata.

Uses of Metadata in io.fluxcapacitor.javaclient.web

Methods in io.fluxcapacitor.javaclient.web that return Metadata

Modifier and Type	Method	Description
static Metadata	WebResponse.asMetadata(int statusCode, Map<String,List<String>> headers)	Constructs a Metadata object containing the provided status code and headers.

Methods in io.fluxcapacitor.javaclient.web with parameters of type Metadata

Modifier and Type	Method	Description
WebRequest	WebRequest.addMetadata(Metadata metadata)
WebResponse	WebResponse.addMetadata(Metadata metadata)
static Optional<HttpCookie>	WebRequest.getCookie(Metadata metadata, String name)	Retrieves the first cookie with the given name from the provided Metadata object.
static Optional<String>	WebRequest.getHeader(Metadata metadata, String name)	Retrieves the first header value for the given name from the provided Metadata object.
static Optional<String>	WebUtils.getHeader(Metadata metadata, String name)	Retrieves the first header value for the given name from the provided Metadata object.
static Map<String,List<String>>	WebRequest.getHeaders(Metadata metadata)	Retrieves a case-insensitive map of headers from the provided Metadata object.
static Map<String,List<String>>	WebResponse.getHeaders(Metadata metadata)	Retrieves a case-insensitive map of headers from the provided Metadata object.
static Map<String,List<String>>	WebUtils.getHeaders(Metadata metadata)	Retrieves a case-insensitive map of headers from the provided Metadata object.
static String	WebRequest.getMethod(Metadata metadata)	Extracts the HTTP or WebSocket method (e.g., "GET", "POST", "WS_OPEN") from the provided Metadata object.
static String	WebRequest.getSocketSessionId(Metadata metadata)	Retrieves the WebSocket session ID from the provided metadata, or null if it is missing.
static Integer	WebResponse.getStatusCode(Metadata metadata)	Retrieves the status code from the provided metadata.
static String	WebRequest.getUrl(Metadata metadata)	Extracts the request path from the provided Metadata object.
WebResponse	DefaultWebResponseMapper.map(Object response, Metadata metadata)	Maps a raw handler return value and associated metadata into a WebResponse.
WebResponse	WebResponseMapper.map(Object response, Metadata metadata)	Maps a response and optional metadata into a WebResponse.
static String	WebRequest.requireSocketSessionId(Metadata metadata)	Retrieves the WebSocket session ID from the provided metadata or throws an exception if it is missing.
CompletableFuture<Void>	WebResponseGateway.respond(Object payload, Metadata metadata, String target, Integer requestId, Guarantee guarantee)
WebRequest	WebRequest.withMetadata(Metadata metadata)
WebResponse	WebResponse.withMetadata(Metadata metadata)

Constructors in io.fluxcapacitor.javaclient.web with parameters of type Metadata

Modifier	Constructor	Description
protected	Builder(Metadata metadata)

Uses of Metadata in io.fluxcapacitor.proxy

Methods in io.fluxcapacitor.proxy that return Metadata

Modifier and Type	Method	Description
Metadata	WebsocketEndpoint.SessionContext.metadata()	Returns the value of the metadata record component.

Constructors in io.fluxcapacitor.proxy with parameters of type Metadata

Modifier	Constructor	Description
protected	SessionContext(Metadata metadata, String clientId, String trackerId)	Creates an instance of a SessionContext record class.

Uses of Metadata in io.fluxcapacitor.testserver.metrics

Methods in io.fluxcapacitor.testserver.metrics with parameters of type Metadata

Modifier and Type	Method	Description
void	DefaultMetricsLog.registerMetrics(ClientEvent event, Metadata metadata)
void	MetricsLog.registerMetrics(ClientEvent event, Metadata metadata)
void	NoOpMetricsLog.registerMetrics(ClientEvent event, Metadata metadata)