io.nats.service

Class ServiceBuilder

java.lang.Object

io.nats.service.ServiceBuilder

public class ServiceBuilder
extends java.lang.Object

Build a Service using a fluent builder. Use the Service static method builder() or new ServiceBuilder() to get an instance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Duration	DEFAULT_DRAIN_TIMEOUT
static long	DEFAULT_DRAIN_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
ServiceBuilder()

Method Summary

Modifier and Type	Method and Description
ServiceBuilder	addServiceEndpoint(ServiceEndpoint serviceEndpoint) Add a service endpoint into the service.
Service	build() Build the Service instance.
ServiceBuilder	connection(Connection conn) The connection the service runs on
ServiceBuilder	description(java.lang.String description) The simple description of the service
ServiceBuilder	drainTimeout(java.time.Duration drainTimeout) The timeout when stopping a service.
ServiceBuilder	drainTimeout(long drainTimeoutMillis) The timeout when stopping a service.
ServiceBuilder	infoDispatcher(Dispatcher infoDispatcher) Optional dispatcher for the info service
ServiceBuilder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Any meta information about this service
ServiceBuilder	name(java.lang.String name) The simple name of the service
ServiceBuilder	pingDispatcher(Dispatcher pingDispatcher) Optional dispatcher for the ping service
ServiceBuilder	schemaDispatcher(Dispatcher schemaDispatcher) Deprecated. No longer used, see ServiceEndpoint.Builder.endpointMetadata(Map) instead
ServiceBuilder	statsDispatcher(Dispatcher statsDispatcher) Optional dispatcher for the stats service
ServiceBuilder	version(java.lang.String version) The simple version of the service.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DRAIN_TIMEOUT_MILLIS

public static final long DEFAULT_DRAIN_TIMEOUT_MILLIS

See Also:

Constant Field Values

DEFAULT_DRAIN_TIMEOUT

public static final java.time.Duration DEFAULT_DRAIN_TIMEOUT

Constructor Detail

ServiceBuilder

public ServiceBuilder()

Method Detail

connection

public ServiceBuilder connection(Connection conn)

The connection the service runs on

Parameters:

conn - connection

Returns:

the ServiceBuilder

name

public ServiceBuilder name(java.lang.String name)

The simple name of the service

Parameters:

name - the name

Returns:

the ServiceBuilder

description

public ServiceBuilder description(java.lang.String description)

The simple description of the service

Parameters:

description - the description

Returns:

the ServiceBuilder

version

public ServiceBuilder version(java.lang.String version)

The simple version of the service.

Parameters:

version - the version

Returns:

the ServiceBuilder

metadata

public ServiceBuilder metadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Any meta information about this service

Parameters:

metadata - the meta

Returns:

the ServiceBuilder

addServiceEndpoint

public ServiceBuilder addServiceEndpoint(ServiceEndpoint serviceEndpoint)

Add a service endpoint into the service. There can only be one instance of a service endpoint by name

Parameters:

serviceEndpoint - the service endpoint

Returns:

the ServiceBuilder

drainTimeout

public ServiceBuilder drainTimeout(java.time.Duration drainTimeout)

The timeout when stopping a service. Defaults to 5000L milliseconds

Parameters:

drainTimeout - the drain timeout

Returns:

the ServiceBuilder

drainTimeout

public ServiceBuilder drainTimeout(long drainTimeoutMillis)

The timeout when stopping a service. Defaults to 5000L milliseconds

Parameters:

drainTimeoutMillis - the drain timeout in milliseconds

Returns:

the ServiceBuilder

pingDispatcher

public ServiceBuilder pingDispatcher(Dispatcher pingDispatcher)

Optional dispatcher for the ping service

Parameters:

pingDispatcher - the dispatcher

Returns:

the ServiceBuilder

infoDispatcher

public ServiceBuilder infoDispatcher(Dispatcher infoDispatcher)

Optional dispatcher for the info service

Parameters:

infoDispatcher - the dispatcher

Returns:

the ServiceBuilder

schemaDispatcher

@Deprecated
public ServiceBuilder schemaDispatcher(Dispatcher schemaDispatcher)

Deprecated. No longer used, see ServiceEndpoint.Builder.endpointMetadata(Map) instead

A NOOP method to maintain compatibility with the old schema dispatcher, superseded by endpointMetadata

Parameters:

schemaDispatcher - the dispatcher

Returns:

the ServiceBuilder

statsDispatcher

public ServiceBuilder statsDispatcher(Dispatcher statsDispatcher)

Optional dispatcher for the stats service

Parameters:

statsDispatcher - the dispatcher

Returns:

the ServiceBuilder

build

public Service build()

Build the Service instance.

Returns:

the Service instance