io.nats.service

Class Discovery

java.lang.Object

io.nats.service.Discovery

public class Discovery
extends java.lang.Object

Discovery is a utility class to help discover services by executing Ping, Info and Stats requests You are required to provide a connection. Optionally you can set 'maxTimeMillis' and 'maxResults'. When making a discovery request, the discovery will wait until the first one of those thresholds is reached before returning the results.

'maxTimeMillis' defaults to 5000L

'maxResults' defaults tp 10

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DISCOVERY_MAX_RESULTS
static long	DEFAULT_DISCOVERY_MAX_TIME_MILLIS

Constructor Summary

Constructors

Constructor and Description
Discovery(Connection conn) Construct a Discovery instance with a connection and default maxTimeMillis / maxResults
Discovery(Connection conn, long maxTimeMillis, int maxResults) Construct a Discovery instance

Method Summary

Modifier and Type	Method and Description
java.util.List<InfoResponse>	info() Make an info request to all services running on the server.
java.util.List<InfoResponse>	info(java.lang.String serviceName) Make an info request only to services having the matching service name
InfoResponse	info(java.lang.String serviceName, java.lang.String serviceId) Make an info request to a specific instance of a service having matching service name and id
java.util.List<PingResponse>	ping() Make a ping request to all services running on the server.
java.util.List<PingResponse>	ping(java.lang.String serviceName) Make a ping request only to services having the matching service name
PingResponse	ping(java.lang.String serviceName, java.lang.String serviceId) Make a ping request to a specific instance of a service having matching service name and id
void	setInboxSupplier(java.util.function.Supplier<java.lang.String> inboxSupplier) Override the normal inbox with a custom inbox to support you security model
java.util.List<StatsResponse>	stats() Make a stats request to all services running on the server.
java.util.List<StatsResponse>	stats(java.lang.String serviceName) Make a stats request only to services having the matching service name
StatsResponse	stats(java.lang.String serviceName, java.lang.String serviceId) Make a stats request to a specific instance of a service having matching service name and id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_DISCOVERY_MAX_TIME_MILLIS

public static final long DEFAULT_DISCOVERY_MAX_TIME_MILLIS

See Also:

Constant Field Values

DEFAULT_DISCOVERY_MAX_RESULTS

public static final int DEFAULT_DISCOVERY_MAX_RESULTS

See Also:

Constant Field Values

Constructor Detail

Discovery

public Discovery(Connection conn)

Construct a Discovery instance with a connection and default maxTimeMillis / maxResults

Parameters:

conn - the NATS Connection

Discovery

public Discovery(Connection conn,
                 long maxTimeMillis,
                 int maxResults)

Construct a Discovery instance

Parameters:

conn - the NATS Connection

maxTimeMillis - the maximum time to wait for discovery requests to complete or any number less than 1 to use the default

maxResults - the maximum number of results to wait for or any number less than 1 to use the default

Method Detail

setInboxSupplier

public void setInboxSupplier(java.util.function.Supplier<java.lang.String> inboxSupplier)

Override the normal inbox with a custom inbox to support you security model

Parameters:

inboxSupplier - the supplier

ping

public java.util.List<PingResponse> ping()

Make a ping request to all services running on the server.

Returns:

the list of PingResponse

ping

public java.util.List<PingResponse> ping(java.lang.String serviceName)

Make a ping request only to services having the matching service name

Parameters:

serviceName - the service name

Returns:

the list of PingResponse

ping

public PingResponse ping(java.lang.String serviceName,
                         java.lang.String serviceId)

Make a ping request to a specific instance of a service having matching service name and id

Parameters:

serviceName - the service name

serviceId - the specific service id

Returns:

the list of PingResponse

info

public java.util.List<InfoResponse> info()

Make an info request to all services running on the server.

Returns:

the list of InfoResponse

info

public java.util.List<InfoResponse> info(java.lang.String serviceName)

Make an info request only to services having the matching service name

Parameters:

serviceName - the service name

Returns:

the list of InfoResponse

info

public InfoResponse info(java.lang.String serviceName,
                         java.lang.String serviceId)

Make an info request to a specific instance of a service having matching service name and id

Parameters:

serviceName - the service name

serviceId - the specific service id

Returns:

the list of InfoResponse

stats

public java.util.List<StatsResponse> stats()

Make a stats request to all services running on the server.

Returns:

the list of StatsResponse

stats

public java.util.List<StatsResponse> stats(java.lang.String serviceName)

Make a stats request only to services having the matching service name

Parameters:

serviceName - the service name

Returns:

the list of StatsResponse

stats

public StatsResponse stats(java.lang.String serviceName,
                           java.lang.String serviceId)

Make a stats request to a specific instance of a service having matching service name and id

Parameters:

serviceName - the service name

serviceId - the specific service id

Returns:

the list of StatsResponse