FluxCapacitor (io.flux-capacitor:java-client 0.78 API)

All Known Implementing Classes:

DefaultFluxCapacitor
```
public interface FluxCapacitor
```
High-level client for Flux Capacitor. If you are using anything other than this to interact with the service at runtime you're probably doing it wrong.
To start handling messages build an instance of this API and invoke startTracking(java.lang.Object...).
Once you are handling messages you can simply use the static methods provided (e.g. to publish messages etc). In those cases it is not necessary to inject an instance of this API. This minimizes the need for dependencies in your functional classes and maximally cashes in on location transparency.
To build an instance of this client check out DefaultFluxCapacitor.

Field Summary

Fields
Modifier and Type	Field and Description
`static AtomicReference<FluxCapacitor>`	`applicationInstance` Flux Capacitor instance set by the current application.
`static ThreadLocal<FluxCapacitor>`	`instance` Flux Capacitor instance bound to the current thread.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Client`	`client()` Returns the low level client used by this FluxCapacitor instance to interface with the Flux Capacitor service.
`CommandGateway`	`commandGateway()` Returns the gateway for command messages.
`ErrorGateway`	`errorGateway()` Returns the gateway for any error messages published while handling a command or query.
`EventGateway`	`eventGateway()` Returns the message gateway for application events.
`EventSourcing`	`eventSourcing()` Returns a client to assist with event sourcing.
`static FluxCapacitor`	`get()` Returns the FluxCapacitor client bound to the current thread or else set by the current application.
`static String`	`getProperty(String key)` Returns the property value registered with the given key.
`static String`	`getProperty(String key, String defaultValue)` Returns the property value registered with the given key.
`KeyValueStore`	`keyValueStore()` Returns a client for the key value service offered by Flux Capacitor.
`static <T> Model<T>`	`loadAggregate(String id, Class<T> modelType)` Loads the most recent aggregate root of type `T` with given id.
`MetricsGateway`	`metricsGateway()` Returns the gateway for metrics events.
`Properties`	`properties()` Returns custom properties registered with this FluxCapacitor instance.
`static void`	`publishEvent(Object event)` Publishes the given application event.
`static void`	`publishEvent(Object payload, Metadata metadata)` Publishes an event with given payload and metadata.
`static void`	`publishMetrics(Object metrics)` Publishes a metrics event.
`static void`	`publishMetrics(Object payload, Metadata metadata)` Publishes a metrics event with given payload and metadata.
`static <R> CompletableFuture<R>`	`query(Object query)` Sends the given query and returns a future that will be completed with the query's result.
`static <R> CompletableFuture<R>`	`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`	`queryAndWait(Object query)` Sends the given query and returns the query's result.
`static <R> R`	`queryAndWait(Object payload, Metadata metadata)` Sends a query with given payload and metadata and returns the query's result.
`QueryGateway`	`queryGateway()` Returns the gateway for query messages.
`default Registration`	`registerLocalHandlers(List<?> handlers)` Registers given message handlers for immediate handling of messages as they are published by the application.
`default Registration`	`registerLocalHandlers(Object... handlers)` Registers given message handlers for immediate handling of messages as they are published by the application.
`ResultGateway`	`resultGateway()` Returns the gateway for result messages sent by handlers of commands and queries.
`Scheduler`	`scheduler()` Returns the message scheduling client.
`static void`	`sendAndForgetCommand(Object command)` Sends the given command and don't wait for a result.
`static void`	`sendAndForgetCommand(Object payload, Metadata metadata)` Sends a command with given payload and metadata and don't wait for a result.
`static <R> CompletableFuture<R>`	`sendCommand(Object command)` Sends the given command and returns a future that will be completed with the command's result.
`static <R> CompletableFuture<R>`	`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`	`sendCommandAndWait(Object command)` Sends the given command and returns the command's result.
`static <R> R`	`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.
`default Registration`	`startTracking(List<?> handlers)` Registers given handlers and initiates message tracking.
`default Registration`	`startTracking(Object... handlers)` Registers given handlers and initiates message tracking (i.e.
`Tracking`	`tracking(MessageType messageType)` Returns a client to assist with the tracking of a given message type.

- Field Detail
  - applicationInstance
```
static final AtomicReference<FluxCapacitor> applicationInstance
```
    Flux Capacitor instance set by the current application. Used as a fallback when no threadlocal instance was set. This is added as a convenience for applications that never have more than one than FluxCapacitor instance which will be the case for nearly all applications. On application startup simply fill this application instance.
  - instance
```
static final ThreadLocal<FluxCapacitor> instance
```
    Flux Capacitor instance bound to the current thread. Normally there's only one FluxCapacitor client per application. Before messages are passed to message handlers the FluxCapacitor client binds itself to this field. By doing so message handlers can interact with Flux Capacitor without injecting any dependencies.
- Method Detail
  - get
```
static FluxCapacitor get()
```
    Returns the FluxCapacitor client bound to the current thread or else set by the current application. Throws an exception if no client was registered.
  - publishEvent
```
static void publishEvent(Object event)
```
    Publishes the given application event. The event may be an instance of a Message in which case it will be published as is. Otherwise the event is published using the passed value as payload without additional metadata.
    Note that the published event will not be available for event sourcing as it is does not belong to any aggregate.
    
    See Also:
    
    if you're interested in publishing events that belong to an aggregate.
  - publishEvent
```
static void publishEvent(Object payload,
                         Metadata metadata)
```
    Publishes an event with given payload and metadata.
    
    See Also:
    
    for more info
  - sendAndForgetCommand
```
static void sendAndForgetCommand(Object command)
```
    Sends the given command and don't wait for a result. The command may be an instance of a Message in which case it will be sent as is. Otherwise the command is published using the passed value as payload without additional metadata.
    
    See Also:
    
    to send a command and inspect its result
  - sendAndForgetCommand
```
static void sendAndForgetCommand(Object payload,
                                 Metadata metadata)
```
    Sends a command with given payload and metadata and don't wait for a result.
    
    See Also:
    
    to send a command and inspect its result
  - sendCommand
```
static <R> CompletableFuture<R> sendCommand(Object command)
```
    Sends the given command and returns a future that will be completed with the command's result. The command may be an instance of a Message in which case it will be sent as is. Otherwise the command is published using the passed value as payload without additional metadata.
  - sendCommand
```
static <R> CompletableFuture<R> 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.
  - sendCommandAndWait
```
static <R> R sendCommandAndWait(Object command)
```
    Sends the given command and returns the command's result. The command may be an instance of a Message in which case it will be sent as is. Otherwise the command is published using the passed value as payload without additional metadata.
  - sendCommandAndWait
```
static <R> R 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.
  - query
```
static <R> CompletableFuture<R> query(Object query)
```
    Sends the given query and returns a future that will be completed with the query's result. The query may be an instance of a Message in which case it will be sent as is. Otherwise the query is published using the passed value as payload without additional metadata.
  - query
```
static <R> CompletableFuture<R> 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.
  - queryAndWait
```
static <R> R queryAndWait(Object query)
```
    Sends the given query and returns the query's result. The query may be an instance of a Message in which case it will be sent as is. Otherwise the query is published using the passed value as payload without additional metadata.
  - queryAndWait
```
static <R> R queryAndWait(Object payload,
                          Metadata metadata)
```
    Sends a query with given payload and metadata and returns the query's result.
  - publishMetrics
```
static void publishMetrics(Object metrics)
```
    Publishes a metrics event. The parameter may be an instance of a Message in which case it will be sent as is. Otherwise the metrics event is published using the passed value as payload without additional metadata.
    Metrics events can be published in any form to log custom performance metrics about an application.
  - publishMetrics
```
static void publishMetrics(Object payload,
                           Metadata metadata)
```
    Publishes a metrics event with given payload and metadata. Metrics events can be published in any form to log custom performance metrics about an application.
  - loadAggregate
```
static <T> Model<T> loadAggregate(String id,
                                  Class<T> modelType)
```
    Loads the most recent aggregate root of type T with given id.
    
    See Also:
    
    for more info on how to define an event sourced aggregate root
  - getProperty
```
static String getProperty(String key)
```
    Returns the property value registered with the given key. If the property can't be found on the FluxCapacitor instance it will try to get the property using System.getProperty(String)
  - getProperty
```
static String getProperty(String key,
                          String defaultValue)
```
    Returns the property value registered with the given key. If the property can't be found on the FluxCapacitor instance it will try to get the property using System.getProperty(String). If the property is also not known as system property the given default value will be returned.
  - startTracking
```
default Registration startTracking(Object... handlers)
```
    Registers given handlers and initiates message tracking (i.e. listening for messages). The given handlers will be inspected for annotated handler methods (e.g. methods annotated with HandleCommand). Depending on this inspection message tracking will commence for any handled message types. To stop tracking at any time invoke Registration.cancel() on the returned object.
    Note that an exception may be thrown if tracking for a given message type is already in progress.
    Note also that it will generally not be necessary to ever invoke this method manually if you have you use Spring to configure your application.
    
    See Also:
    
    for more info on how to configure your application using Spring
  - startTracking
```
default Registration startTracking(List<?> handlers)
```
    Registers given handlers and initiates message tracking.
    
    See Also:
    
    for more info
  - registerLocalHandlers
```
default Registration registerLocalHandlers(Object... handlers)
```
    Registers given message handlers for immediate handling of messages as they are published by the application. The given handlers will be inspected for annotated handler methods (e.g. methods annotated with HandleCommand).
    If a published message can be handled locally it will not be published to the Flux Capacitor service. Local handling of messages may come in handy in several situations: e.g. when the message is expressly meant to be handled only by the current application or if the message needs to be handled as quickly as possible. However, in most cases it will not be necessary to register any local handlers.
    To stop listening for locally published messages invoke Registration.cancel() on the returned object.
    
    See Also:
    
    for more info on how to automatically register local handlers using Spring.
  - registerLocalHandlers
```
default Registration registerLocalHandlers(List<?> handlers)
```
    Registers given message handlers for immediate handling of messages as they are published by the application.
    
    See Also:
    
    for more info
  - eventSourcing
```
EventSourcing eventSourcing()
```
    Returns a client to assist with event sourcing.
  - scheduler
```
Scheduler scheduler()
```
    Returns the message scheduling client.
  - keyValueStore
```
KeyValueStore keyValueStore()
```
    Returns a client for the key value service offered by Flux Capacitor.
  - commandGateway
```
CommandGateway commandGateway()
```
    Returns the gateway for command messages.
  - queryGateway
```
QueryGateway queryGateway()
```
    Returns the gateway for query messages.
  - eventGateway
```
EventGateway eventGateway()
```
    Returns the message gateway for application events. Use eventSourcing() to publish events belonging to an aggregate.
  - resultGateway
```
ResultGateway resultGateway()
```
    Returns the gateway for result messages sent by handlers of commands and queries.
  - errorGateway
```
ErrorGateway errorGateway()
```
    Returns the gateway for any error messages published while handling a command or query.
  - metricsGateway
```
MetricsGateway metricsGateway()
```
    Returns the gateway for metrics events. Metrics events can be published in any form to log custom performance metrics about an application.
  - tracking
```
Tracking tracking(MessageType messageType)
```
    Returns a client to assist with the tracking of a given message type.
  - client
```
Client client()
```
    Returns the low level client used by this FluxCapacitor instance to interface with the Flux Capacitor service. Of course the returned client may also be a stand-in for the actual service.
  - properties
```
Properties properties()
```
    Returns custom properties registered with this FluxCapacitor instance.

Interface FluxCapacitor

Field Summary

Method Summary

Field Detail

applicationInstance

instance

Method Detail

get

publishEvent

publishEvent

sendAndForgetCommand

sendAndForgetCommand

sendCommand

sendCommand

sendCommandAndWait

sendCommandAndWait

query

query

queryAndWait

queryAndWait

publishMetrics

publishMetrics

loadAggregate

getProperty

getProperty

startTracking

startTracking

registerLocalHandlers

registerLocalHandlers

eventSourcing

scheduler

keyValueStore

commandGateway

queryGateway

eventGateway

resultGateway

errorGateway

metricsGateway

tracking

client

properties