net.kuujo.copycat.state

Interface StateLog<T>

All Superinterfaces:

Managed<StateLog<T>>, Resource<StateLog<T>>

All Known Implementing Classes:

DefaultStateLog

public interface StateLog<T>
extends Resource<StateLog<T>>

Copycat event log.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
static <T> StateLog<T>	create(String name) Creates a new state log with the default cluster and state log configurations.
static <T> StateLog<T>	create(String name, ClusterConfig cluster) Creates a new state log with the default state log configuration.
static <T> StateLog<T>	create(String name, ClusterConfig cluster, StateLogConfig config) Creates a new state log.
<V> StateLog<T>	installWith(java.util.function.Consumer<V> installer) Registers a state log snapshot installer.
<U extends T,V> StateLog<T>	registerCommand(String name, java.util.function.Function<U,V> command) Registers a state command.
<U extends T,V> StateLog<T>	registerQuery(String name, java.util.function.Function<U,V> query) Registers a state query.
<U extends T,V> StateLog<T>	registerQuery(String name, java.util.function.Function<U,V> query, Consistency consistency) Registers a state query.
<V> StateLog<T>	snapshotWith(java.util.function.Supplier<V> snapshotter) Registers a state log snapshot function.
<U> CompletableFuture<U>	submit(String command, T entry) Submits a state command or query to the log.
StateLog<T>	unregister(String name) Unregisters a state command or query.
StateLog<T>	unregisterCommand(String name) Unregisters a state command.
StateLog<T>	unregisterQuery(String name) Unregisters a state query.

Methods inherited from interface net.kuujo.copycat.resource.Resource

addShutdownTask, addStartupTask, cluster, name, state

Methods inherited from interface net.kuujo.copycat.util.Managed

close, isClosed, isOpen, open

Method Detail

create

static <T> StateLog<T> create(String name)

Creates a new state log with the default cluster and state log configurations.

The state log will be constructed with the default cluster configuration. The default cluster configuration searches for two resources on the classpath - cluster and {cluster-defaults} - in that order. Configuration options specified in cluster.conf will override those in {cluster-defaults.conf}.

Additionally, the state log will be constructed with an state log configuration that searches the classpath for three configuration files - {name}, state-log, state-log-defaults, resource, and resource-defaults - in that order. The first resource is a configuration resource with the same name as the state log resource. If the resource is namespaced - e.g. `state-logs.my-log.conf` - then resource configurations will be loaded according to namespaces as well; for example, `state-logs.conf`.

Type Parameters:

T - The state log entry type.

Parameters:

name - The state log resource name.

Returns:

A new state log instance.

create

static <T> StateLog<T> create(String name,
                              ClusterConfig cluster)

Creates a new state log with the default state log configuration.

The state log will be constructed with an state log configuration that searches the classpath for three configuration files - {name}, state-log, state-log-defaults, resource, and resource-defaults - in that order. The first resource is a configuration resource with the same name as the state log resource. If the resource is namespaced - e.g. `state-logs.my-log.conf` - then resource configurations will be loaded according to namespaces as well; for example, `state-logs.conf`.

Type Parameters:

T - The state log entry type.

Parameters:

name - The state log resource name.

cluster - The state log cluster configuration.

Returns:

A new state log instance.

create

static <T> StateLog<T> create(String name,
                              ClusterConfig cluster,
                              StateLogConfig config)

Creates a new state log.

Type Parameters:

T - The state log entry type.

Parameters:

name - The state log resource name.

cluster - The state log cluster configuration.

config - The state log configuration.

Returns:

A new state log instance.

registerCommand

<U extends T,V> StateLog<T> registerCommand(String name,
                                            java.util.function.Function<U,V> command)

Registers a state command.

Type Parameters:

U - The command input type.

V - The command output type.

Parameters:

name - The command name.

command - The command function.

Returns:

The state log.

unregisterCommand

StateLog<T> unregisterCommand(String name)

Unregisters a state command.

Parameters:

name - The command name.

Returns:

The state log.

registerQuery

<U extends T,V> StateLog<T> registerQuery(String name,
                                          java.util.function.Function<U,V> query)

Registers a state query.

Type Parameters:

U - The query input type.

V - The query output type.

Parameters:

name - The query name.

query - The query function.

Returns:

The state log.

registerQuery

<U extends T,V> StateLog<T> registerQuery(String name,
                                          java.util.function.Function<U,V> query,
                                          Consistency consistency)

Registers a state query.

Type Parameters:

U - The query input type.

V - The query output type.

Parameters:

name - The query name.

query - The query function.

consistency - The default query consistency.

Returns:

The state log.

unregisterQuery

StateLog<T> unregisterQuery(String name)

Unregisters a state query.

Parameters:

name - The query name.

Returns:

The state log.

unregister

StateLog<T> unregister(String name)

Unregisters a state command or query.

Parameters:

name - The command or query name.

Returns:

The state log.

snapshotWith

<V> StateLog<T> snapshotWith(java.util.function.Supplier<V> snapshotter)

Registers a state log snapshot function.

Parameters:

snapshotter - The snapshot function.

Returns:

The state log.

installWith

<V> StateLog<T> installWith(java.util.function.Consumer<V> installer)

Registers a state log snapshot installer.

Parameters:

installer - The snapshot installer.

Returns:

The state log.

submit

<U> CompletableFuture<U> submit(String command,
                                T entry)

Submits a state command or query to the log.

Type Parameters:

U - The command return type.

Parameters:

command - The command name.

entry - The command entry.

Returns:

A completable future to be completed once the command output is received.