org.apache.ratis.RaftConfigKeys Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ratis-common Show documentation
There is a newer version: 3.1.2
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.ratis;

import static org.apache.ratis.conf.ConfUtils.get;
import static org.apache.ratis.conf.ConfUtils.getBoolean;
import static org.apache.ratis.conf.ConfUtils.printAll;
import static org.apache.ratis.conf.ConfUtils.set;
import static org.apache.ratis.conf.ConfUtils.setBoolean;

import org.apache.ratis.conf.RaftProperties;
import org.apache.ratis.datastream.SupportedDataStreamType;
import org.apache.ratis.rpc.RpcType;
import org.apache.ratis.rpc.SupportedRpcType;

import java.util.function.Consumer;

public interface RaftConfigKeys {
  String PREFIX = "raft";

  interface Rpc {
    String PREFIX = RaftConfigKeys.PREFIX + ".rpc";

    String TYPE_KEY = PREFIX + ".type";
    String TYPE_DEFAULT = SupportedRpcType.GRPC.name();

    static RpcType type(RaftProperties properties, Consumer logger) {
      final String t = get(properties::get, TYPE_KEY, TYPE_DEFAULT, logger);
      return RpcType.valueOf(t);
    }

    static void setType(RaftProperties properties, RpcType type) {
      set(properties::set, TYPE_KEY, type.name());
    }
  }

  interface DataStream {
    String PREFIX = RaftConfigKeys.PREFIX + ".datastream";

    String TYPE_KEY = PREFIX + ".type";
    String TYPE_DEFAULT = SupportedDataStreamType.DISABLED.name();

    static SupportedDataStreamType type(RaftProperties properties, Consumer logger) {
      final String t = get(properties::get, TYPE_KEY, TYPE_DEFAULT, logger);
      return SupportedDataStreamType.valueOfIgnoreCase(t);
    }

    static void setType(RaftProperties properties, SupportedDataStreamType type) {
      set(properties::set, TYPE_KEY, type.name());
    }

    String SKIP_SEND_FORWARD_KEY = PREFIX + ".skip.send-forward";
    boolean SKIP_SEND_FORWARD_DEFAULT = false;

    static boolean skipSendForward(RaftProperties properties, Consumer logger) {
      return getBoolean(properties::getBoolean, SKIP_SEND_FORWARD_KEY, SKIP_SEND_FORWARD_DEFAULT, logger);
    }

    static void setSkipSendForward(RaftProperties properties, boolean skipSendForward) {
      setBoolean(properties::setBoolean, SKIP_SEND_FORWARD_KEY, skipSendForward);
    }
  }

  static void main(String[] args) {
    printAll(RaftConfigKeys.class);
  }
}