Service (NATS.IO Java API)

java.lang.Object
- io.nats.service.Service

```
public class Service
extends java.lang.Object
```
The Services Framework introduces a higher-level API for implementing services with NATS. Services automatically contain Ping, Info and Stats responders. Services have one or more service endpoints. ServiceEndpoint When multiple instances of a service endpoints are active they work in a queue, meaning only one listener responds to any given request.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_SERVICE_PREFIX`
`static java.lang.String`	`SRV_INFO`
`static java.lang.String`	`SRV_PING`
`static java.lang.String`	`SRV_STATS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ServiceBuilder`	`builder()` Get an instance of a ServiceBuilder.
`java.lang.String`	`getDescription()` Get the description of the service
`java.time.Duration`	`getDrainTimeout()` Get the drain timeout setting
`EndpointStats`	`getEndpointStats(java.lang.String endpointName)` Get the up-to-date `EndpointStats` for a specific endpoint
`java.lang.String`	`getId()` Get the id of the service
`InfoResponse`	`getInfoResponse()` Get the pre-constructed info response.
`java.lang.String`	`getName()` Get the name of the service
`PingResponse`	`getPingResponse()` Get the pre-constructed ping response.
`StatsResponse`	`getStatsResponse()` Get the up-to-date stats response which contains a list of all `EndpointStats`
`java.lang.String`	`getVersion()` Get the version of the service
`void`	`reset()` Reset the statistics for the endpoints
`java.util.concurrent.CompletableFuture<java.lang.Boolean>`	`startService()` Start the service
`void`	`stop()` Stop the service by draining.
`void`	`stop(boolean drain)` Stop the service, optionally draining.
`void`	`stop(boolean drain, java.lang.Throwable t)` Stop the service, optionally draining and optionally with an error cause
`void`	`stop(java.lang.Throwable t)` Stop the service by draining.
`java.lang.String`	`toString()`

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

- Field Detail
  - SRV_PING
```
public static final java.lang.String SRV_PING
```
    See Also:
    
    Constant Field Values
  - SRV_INFO
```
public static final java.lang.String SRV_INFO
```
    See Also:
    
    Constant Field Values
  - SRV_STATS
```
public static final java.lang.String SRV_STATS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SERVICE_PREFIX
```
public static final java.lang.String DEFAULT_SERVICE_PREFIX
```
    See Also:
    
    Constant Field Values
- Method Detail
  - startService
```
public java.util.concurrent.CompletableFuture<java.lang.Boolean> startService()
```
    Start the service
    
    Returns:
    
    a future that can be held to see if another thread called stop
  - builder
```
public static ServiceBuilder builder()
```
    Get an instance of a ServiceBuilder.
    
    Returns:
    
    the instance
  - stop
```
public void stop()
```
    Stop the service by draining.
  - stop
```
public void stop(java.lang.Throwable t)
```
    Stop the service by draining. Mark the future that was received from the start method that the service completed exceptionally.
    
    Parameters:
    
    t - the error cause
  - stop
```
public void stop(boolean drain)
```
    Stop the service, optionally draining.
    
    Parameters:
    
    drain - the flag indicating to drain or not
  - stop
```
public void stop(boolean drain,
                 java.lang.Throwable t)
```
    Stop the service, optionally draining and optionally with an error cause
    
    Parameters:
    
    drain - the flag indicating to drain or not
    
    t - the optional error cause. If supplied, mark the future that was received from the start method that the service completed exceptionally
  - reset
```
public void reset()
```
    Reset the statistics for the endpoints
  - getId
```
public java.lang.String getId()
```
    Get the id of the service
    
    Returns:
    
    the id
  - getName
```
public java.lang.String getName()
```
    Get the name of the service
    
    Returns:
    
    the name
  - getVersion
```
public java.lang.String getVersion()
```
    Get the version of the service
    
    Returns:
    
    the version
  - getDescription
```
public java.lang.String getDescription()
```
    Get the description of the service
    
    Returns:
    
    the description
  - getDrainTimeout
```
public java.time.Duration getDrainTimeout()
```
    Get the drain timeout setting
    
    Returns:
    
    the drain timeout setting
  - getPingResponse
```
public PingResponse getPingResponse()
```
    Get the pre-constructed ping response.
    
    Returns:
    
    the ping response
  - getInfoResponse
```
public InfoResponse getInfoResponse()
```
    Get the pre-constructed info response.
    
    Returns:
    
    the info response
  - getStatsResponse
```
public StatsResponse getStatsResponse()
```
    Get the up-to-date stats response which contains a list of all EndpointStats
    
    Returns:
    
    the stats response
  - getEndpointStats
```
public EndpointStats getEndpointStats(java.lang.String endpointName)
```
    Get the up-to-date EndpointStats for a specific endpoint
    
    Parameters:
    
    endpointName - the endpoint name
    
    Returns:
    
    the EndpointStats or null if the name is not found.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Service

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SRV_PING

SRV_INFO

SRV_STATS

DEFAULT_SERVICE_PREFIX

Method Detail

startService

builder

stop

stop

stop

stop

reset

getId

getName

getVersion

getDescription

getDrainTimeout

getPingResponse

getInfoResponse

getStatsResponse

getEndpointStats

toString