ServerInfo (NATS.IO Java API)

java.lang.Object
- io.nats.client.api.ServerInfo

public class ServerInfo
extends java.lang.Object

Class holding information about a server

Field Summary

Fields
Modifier and Type Field and Description

static ServerInfo EMPTY_INFO
Constant representing an empty info.

Fields
Modifier and Type	Field and Description
`static ServerInfo`	`EMPTY_INFO` Constant representing an empty info.

Constructor Summary

Constructors
Constructor and Description

ServerInfo(java.lang.String json)
Construct a ServerInfo instance from json

Constructors
Constructor and Description
`ServerInfo(java.lang.String json)` Construct a ServerInfo instance from json

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getClientId()` the client id as determined by the server
`@NonNull java.lang.String`	`getClientIp()` the client ip address as determined by the server
`@Nullable java.lang.String`	`getCluster()` the cluster name the server is in
`@NonNull java.util.List<java.lang.String>`	`getConnectURLs()` the connectable urls in the cluster
`@NonNull java.lang.String`	`getGoVersion()` the go version the server is built with
`@NonNull java.lang.String`	`getHost()` the server host
`long`	`getMaxPayload()` the server configured max payload
`byte[]`	`getNonce()` the nonce to use in authentication
`int`	`getPort()` the server port
`int`	`getProtocolVersion()` the server protocol version
`@NonNull java.lang.String`	`getServerId()` the server id
`@NonNull java.lang.String`	`getServerName()` the server name
`@NonNull java.lang.String`	`getVersion()` the server version
`boolean`	`isAuthRequired()` true if authorization is required by the server
`boolean`	`isHeadersSupported()` true if headers are supported by the server
`boolean`	`isJetStreamAvailable()` true if the server supports JetStream
`boolean`	`isLameDuckMode()` true if server is in lame duck mode
`boolean`	`isNewerVersionThan(java.lang.String vTarget)` function to determine is the server version is newer than the input
`boolean`	`isOlderThanVersion(java.lang.String vTarget)` function to determine is the server version is older than the input
`boolean`	`isSameOrNewerThanVersion(java.lang.String vTarget)` function to determine is the server version is same or newer than the input
`boolean`	`isSameOrOlderThanVersion(java.lang.String vTarget)` function to determine is the server version is the same or older than the input
`boolean`	`isSameVersion(java.lang.String vTarget)` function to determine is the server version is same as the input
`boolean`	`isTLSAvailable()` true if TLS is available on the server
`boolean`	`isTLSRequired()` true if TLS is required by the server
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_INFO
```
public static final ServerInfo EMPTY_INFO
```
    Constant representing an empty info. Used to ensure getting a ServerInfo from a connection is never null, it can be based on timing.
- Constructor Detail
  - ServerInfo
```
public ServerInfo(java.lang.String json)
```
    Construct a ServerInfo instance from json
    
    Parameters:
    
    json - the json
- Method Detail
  - isLameDuckMode
```
public boolean isLameDuckMode()
```
    true if server is in lame duck mode
    
    Returns:
    
    true if server is in lame duck mode
  - getServerId
```
public @NonNull java.lang.String getServerId()
```
    the server id
    
    Returns:
    
    the server id
  - getServerName
```
public @NonNull java.lang.String getServerName()
```
    the server name
    
    Returns:
    
    the server name
  - getVersion
```
public @NonNull java.lang.String getVersion()
```
    the server version
    
    Returns:
    
    the server version
  - getGoVersion
```
public @NonNull java.lang.String getGoVersion()
```
    the go version the server is built with
    
    Returns:
    
    the go version the server is built with
  - getHost
```
public @NonNull java.lang.String getHost()
```
    the server host
    
    Returns:
    
    the server host
  - getPort
```
public int getPort()
```
    the server port
    
    Returns:
    
    the server port
  - getProtocolVersion
```
public int getProtocolVersion()
```
    the server protocol version
    
    Returns:
    
    the server protocol version
  - isHeadersSupported
```
public boolean isHeadersSupported()
```
    true if headers are supported by the server
    
    Returns:
    
    true if headers are supported by the server
  - isAuthRequired
```
public boolean isAuthRequired()
```
    true if authorization is required by the server
    
    Returns:
    
    true if authorization is required by the server
  - isTLSRequired
```
public boolean isTLSRequired()
```
    true if TLS is required by the server
    
    Returns:
    
    true if TLS is required by the server
  - isTLSAvailable
```
public boolean isTLSAvailable()
```
    true if TLS is available on the server
    
    Returns:
    
    true if TLS is available on the server
  - getMaxPayload
```
public long getMaxPayload()
```
    the server configured max payload
    
    Returns:
    
    the max payload
  - getConnectURLs
```
public @NonNull java.util.List<java.lang.String> getConnectURLs()
```
    the connectable urls in the cluster
    
    Returns:
    
    the connectable urls
  - getNonce
```
public byte[] getNonce()
```
    the nonce to use in authentication
    
    Returns:
    
    the nonce
  - isJetStreamAvailable
```
public boolean isJetStreamAvailable()
```
    true if the server supports JetStream
    
    Returns:
    
    true if the server supports JetStream
  - getClientId
```
public int getClientId()
```
    the client id as determined by the server
    
    Returns:
    
    the client id
  - getClientIp
```
public @NonNull java.lang.String getClientIp()
```
    the client ip address as determined by the server
    
    Returns:
    
    the client ip
  - getCluster
```
public @Nullable java.lang.String getCluster()
```
    the cluster name the server is in
    
    Returns:
    
    the cluster name
  - isNewerVersionThan
```
public boolean isNewerVersionThan(java.lang.String vTarget)
```
    function to determine is the server version is newer than the input
    
    Parameters:
    
    vTarget - the target version to compare
    
    Returns:
    
    true if the server version is newer than the input
  - isSameVersion
```
public boolean isSameVersion(java.lang.String vTarget)
```
    function to determine is the server version is same as the input
    
    Parameters:
    
    vTarget - the target version to compare
    
    Returns:
    
    true if the server version is same as the input
  - isOlderThanVersion
```
public boolean isOlderThanVersion(java.lang.String vTarget)
```
    function to determine is the server version is older than the input
    
    Parameters:
    
    vTarget - the target version to compare
    
    Returns:
    
    true if the server version is older than the input
  - isSameOrOlderThanVersion
```
public boolean isSameOrOlderThanVersion(java.lang.String vTarget)
```
    function to determine is the server version is the same or older than the input
    
    Parameters:
    
    vTarget - the target version to compare
    
    Returns:
    
    true if the server version is the same or older than the input
  - isSameOrNewerThanVersion
```
public boolean isSameOrNewerThanVersion(java.lang.String vTarget)
```
    function to determine is the server version is same or newer than the input
    
    Parameters:
    
    vTarget - the target version to compare
    
    Returns:
    
    true if the server version is same or newer than the input
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ServerInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_INFO

Constructor Detail

ServerInfo

Method Detail

isLameDuckMode

getServerId

getServerName

getVersion

getGoVersion

getHost

getPort

getProtocolVersion

isHeadersSupported

isAuthRequired

isTLSRequired

isTLSAvailable

getMaxPayload

getConnectURLs

getNonce

isJetStreamAvailable

getClientId

getClientIp

getCluster

isNewerVersionThan

isSameVersion

isOlderThanVersion

isSameOrOlderThanVersion

isSameOrNewerThanVersion

toString