public final class PingResponse extends ServerResponse
The constructor of this class may change
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
LICENSE_PRE_8_3
The license type for RoboServer prior to 8.3, where the license type was not sent by RoboServer
|
static java.lang.String |
LICENSE_TYPE_NON_PRODUCTION
The value returned getLicenseType() when the RoboServer uses a Non production license
|
static java.lang.String |
LICENSE_TYPE_PRODUCTION
The value returned getLicenseType() when the RoboServer uses a production license
|
static int |
STATUS_AWAITING_ACTIVATION
The status when the server has not yet been activated
|
static int |
STATUS_RUNNING
The status when the server is running
|
static int |
STATUS_SHUTTING_DOWN
The status when the server is shutting down
|
Constructor and Description |
---|
PingResponse(java.util.Date date,
java.lang.String robosuiteVersion,
java.lang.String ipAddress,
int status,
int maxConcurrentRobots,
int maxQueueSize,
java.lang.String serverInstanceId,
java.util.Set<java.lang.String> runningRobotIds,
java.util.Set<java.lang.String> queuedExecutionIds,
java.lang.String licenseType,
long uptime,
java.lang.String commandLine,
long maxJVMMemory,
int cpuCount,
boolean memoryUsageAboveThreshold,
java.lang.String settingsId,
java.lang.Integer kcuPoints,
int portId,
boolean disAllowDocumentationRequests,
int settingsSerializationVersion,
java.lang.Integer licenseLimit)
Creates a new ping response
As this is a server response, it is subject to change, and backwards compatibility is not guaranteed
|
Modifier and Type | Method and Description |
---|---|
boolean |
disAllowDocumentationRequests() |
boolean |
equals(java.lang.Object obj)
Returns
true if this object and the specified object have the same property values, and
false otherwise. |
java.lang.String |
getCommandLine()
get the command line RoboServer was started with
|
int |
getCpuCount()
Get the number of CPUs assigned to the roboServer process
|
java.util.Set<java.lang.String> |
getExecutionIds()
Deprecated.
use getRunningExecutionIds() or getQueuedExecutionIds()
|
java.lang.String |
getIPAddress()
Returns the IP address of the RoboServer that responded to the Ping Request.
|
java.lang.Integer |
getKcuPoints() |
java.lang.Integer |
getLicenseLimit() |
java.lang.String |
getLicenseType()
The type of license used by the responding RoboServer
|
int |
getMaxConcurrentRobots()
The server max number of concurrent requests the server can handle
|
long |
getMaxJVMMemory()
get the maximum Memory configured for the JVM RS is running in
|
int |
getMaxQueueSize()
Get the maximum number of requests the server will queue
|
int |
getPortId() |
java.util.Set<java.lang.String> |
getQueuedExecutionIds()
Returns the set of execution ids for queued robots
|
java.lang.String |
getRobosuiteVersion()
Returns the RoboSuite version of the RoboServer that responded to the Ping Request.
|
java.util.Set<java.lang.String> |
getRunningExecutionIds()
Return the set of execution ids for running robots
|
java.lang.String |
getServerInstanceId()
Get the servers instance id.
|
java.lang.String |
getSettingsId() |
int |
getSettingsSerializationVersion()
Must match the version in RoboServerSettings::getSerializationVersion
This method was initially introduced to solve problem of older versions of
RoboServer not understanding new field added to later versions of RoboServerSettings class
RoboServer notifies in its PingResponse what version number it expects and
it is responsibility to MC to drop fields added after notified version.
|
int |
getStatus()
Get the status of the server
|
long |
getUptime()
The uptime of the RoboServer, in miliseconds
|
int |
hashCode()
Returns the hash code of this object based on property values.
|
boolean |
isMemoryUsageAboveThreshold() |
boolean |
isSupportsDynamicLicenseDistribution() |
java.lang.String |
toString()
Prints values of properties.
|
getDate
public static final int STATUS_RUNNING
public static final int STATUS_SHUTTING_DOWN
public static final int STATUS_AWAITING_ACTIVATION
public static final java.lang.String LICENSE_TYPE_PRODUCTION
public static final java.lang.String LICENSE_TYPE_NON_PRODUCTION
public static final java.lang.String LICENSE_PRE_8_3
public PingResponse(java.util.Date date, java.lang.String robosuiteVersion, java.lang.String ipAddress, int status, int maxConcurrentRobots, int maxQueueSize, java.lang.String serverInstanceId, java.util.Set<java.lang.String> runningRobotIds, java.util.Set<java.lang.String> queuedExecutionIds, java.lang.String licenseType, long uptime, java.lang.String commandLine, long maxJVMMemory, int cpuCount, boolean memoryUsageAboveThreshold, java.lang.String settingsId, java.lang.Integer kcuPoints, int portId, boolean disAllowDocumentationRequests, int settingsSerializationVersion, java.lang.Integer licenseLimit)
date
- the time this response was created.robosuiteVersion
- the RoboSuite version of the RoboServer that responded to the Ping Request.ipAddress
- the RoboSuite version of the RoboServer that responded to the Ping Request. May be the
empty string, if the RoboServer could not determine its own ip address.status
- 0 if running, 1 if shutdownmaxConcurrentRobots
- the maximum number the server will run concurrentlymaxQueueSize
- the maximum number of requests the server will queueserverInstanceId
- the servers instance idrunningRobotIds
- the set of execution ids of running robots on RoboServer. If null is passed an empty Set is created.queuedExecutionIds
- the set of execution ids of queued robots on RoboServer. If null is passed an empty Set is created.licenseType
- the type of licenseuptime
- uptime of RoboServer in milisecondscommandLine
- the commandline RS was started withmaxJVMMemory
- the maximum size of the JVM in bytescpuCount
- the number of CPUs assigned to the RS processmemoryUsageAboveThreshold
- if the RS current memory usage is above thresholdsettingsId
- the id of the current settings of the RS. If null is passed settingsId is set to the empty stringkcuPoints
- the KCU points currently assigned to the RS (null means unlimited)portId
- the port id of the RoboServerdisAllowDocumentationRequests
- determines if RoboServers allow documentation requests or notpublic java.lang.String getLicenseType()
LICENSE_TYPE_PRODUCTION
,
LICENSE_TYPE_NON_PRODUCTION
public java.lang.String getIPAddress()
May be the empty string, if the RoboServer could not determine its own ip address.
public java.lang.String getRobosuiteVersion()
public int getStatus()
public int getMaxConcurrentRobots()
public int getMaxQueueSize()
public java.lang.String getServerInstanceId()
public java.util.Set<java.lang.String> getExecutionIds()
public java.util.Set<java.lang.String> getRunningExecutionIds()
public java.util.Set<java.lang.String> getQueuedExecutionIds()
public long getUptime()
public java.lang.String getCommandLine()
public long getMaxJVMMemory()
public int getCpuCount()
public boolean isMemoryUsageAboveThreshold()
public boolean disAllowDocumentationRequests()
public java.lang.String getSettingsId()
public int getSettingsSerializationVersion()
public java.lang.Integer getKcuPoints()
public java.lang.Integer getLicenseLimit()
public int getPortId()
public boolean equals(java.lang.Object obj)
true
if this object and the specified object have the same property values, and
false
otherwise.equals
in class ServerResponse
obj
- the object to test for equality.true
if this object and the specified object have the same property values, and
false
otherwise.public int hashCode()
hashCode
in class ServerResponse
public java.lang.String toString()
toString
in class ServerResponse
public boolean isSupportsDynamicLicenseDistribution()
RoboSuite Java API, v11.4.7880