com.hcl.domino.server

Interface ServerPingInfo

public interface ServerPingInfo

Contains information resulting from DominoClient.pingServer(java.lang.String, boolean, boolean).

Since:

1.0.20

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	getAvailabilityIndex() Retrieves the server's availability index, if requested in the ping.
Optional<List<String>>	getClusterMembers() Retrieves the server's cluster members, if requested in the ping.
Optional<String>	getClusterName() Retrieves the server's cluster name, if requested in the ping.

Method Detail

getAvailabilityIndex

Optional<Integer> getAvailabilityIndex()

Retrieves the server's availability index, if requested in the ping. The availability index is an integer value from 1-100.

Returns:

an Optional describing the availability index, or an empty one if this was not requested

getClusterName

Optional<String> getClusterName()

Retrieves the server's cluster name, if requested in the ping.

If cluster information is requested but the server is not a member of a cluster, then this will be an Optional describing an empty string.

Returns:

an Optional describing the server's cluster name, or an empty one if this was not requested

getClusterMembers

Optional<List<String>> getClusterMembers()

Retrieves the server's cluster members, if requested in the ping.

If cluster information is requested but the server is not a member of a cluster, then this will be an Optional describing an empty list.

Returns:

an Optional describing the server's cluster members as a List, or an empty one if this was not requested