Interface Environment

All Superinterfaces:
Manager

public interface Environment
extends Manager
An interface for server execution environment information.
  • Method Summary

    Modifier and Type Method Description
    static Environment getInstance()
    Get an instance of Environment.
    java.lang.String getServerId()
    Returns an ID that identifies the instance of the server that is currently running.
    java.lang.String getVersion()
    Gets version information of iPLAss in the execution environment.
    boolean serverInRole​(java.lang.String serverRole)
    This returns whether the currently running server has the specified role or not.
  • Method Details

    • getInstance

      static Environment getInstance()
      Get an instance of Environment.
      Returns:
    • serverInRole

      boolean serverInRole​(java.lang.String serverRole)
      This returns whether the currently running server has the specified role or not. serverRole can be specified with the "mtp.server.myserverroles" system property separated by commas. This returns true if the argument serverRole is included in the serverRole list specified in the system properties. If the system property is not specified, the return value of serverInRole() is always true.
      Parameters:
      serverRole - ServerRole to check
      Returns:
    • getServerId

      java.lang.String getServerId()
      Returns an ID that identifies the instance of the server that is currently running. serverId can be specified in the "mtp.server.myserverid" system property. If the "mtp.server.myserverid" system property is not specified, the server host name is serverId.
      Returns:
    • getVersion

      java.lang.String getVersion()
      Gets version information of iPLAss in the execution environment.
      Returns: