Module org.glassfish.main.api.simple
Package org.glassfish.embeddable

Enum Class GlassFishVariable

java.lang.Object
java.lang.Enum<GlassFishVariable>
org.glassfish.embeddable.GlassFishVariable
All Implemented Interfaces:
Serializable, Comparable<GlassFishVariable>, Constable
public enum GlassFishVariable extends Enum<GlassFishVariable>
GlassFish variables used as environment options or system properties and their mapping.

  • Enum Constant Details

    • CONFIG_ROOT

      public static final GlassFishVariable CONFIG_ROOT
      Directory with asenv.conf, INSTALL_ROOT/config

    • DERBY_ROOT

      public static final GlassFishVariable DERBY_ROOT
      Derby database main directory, containing lib directory with jar files.

    • DOMAINS_ROOT

      public static final GlassFishVariable DOMAINS_ROOT
      Directory where we have domains

    • HOST_NAME

      public static final GlassFishVariable HOST_NAME
      Autodetected host name.

    • JAVA_HOME

      public static final GlassFishVariable JAVA_HOME
      Java home directory set by JVM automatically via java.home or via JAVA_HOME by user.

    • JAVA_ROOT

      public static final GlassFishVariable JAVA_ROOT
      Java home set by AS_JAVA, has higher priority than JAVA_HOME.

    • OSGI_PLATFORM

      public static final GlassFishVariable OSGI_PLATFORM
      OSGi implementation selector.

    • IMQ_BIN

      public static final GlassFishVariable IMQ_BIN
      JMS Message Broker bin directory

    • IMQ_LIB

      public static final GlassFishVariable IMQ_LIB
      JMS Message Broker lib directory

    • INSTALL_ROOT

      public static final GlassFishVariable INSTALL_ROOT
      Which installation root the GlassFish should run with. Usually glassfish[x]/glassfish

    • INSTANCE_ROOT

      public static final GlassFishVariable INSTANCE_ROOT
      Instance directory

    • NODES_ROOT

      public static final GlassFishVariable NODES_ROOT
      Node agents directory

    • PRODUCT_ROOT

      public static final GlassFishVariable PRODUCT_ROOT
      Install root parent, resolved from INSTANCE_ROOT.

    • KEYSTORE_FILE

      public static final GlassFishVariable KEYSTORE_FILE
      File containing the private key and server certificates. This file must be perfectly protected and must not leave the server.

    • KEYSTORE_TYPE

      public static final GlassFishVariable KEYSTORE_TYPE
      JKS/JCEKS/PKCS12/...

    • KEYSTORE_PASSWORD

      @Deprecated(since="7.1.0", forRemoval=true) public static final GlassFishVariable KEYSTORE_PASSWORD
      Deprecated, for removal: This API element is subject to removal in a future version.
      It is not safe to set passwords as system properties.
      Password for file containing the private key and server certificates.

    • TRUSTSTORE_FILE

      public static final GlassFishVariable TRUSTSTORE_FILE
      File containing server certificate chains

    • TRUSTSTORE_TYPE

      public static final GlassFishVariable TRUSTSTORE_TYPE
      JKS/JCEKS/PKCS12/...

    • TRUSTSTORE_PASSWORD

      @Deprecated(since="7.1.0", forRemoval=true) public static final GlassFishVariable TRUSTSTORE_PASSWORD
      Deprecated, for removal: This API element is subject to removal in a future version.
      It is not safe to set passwords as system properties.
      Password for the file containing server certificate chains

    • TIMEOUT_START_SERVER

      public static final GlassFishVariable TIMEOUT_START_SERVER
      Default start server timeout in seconds

    • TIMEOUT_STOP_SERVER

      public static final GlassFishVariable TIMEOUT_STOP_SERVER
      Default stop server timeout in seconds

  • Method Details

    • values

      public static GlassFishVariable[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GlassFishVariable valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getEnvName

      public String getEnvName()
      Returns:
      name used when configuring GlassFish from the operating system side or asenv.conf.

    • toExpression

      public String toExpression()
      Returns:
      ${getPropertyName()}, for example: ${com.sun.aas.installRoot}

    • getPropertyName

      public String getPropertyName()
      Returns:
      name used when configuring GlassFish using properties; this name is same as for getSystemPropertyName().

    • getSystemPropertyName

      public String getSystemPropertyName()
      Returns:
      name used when configuring GlassFish using System.getProperties().

    • getEnvToSystemPropertyMapping

      public static Map<String,String> getEnvToSystemPropertyMapping()
      The map contains pairs of getEnvName() and getSystemPropertyName(). When the getEnvName() returns null, the mapping is not included.
      Returns:
      a mapping of environment variable names to system property names.