• Home
• org.alluxio
• alluxio-core-common
• 291-beta
• source code
• PropertyKey.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

alluxio.conf.PropertyKey Maven / Gradle / Ivy

/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.conf;

import static alluxio.conf.PropertyKey.Builder.booleanBuilder;
import static alluxio.conf.PropertyKey.Builder.classBuilder;
import static alluxio.conf.PropertyKey.Builder.dataSizeBuilder;
import static alluxio.conf.PropertyKey.Builder.doubleBuilder;
import static alluxio.conf.PropertyKey.Builder.durationBuilder;
import static alluxio.conf.PropertyKey.Builder.enumBuilder;
import static alluxio.conf.PropertyKey.Builder.intBuilder;
import static alluxio.conf.PropertyKey.Builder.listBuilder;
import static alluxio.conf.PropertyKey.Builder.longBuilder;
import static alluxio.conf.PropertyKey.Builder.stringBuilder;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkState;
import static java.lang.String.format;

import alluxio.Constants;
import alluxio.DefaultSupplier;
import alluxio.ProjectConstants;
import alluxio.RuntimeConstants;
import alluxio.annotation.PublicApi;
import alluxio.client.ReadType;
import alluxio.client.WriteType;
import alluxio.client.file.cache.ShadowCacheType;
import alluxio.client.file.cache.store.PageStoreType;
import alluxio.exception.ExceptionMessage;
import alluxio.executor.RpcExecutorType;
import alluxio.executor.ThreadPoolExecutorQueueType;
import alluxio.grpc.LoadMetadataPType;
import alluxio.grpc.Scope;
import alluxio.grpc.TtlAction;
import alluxio.grpc.WritePType;
import alluxio.master.GraceMode;
import alluxio.master.ZookeeperConnectionErrorPolicy;
import alluxio.master.file.MetadataSyncTraversalOrder;
import alluxio.master.journal.JournalType;
import alluxio.master.metastore.MetastoreType;
import alluxio.master.metastore.rocks.DataBlockIndexType;
import alluxio.master.metastore.rocks.IndexType;
import alluxio.network.ChannelType;
import alluxio.network.netty.FileTransferType;
import alluxio.security.authentication.AuthType;
import alluxio.util.FormatUtils;
import alluxio.util.OSUtils;
import alluxio.util.io.PathUtils;
import alluxio.worker.block.BlockStoreType;
import alluxio.worker.block.management.BackoffStrategy;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Joiner;
import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.collect.ImmutableList;
import com.sun.management.OperatingSystemMXBean;
import io.netty.util.ResourceLeakDetector;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.lang.management.ManagementFactory;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nullable;
import javax.annotation.concurrent.ThreadSafe;

/**
 * Configuration property keys. This class provides a set of pre-defined property keys.
 */
@ThreadSafe
@PublicApi
public final class PropertyKey implements Comparable {
  /** Regex string to find "${key}" for variable substitution. */
  public static final String REGEX_STRING = "(\\$\\{([^{}]*)\\})";
  /** Regex to find ${key} for variable substitution. */
  public static final Pattern CONF_REGEX = Pattern.compile(REGEX_STRING);

  private static final Logger LOG = LoggerFactory.getLogger(PropertyKey.class);

  // The following two maps must be the first to initialize within this file.
  /** A map from default property key's string name to the key. */
  private static final Map DEFAULT_KEYS_MAP = new ConcurrentHashMap<>();
  /** A map from default property key's alias to the key. */
  private static final Map DEFAULT_ALIAS_MAP = new ConcurrentHashMap<>();
  /** A cache storing result for template regexp matching results. */
  private static final Cache REGEXP_CACHE = CacheBuilder.newBuilder()
      .maximumSize(1024)
      .build();

  /**
   * The consistency check level to apply to a certain property key.
   * User can run "alluxio validateEnv all cluster.conf.consistent" to validate the consistency of
   * configuration properties within the cluster. The command reads all Alluxio properties on
   * each node of the cluster and shows error or warning for properties that have inconsistent
   * values among the nodes. For example, it would show error if the Alluxio property for aws secret
   * access key has some value on a master node and a different value on one of the worker nodes.
   */
  public enum ConsistencyCheckLevel {
    /**
     * Do not check consistency of property value.
     * This should be set if the property is not required to have same value among the nodes
     * (e.g. worker hostname).
     */
    IGNORE,
    /**
     * Check consistency of property value, show warning of inconsistent values.
     * This should be set if the property is recommended to have same value among the nodes,
     * although having different values does not cause immediate issues(e.g. alluxio home folder
     * location, timeout value for connecting to a worker).
     */
    WARN,
    /**
     * Check consistency of property value, show error of inconsistent values.
     * This should be set if the property is required to have same value among the nodes
     * (e.g. AWS credentials, journal location).
     */
    ENFORCE,
  }

  /**
   * Indicates how the property value should be displayed.
   */
  public enum DisplayType {
    /**
     * The property value should be displayed normally.
     */
    DEFAULT,
    /**
     * The property value contains credentials and should not be displayed directly.
     */
    CREDENTIALS,
  }

  /**
   * Indicates property type.
   */
  public enum PropertyType {
    /**
     * The Property's value is of boolean type, stored as a Boolean.
     */
    BOOLEAN(Boolean.class),
    /**
     * The Property's value is of integer type, stored as an Integer.
     */
    INTEGER(Integer.class),
    /**
     * The Property's value is of long integer type, stored as a long.
     */
    LONG(Long.class),
    /**
     * The Property's value is of double type, stored as a Double.
     */
    DOUBLE(Double.class),
    /**
     * The Property's value is of string type, stored as a String.
     */
    STRING(String.class),
    /**
     * The Property's value represents a time duration, stored as a Long in ms.
     */
    DURATION(String.class),
    /**
     * The Property's value represents a data size, stored as a Long in bytes.
     */
    DATASIZE(String.class),
    /**
     * The Property's value is of list type, stored as a delimiter separated string.
     */
    LIST(String.class),
    /**
     * The Property's value is an enum for a predefined enum class.
     */
    ENUM(Enum.class),
    /**
     * The Property's value is of class type, stored as a Class.
     */
    CLASS(String.class);

