net.kuujo.copycat.resource.Resource 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.resource;
import net.kuujo.copycat.util.Managed;
import net.kuujo.copycat.Task;
import net.kuujo.copycat.cluster.Cluster;
import java.util.concurrent.CompletableFuture;
/**
* Partitioned Copycat resource.
*
* @author Jordan Halterman
*/
public interface Resource> extends Managed {
/**
* Returns the resource name.
*
* @return The resource name.
*/
String name();
/**
* Returns the current resource state.
*
* All resources begin in the {@link ResourceState#RECOVER} state. Once the Raft algorithm has caught up to the
* leader's commit index at the time the resource was opened the resource will transition to the
* {@link ResourceState#HEALTHY} state.
*
* @return The current resource state.
*/
ResourceState state();
/**
* Returns the resource cluster.
*
* @return The resource cluster.
*/
Cluster cluster();
/**
* Adds a startup task to the event log.
*
* @param task The startup task to add.
* @return The Copycat context.
*/
T addStartupTask(Task> task);
/**
* Adds a shutdown task to the event log.
*
* @param task The shutdown task to remove.
* @return The Copycat context.
*/
T addShutdownTask(Task> task);
}