net.kuujo.copycat.state.internal

Class DefaultStateLog<T>

java.lang.Object

net.kuujo.copycat.resource.internal.AbstractResource<StateLog<T>>

net.kuujo.copycat.state.internal.DefaultStateLog<T>

All Implemented Interfaces:

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

public class DefaultStateLog<T>
extends AbstractResource<StateLog<T>>
implements StateLog<T>

Default state log partition implementation.

Author:

Jordan Halterman

Field Summary

Fields inherited from class net.kuujo.copycat.resource.internal.AbstractResource

context, executor, serializer

Constructor Summary

Constructors

Constructor and Description
DefaultStateLog(ResourceContext context)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close()
<V> StateLog<T>	installWith(java.util.function.Consumer<V> installer) Registers a state log snapshot installer.
CompletableFuture<StateLog<T>>	open()
<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.
String	toString()
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 class net.kuujo.copycat.resource.internal.AbstractResource

addShutdownTask, addStartupTask, cluster, isClosed, isOpen, name, runShutdownTasks, runStartupTasks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kuujo.copycat.state.StateLog

create, create, create

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

addShutdownTask, addStartupTask, cluster, name

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

isClosed, isOpen

Constructor Detail

DefaultStateLog

public DefaultStateLog(ResourceContext context)

Method Detail

registerCommand

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

Description copied from interface: StateLog

Registers a state command.

Specified by:

registerCommand in interface StateLog<T>

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

public StateLog<T> unregisterCommand(String name)

Description copied from interface: StateLog

Unregisters a state command.

Specified by:

unregisterCommand in interface StateLog<T>

Parameters:

name - The command name.

Returns:

The state log.

registerQuery

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

Description copied from interface: StateLog

Registers a state query.

Specified by:

registerQuery in interface StateLog<T>

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

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

Description copied from interface: StateLog

Registers a state query.

Specified by:

registerQuery in interface StateLog<T>

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

public StateLog<T> unregisterQuery(String name)

Description copied from interface: StateLog

Unregisters a state query.

Specified by:

unregisterQuery in interface StateLog<T>

Parameters:

name - The query name.

Returns:

The state log.

unregister

public StateLog<T> unregister(String name)

Description copied from interface: StateLog

Unregisters a state command or query.

Specified by:

unregister in interface StateLog<T>

Parameters:

name - The command or query name.

Returns:

The state log.

snapshotWith

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

Description copied from interface: StateLog

Registers a state log snapshot function.

Specified by:

snapshotWith in interface StateLog<T>

Parameters:

snapshotter - The snapshot function.

Returns:

The state log.

installWith

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

Description copied from interface: StateLog

Registers a state log snapshot installer.

Specified by:

installWith in interface StateLog<T>

Parameters:

installer - The snapshot installer.

Returns:

The state log.

submit

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

Description copied from interface: StateLog

Submits a state command or query to the log.

Specified by:

submit in interface StateLog<T>

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.

open

public CompletableFuture<StateLog<T>> open()

Specified by:

open in interface Managed<StateLog<T>>

close

public CompletableFuture<Void> close()

Specified by:

close in interface Managed<StateLog<T>>

toString

public String toString()

Overrides:

toString in class Object