net.kuujo.copycat.state.StateMachineConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of copycat-state-machine Show documentation
The newest version!
/*
 * 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 com.typesafe.config.ConfigValueFactory;
import net.kuujo.copycat.cluster.ClusterConfig;
import net.kuujo.copycat.cluster.internal.coordinator.CoordinatedResourceConfig;
import net.kuujo.copycat.log.Log;
import net.kuujo.copycat.protocol.Consistency;
import net.kuujo.copycat.state.internal.DefaultStateMachine;
import net.kuujo.copycat.util.ConfigurationException;
import net.kuujo.copycat.util.internal.Assert;
import net.kuujo.copycat.util.serializer.Serializer;

import java.lang.reflect.Modifier;
import java.util.Arrays;
import java.util.Collection;
import java.util.Map;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;

/**
 * State machine configuration.
 *
 * @author Jordan Halterman
 */
public class StateMachineConfig extends StateLogConfig {
  private static final String STATE_MACHINE_STATE_TYPE = "state-type";
  private static final String STATE_MACHINE_INITIAL_STATE = "initial-state";

  private static final String DEFAULT_CONFIGURATION = "state-machine-defaults";
  private static final String CONFIGURATION = "state-machine";

  public StateMachineConfig() {
    super(CONFIGURATION, DEFAULT_CONFIGURATION);
  }

  public StateMachineConfig(Map config) {
    super(config, CONFIGURATION, DEFAULT_CONFIGURATION);
  }

  public StateMachineConfig(String resource) {
    super(resource, CONFIGURATION, DEFAULT_CONFIGURATION);
  }

  protected StateMachineConfig(StateMachineConfig config) {
    super(config);
  }

  @Override
  public StateMachineConfig copy() {
    return new StateMachineConfig(this);
  }

  /**
   * Sets the state machine state type.
   *
   * @param stateType The state machine state interface.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws net.kuujo.copycat.util.ConfigurationException If the given class is not found
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public void setStateType(String stateType) {
    try {
      setStateType(Class.forName(Assert.isNotNull(stateType, "stateType")));
    } catch (ClassNotFoundException e) {
      throw new ConfigurationException("Failed to load state type", e);
    }
  }

  /**
   * Sets the state machine state type.
   *
   * @param stateType The state machine state type.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public void setStateType(Class stateType) {
    this.config = config.withValue(STATE_MACHINE_STATE_TYPE, ConfigValueFactory.fromAnyRef(Assert.arg(stateType, Assert.isNotNull(stateType, "stateType").isInterface(), "state type must be an interface").getName()));
  }

  /**
   * Returns the state machine state type.
   *
   * @return The state machine state type.
   * @throws net.kuujo.copycat.util.ConfigurationException If the configured class is not found
   */
  @SuppressWarnings("unchecked")
  public  Class getStateType() {
    try {
      return config.hasPath(STATE_MACHINE_STATE_TYPE) ? (Class) Class.forName(config.getString(STATE_MACHINE_STATE_TYPE)) : null;
    } catch (ClassNotFoundException e) {
      throw new ConfigurationException("Failed to load state type", e);
    }
  }

  /**
   * Sets the state machine state type, returning the state machine configuration for method chaining.
   *
   * @param stateType The state machine state type.
   * @return The state machine configuration.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws net.kuujo.copycat.util.ConfigurationException If the given class is not found
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public StateMachineConfig withStateType(String stateType) {
    setStateType(stateType);
    return this;
  }

  /**
   * Sets the state machine state type, returning the state machine configuration for method chaining.
   *
   * @param stateType The state machine state type.
   * @return The state machine configuration.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public StateMachineConfig withStateType(Class stateType) {
    setStateType(stateType);
    return this;
  }

  /**
   * Sets the state machine's initial state.
   *
   * @param initialState The state machine's initial state.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws net.kuujo.copycat.util.ConfigurationException If the given class is not found
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public void setInitialState(String initialState) {
    try {
      setInitialState(Class.forName(Assert.isNotNull(initialState, "initialState")));
    } catch (ClassNotFoundException e) {
      throw new ConfigurationException("Failed to load initial state", e);
    }
  }

  /**
   * Sets the state machine's initial state.
   *
   * @param initialState The state machine's initial state.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public void setInitialState(Class initialState) {
    Assert.isNotNull(initialState, "initialState");
    Assert.arg(initialState, !initialState.isInterface() && !initialState.isEnum() && !initialState.isAnonymousClass() && !Modifier.isAbstract(initialState.getModifiers()), "state implementations must be concrete classes");
    this.config = config.withValue(STATE_MACHINE_INITIAL_STATE, ConfigValueFactory.fromAnyRef(initialState.getName()));
  }

  /**
   * Returns the state machine's initial state.
   *
   * @return The state machine's initial state.
   * @throws net.kuujo.copycat.util.ConfigurationException If the configured class is not found
   */
  @SuppressWarnings("unchecked")
  public  Class getInitialState() {
    try {
      return config.hasPath(STATE_MACHINE_INITIAL_STATE) ? (Class) Class.forName(config.getString(STATE_MACHINE_INITIAL_STATE)) : null;
    } catch (ClassNotFoundException e) {
      throw new ConfigurationException("Failed to load initial state", e);
    }
  }