    private final Class mJavaType;

    PropertyType(Class javaType) {
      mJavaType = javaType;
    }

    Class getJavaType() {
      return mJavaType;
    }
  }

  public static final Function CHECK_FILE_EXISTS = (fileName) -> {
    if (!(fileName instanceof String)) {
      return false;
    }
    File file = new File((String) fileName);
    return file.exists();
  };

  /**
   * Builder to create {@link PropertyKey} instances. Note that, Builder.build() will
   * throw exception if there is an existing property built with the same name.
   */
  public static final class Builder {
    private String[] mAlias;
    private DefaultSupplier mDefaultSupplier;
    private Object mDefaultValue;
    private String mDescription;
    private String mName;
    private boolean mIgnoredSiteProperty;
    private boolean mIsBuiltIn = true;
    private boolean mIsHidden;
    private ConsistencyCheckLevel mConsistencyCheckLevel = ConsistencyCheckLevel.IGNORE;
    private Scope mScope = Scope.ALL;
    private DisplayType mDisplayType = DisplayType.DEFAULT;
    private boolean mIsDynamic = true;
    private Function mValueValidationFunction;
    private final PropertyType mType;
    private final Optional> mEnumType;
    private final Optional mDelimiter;

    /**
     * @param name name of the property
     * @return a Builder for boolean properties
     */
    public static Builder booleanBuilder(String name) {
      return new Builder(name, PropertyType.BOOLEAN);
    }

    /**
     * @param name name of the property
     * @return a Builder for int properties
     */
    public static Builder intBuilder(String name) {
      return new Builder(name, PropertyType.INTEGER);
    }

    /**
     * @param name name of the property
     * @return a Builder for int properties
     */
    public static Builder longBuilder(String name) {
      return new Builder(name, PropertyType.LONG);
    }

    /**
     * @param name name of the property
     * @return a Builder for double properties
     */
    public static Builder doubleBuilder(String name) {
      return new Builder(name, PropertyType.DOUBLE);
    }

    /**
     * @param name name of the property
     * @return a Builder for string properties
     */
    public static Builder stringBuilder(String name) {
      return new Builder(name, PropertyType.STRING);
    }

    /**
     * @param name name of the property
     * @param enumType enum class of the property
     * @return a Builder for enum properties
     */
    public static Builder enumBuilder(String name, Class enumType) {
      return new Builder(name, PropertyType.ENUM, Optional.of(enumType), Optional.empty());
    }

    /**
     * @param name name of the property
     * @return a Builder for time duration properties
     */
    public static Builder durationBuilder(String name) {
      return new Builder(name, PropertyType.DURATION);
    }

    /**
     * @param name name of the property
     * @return a Builder for data size properties
     */
    public static Builder dataSizeBuilder(String name) {
      return new Builder(name, PropertyType.DATASIZE);
    }

    /**
     * @param name name of the property
     * @return a Builder for class properties
     */
    public static Builder classBuilder(String name) {
      return new Builder(name, PropertyType.CLASS);
    }

    /**
     * @param name name of the property
     * @return a Builder for list properties
     */
    public static Builder listBuilder(String name) {
      return new Builder(name, PropertyType.LIST, Optional.empty(), Optional.of(","));
    }

    private Builder(String name, PropertyType type) {
      this(name, type, Optional.empty(), Optional.empty());
    }

    private Builder(
        String name,
        PropertyType type,
        Optional> enumType,
        Optional delimiter) {
      mName = name;
      mType = type;
      mEnumType = enumType;
      mDelimiter = delimiter;
    }

    /**
     * @param template template for the property name
     * @param params parameters of the template
     */
    public Builder(PropertyKey.Template template, Object... params) {
      this(PropertyType.STRING, template, params);
    }

    /**
     * @param type type of the property
     * @param template template for the property name
     * @param params parameters of the template
     */
    public Builder(PropertyType type, PropertyKey.Template template, Object... params) {
      this(format(template.mFormat, params), type);
    }

    /**
     * @param type type of the property
     * @param delimiter delimiter for value, if list value is given as a string
     * @param template template for the property name
     * @param params parameters of the template
     */
    public Builder(PropertyType type, Optional delimiter,
        PropertyKey.Template template, Object... params) {
      this(format(template.mFormat, params), type, Optional.empty(), delimiter);
    }

    /**
     * @param aliases aliases for the property
     * @return the updated builder instance
     */
    public Builder setAlias(String... aliases) {
      mAlias = Arrays.copyOf(aliases, aliases.length);
      return this;
    }

    /**
     * @param name name for the property
     * @return the updated builder instance
     */
    public Builder setName(String name) {
      mName = name;
      return this;
    }

    /**
     * @param defaultSupplier supplier for the property's default value
     * @return the updated builder instance
     */
    public Builder setDefaultSupplier(DefaultSupplier defaultSupplier) {
      if (defaultSupplier.get() == null
          || defaultSupplier.get().getClass().equals(mType.getJavaType())) {
        mDefaultSupplier = defaultSupplier;
      } else {
        mDefaultSupplier = new DefaultSupplier(() -> String.valueOf(defaultSupplier.get()),
            defaultSupplier.getDescription());
      }
      return this;
    }

    /**
     * @param supplier supplier for the property's default value
     * @param description description of the default value
     * @return the updated builder instance
     */
    public Builder setDefaultSupplier(Supplier