net.kuujo.copycat.state.StateLog Maven / Gradle / Ivy
/*
* Copyright 2014 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.kuujo.copycat.state;
import net.kuujo.copycat.cluster.ClusterConfig;
import net.kuujo.copycat.cluster.internal.coordinator.ClusterCoordinator;
import net.kuujo.copycat.cluster.internal.coordinator.CoordinatorConfig;
import net.kuujo.copycat.cluster.internal.coordinator.DefaultClusterCoordinator;
import net.kuujo.copycat.protocol.Consistency;
import net.kuujo.copycat.resource.Resource;
import net.kuujo.copycat.util.function.TriConsumer;
import java.lang.reflect.Method;
import java.util.concurrent.CompletableFuture;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
/**
* Copycat event log.
*
* @author Jordan Halterman
*/
public interface StateLog extends Resource> {
/**
* 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 - {@code cluster} and {cluster-defaults} - in that order. Configuration
* options specified in {@code 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 - {@code {name}}, {@code state-log}, {@code state-log-defaults}, {@code resource}, and
* {@code 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`.
*
* @param name The state log resource name.
* @param The state log entry type.
* @return A new state log instance.
*/
static StateLog create(String name) {
return create(name, new ClusterConfig(), new StateLogConfig());
}
/**
* 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 - {@code {name}}, {@code state-log}, {@code state-log-defaults}, {@code resource}, and
* {@code 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`.
*
* @param name The state log resource name.
* @param cluster The state log cluster configuration.
* @param The state log entry type.
* @return A new state log instance.
*/
static StateLog create(String name, ClusterConfig cluster) {
return create(name, cluster, new StateLogConfig());
}
/**
* Creates a new state log.
*
* @param name The state log resource name.
* @param cluster The state log cluster configuration.
* @param config The state log configuration.
* @param The state log entry type.
* @return A new state log instance.
*/
static StateLog create(String name, ClusterConfig cluster, StateLogConfig config) {
ClusterCoordinator coordinator = new DefaultClusterCoordinator(new CoordinatorConfig().withName(name).withClusterConfig(cluster));
return coordinator.>getResource(name, config.resolve(cluster))
.addStartupTask(() -> coordinator.open().thenApply(v -> null))
.addShutdownTask(coordinator::close);
}
/**
* Registers a state command.
*
* @param name The command name
* @param command The command function.
* @param The command input type.
* @param The command output type.
* @return The state log.
*/
StateLog registerCommand(String name, Function command);
/**
* Unregisters a state command.
*
* @param name The command name.
* @return The state log.
*/
StateLog unregisterCommand(String name);
/**
* Registers a watcher.
* @param watcher watcher
* @return The state log
*/
StateLog registerWatcher(TriConsumer watcher);
/**
* Unregisters a watcher.
* @param watcher watcher
* @return The state log
*/
StateLog unregisterWatcher(TriConsumer watcher);
/**
* Registers a state query.
*
* @param name The query name
* @param query The query function.
* @param The query input type.
* @param The query output type.
* @return The state log.
*/
StateLog registerQuery(String name, Function query);
/**
* Registers a state query.
*
* @param name The query name
* @param query The query function.
* @param consistency The default query consistency.
* @param The query input type.
* @param The query output type.
* @return The state log.
*/
StateLog registerQuery(String name, Function query, Consistency consistency);
/**
* Unregisters a state query.
*
* @param name The query name.
* @return The state log.
*/
StateLog unregisterQuery(String name);
/**
* Unregisters a state command or query.
*
* @param name The command or query name.
* @return The state log.
*/
StateLog unregister(String name);
/**
* Registers a state log snapshot function.
*
* @param snapshotter The snapshot function.
* @return The state log.
*/
StateLog snapshotWith(Supplier snapshotter);
/**
* Registers a state log snapshot installer.
*
* @param installer The snapshot installer.
* @return The state log.
*/
StateLog installWith(Consumer installer);
/**
* Submits a state command or query to the log.
*
* @param command The command name.
* @param entry The command entry.
* @param The command return type.
* @return A completable future to be completed once the command output is received.
*/
CompletableFuture submit(String command, T entry);
}