Module jpro.webapi
Package com.jpro.webapi

Interface ServerInfo

@Experimental public interface ServerInfo
Holds information for the current running JPro server.

  • Method Details

    • getStartTime

      long getStartTime()
      Returns the start time of the server in milliseconds.
      Returns:
      a long value representing the start time.

    • getRunningTime

      Duration getRunningTime()
      Returns the running time of the server.
      Returns:
      a Duration object representing the running time.

    • getInstancesCreatedCount

      int getInstancesCreatedCount()
      Returns the number of instances created.
      Returns:
      an integer value representing the number of instances created.

    • getInstancesActiveCount

      int getInstancesActiveCount()
      Returns the number of instances active.
      Returns:
      an integer value representing the number of instances active.

    • getInstancesAfkCount

      int getInstancesAfkCount()
      Returns the number of instances not active or afk (away from keyboard).
      Returns:
      an integer value representing the number of instances not active.

    • getViewsCreatedCount

      int getViewsCreatedCount()
      Returns the number of views created.
      Returns:
      an integer value representing the number of views created.

    • getViewsActiveCount

      int getViewsActiveCount()
      Returns the number of views active.
      Returns:
      an integer value representing the number of views active.

    • getViewsAfkCount

      int getViewsAfkCount()
      Returns the number of views not active or afk (away from keyboard).
      Returns:
      an integer value representing the number of views not active or afk.

    • getActiveWindowsCount

      int getActiveWindowsCount()
      Returns the number of active windows opened.
      Returns:
      an integer value representing the number of active windows opened.

    • getFramerate

      int getFramerate()
      Returns the current framerate.
      Returns:
      an integer value representing the current framerate.

    • getMaxMemory

      long getMaxMemory()
      Returns the max memory available for the server.
      Returns:
      a long value representing the max memory available.

    • getUsedHeapMemory

      long getUsedHeapMemory()
      Returns the heap memory used by the server.
      Returns:
      a long value representing the total memory available.

    • getUsedHeapMemoryPercent

      double getUsedHeapMemoryPercent()
      Returns the heap memory used by the server in percentage.
      Returns:
      a double value representing the heap memory used in percentage.

    • getUsedNonHeapMemory

      long getUsedNonHeapMemory()
      Returns the non heap memory used by the server.
      Returns:
      a long value representing the non heap memory used.

    • getCommittedNonHeapMemory

      long getCommittedNonHeapMemory()
      Returns the non heap memory commited by the server.
      Returns:
      a double value representing the non heap memory commited.

    • getJavaFXCpuUsage

      double getJavaFXCpuUsage()
      Returns the overall JavaFX CPU usage by the server.
      Returns:
      a double value representing the overall JavaFX CPU usage.

    • getJavaVersion

      String getJavaVersion()
      Returns the current Java version the server is running on.
      Returns:
      a string value representing the current Java version.

    • getJavaFXVersion

      String getJavaFXVersion()
      Returns the current JavaFX version the server is running on.
      Returns:
      a string value representing the current JavaFX version.

    • getJProVersion

      String getJProVersion()
      Returns the current version of the JPro server.
      Returns:
      a string value representing the current version of the JPro server.

    • getJProGitCommit

      String getJProGitCommit()
      Returns the latest Git commit hash for this JPro server.
      Returns:
      a string value representing the latest Git commit hash for this JPro server.

    • getJProBuildTime

      long getJProBuildTime()
      Returns the build time of this JPro server.
      Returns:
      a long value representing the build time of this JPro server.

    • getJProMode

      String getJProMode()
      Returns the current mode the server is running on:
      • dev = development mode
      • prod = production mode
      Returns:
      a string value representing the current JPro mode.

    • getJProDeployment

      String getJProDeployment()
      Returns deployment method for this JPro server, either via Gradle or Maven.
      Returns:
      a string value representing the deployment method for this JPro server.

    • getFreeSystemMemory

      long getFreeSystemMemory()
      Returns the free memory of the system the server is running on.
      Returns:

    • getTotalSystemMemory

      long getTotalSystemMemory()
      Returns the total memory of the system the server is running on.
      Returns:
      a long value representing the total memory of the system.

    • getCpuSystemLoad

      double getCpuSystemLoad()
      Returns the CPU usage of the system the server is running on.
      Returns:
      a double value representing the CPU usage of the system.

    • getJvmSystemLoad

      double getJvmSystemLoad()
      Returns the JVM CPU usage of the system the server is running on.
      Returns:
      a double value representing the JVM CPU usage of the system.

    • getFreeDiskSpace

      long getFreeDiskSpace()
      Returns the free disk space of the system the server is running on.
      Returns:
      a long value representing the free disk space of the system.

    • getTotalDiskSpace

      long getTotalDiskSpace()
      Returns the total disk space of the system the server is running on.
      Returns:
      a long value representing the total disk space of the system.

    • getDefaultJavaEncoding

      String getDefaultJavaEncoding()
      Returns the default file encoding of the system the server is running on.
      Returns:
      a string value representing the default file encoding of the system.

    • getDefaultJavaLocale

      Locale getDefaultJavaLocale()
      Returns the default locale of the system the server is running on.
      Returns:
      a string value representing the default locale of the system.

    • getDefaultJavaTimeZone

      TimeZone getDefaultJavaTimeZone()
      Returns the default timezone of the system the server is running on.
      Returns:
      a string value representing the default timezone of the system.

    • getOpenInstances

      List<String> getOpenInstances()
      Returns the default country of the system the server is running on.
      Returns:
      a string value representing the default country of the system.

    • getStats

      Map<String,Object> getStats()
      Returns stats information provided as a map.
      Returns:
      a map containing status information.