alluxio.RuntimeConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of alluxio-core-common Show documentation
Common utilities shared in Alluxio core modules
There is a newer version: 313
/*
 * 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;

import alluxio.grpc.BuildVersion;

import javax.annotation.concurrent.ThreadSafe;

/**
 * System constants that are determined during runtime.
 */
// Note: PropertyKey depends on this class, so this class shouldn't depend on any classes that have
// a dependency on PropertyKey.
@ThreadSafe
public final class RuntimeConstants {
  /** The version of this Alluxio instance. */
  public static final String VERSION = ProjectConstants.VERSION;

  static {
    if (VERSION.endsWith("SNAPSHOT")) {
      ALLUXIO_DOCS_URL = "https://docs.alluxio.io/os/user/edge";
      ALLUXIO_JAVADOC_URL = "https://docs.alluxio.io/os/javadoc/edge";
    } else {
      ALLUXIO_DOCS_URL =
          "https://docs.alluxio.io/os/user/" + VERSION;
      ALLUXIO_JAVADOC_URL =
          "https://docs.alluxio.io/os/javadoc/" + VERSION;
    }
  }

  public static final String REVISION_SHORT = ProjectConstants.REVISION.length() > 8
      ? ProjectConstants.REVISION.substring(0, 8) : ProjectConstants.REVISION;
  public static final String VERSION_AND_REVISION_SHORT =
      VERSION + "-" + REVISION_SHORT;
  public static final BuildVersion UNKNOWN_VERSION_INFO = BuildVersion.newBuilder()
      .setVersion("UNKNOWN").setRevision("UNKNOWN").build();
  public static final BuildVersion CURRENT_VERSION_INFO = BuildVersion.newBuilder()
      .setVersion(RuntimeConstants.VERSION)
      .setRevision(RuntimeConstants.REVISION_SHORT).build();

  /** The relative path to the Alluxio target jar. */
  public static final String ALLUXIO_JAR = "target/alluxio-" + VERSION
      + "-jar-with-dependencies.jar";

  /** The URL of Alluxio documentation for this version on project web site. */
  public static final String ALLUXIO_DOCS_URL;

  /** The URL of Alluxio javadoc documentation. */
  public static final String ALLUXIO_JAVADOC_URL;

  /** The URL of Alluxio debugging documentation. */
  public static final String ALLUXIO_DEBUG_DOCS_URL = ALLUXIO_DOCS_URL
      + "/en/operation/Troubleshooting.html";

  /** The URL of Alluxio 1.x to 2.x upgrade documentation. */
  public static final String ALLUXIO_2X_UPGRADE_DOC_URL = ALLUXIO_DOCS_URL
      + "/en/operation/2.x-Upgrade.html";

  /** The URL of Alluxio security documentation. */
  public static final String ALLUXIO_SECURITY_DOCS_URL = ALLUXIO_DOCS_URL
      + "/en/operation/Security.html";

  private RuntimeConstants() {} // prevent instantiation
}