  /**
   * Sets the state machine's initial state, returning the state machine configuration for method chaining.
   *
   * @param initialState The state machine's initial state.
   * @return The state machine configuration.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws net.kuujo.copycat.util.ConfigurationException If the given class is not found
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public StateMachineConfig withInitialState(String initialState) {
    setInitialState(initialState);
    return this;
  }

  /**
   * Sets the state machine's initial state, returning the state machine configuration for method chaining.
   *
   * @param initialState The state machine's initial state.
   * @return The state machine configuration.
   * @throws java.lang.NullPointerException If the {@code stateType} is {@code null}
   * @throws java.lang.IllegalArgumentException If the given class is not a valid interface
   */
  public StateMachineConfig withInitialState(Class initialState) {
    setInitialState(initialState);
    return this;
  }

  @Override
  public StateMachineConfig withSerializer(String serializer) {
    setSerializer(serializer);
    return this;
  }

  @Override
  public StateMachineConfig withSerializer(Class serializer) {
    setSerializer(serializer);
    return this;
  }

  @Override
  public StateMachineConfig withSerializer(Serializer serializer) {
    setSerializer(serializer);
    return this;
  }

  @Override
  public StateMachineConfig withExecutor(Executor executor) {
    setExecutor(executor);
    return this;
  }

  @Override
  public StateMachineConfig withElectionTimeout(long electionTimeout) {
    setElectionTimeout(electionTimeout);
    return this;
  }

  @Override
  public StateMachineConfig withElectionTimeout(long electionTimeout, TimeUnit unit) {
    setElectionTimeout(electionTimeout, unit);
    return this;
  }

  @Override
  public StateMachineConfig withHeartbeatInterval(long heartbeatInterval) {
    setHeartbeatInterval(heartbeatInterval);
    return this;
  }

  @Override
  public StateMachineConfig withHeartbeatInterval(long heartbeatInterval, TimeUnit unit) {
    setHeartbeatInterval(heartbeatInterval, unit);
    return this;
  }

  @Override
  public StateMachineConfig withReplicas(String... replicas) {
    setReplicas(Arrays.asList(replicas));
    return this;
  }

  @Override
  public StateMachineConfig withReplicas(Collection replicas) {
    setReplicas(replicas);
    return this;
  }

  @Override
  public StateMachineConfig addReplica(String replica) {
    super.addReplica(replica);
    return this;
  }

  @Override
  public StateMachineConfig removeReplica(String replica) {
    super.removeReplica(replica);
    return this;
  }

  @Override
  public StateMachineConfig clearReplicas() {
    super.clearReplicas();
    return this;
  }

  @Override
  public StateMachineConfig withLog(Log log) {
    setLog(log);
    return this;
  }

  @Override
  public StateMachineConfig withDefaultConsistency(String consistency) {
    setDefaultConsistency(consistency);
    return this;
  }

  @Override
  public StateMachineConfig withDefaultConsistency(Consistency consistency) {
    setDefaultConsistency(consistency);
    return this;
  }

  @Override
  public CoordinatedResourceConfig resolve(ClusterConfig cluster) {
    Assert.config(getReplicas(), getReplicas().isEmpty() || cluster.getMembers().containsAll(getReplicas()), "Resource replica set must contain only active cluster members");
    return new StateLogConfig(toMap())
      .resolve(cluster)
      .withResourceType(DefaultStateMachine.class)
      .withResourceConfig(this);
  }

}