io.nats.service

Class ServiceEndpoint

java.lang.Object

io.nats.service.ServiceEndpoint

public class ServiceEndpoint
extends java.lang.Object

The ServiceEndpoint represents the working Endpoint

• It allows the endpoint to be grouped.
• It is where you can define the handler that will respond to incoming requests
• It allows you to define it's dispatcher if desired giving granularity to threads running subscribers
• It gives you a hook to provide custom data for the EndpointStats

To create a ServiceEndpoint, use the ServiceEndpoint builder, which can be instantiated via the static method builder() or new ServiceEndpoint.Builder() to get an instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceEndpoint.Builder Build an ServiceEndpoint using a fluent builder.

Method Summary

Modifier and Type	Method and Description
static ServiceEndpoint.Builder	builder() Get an instance of a ServiceEndpoint Builder.
protected Dispatcher	getDispatcher()
protected Endpoint	getEndpoint()
protected Group	getGroup()
java.lang.String	getGroupName() Get the name of the Group
protected ServiceMessageHandler	getHandler()
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get a copy of the metadata of the Endpoint
java.lang.String	getName() Get the name of the Endpoint
java.lang.String	getQueueGroup() Get the queueGroup for the ServiceEndpoint
protected java.util.function.Supplier<JsonValue>	getStatsDataSupplier()
java.lang.String	getSubject() Get the subject of the ServiceEndpoint which takes into account the group path and the Endpoint subject

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Get the name of the Endpoint

Returns:

the endpoint name

getSubject

public java.lang.String getSubject()

Get the subject of the ServiceEndpoint which takes into account the group path and the Endpoint subject

Returns:

the endpoint subject

getQueueGroup

public java.lang.String getQueueGroup()

Get the queueGroup for the ServiceEndpoint

Returns:

the queueGroup

getGroupName

public java.lang.String getGroupName()

Get the name of the Group

Returns:

the group name or null if there is no group

getMetadata

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

Get a copy of the metadata of the Endpoint

Returns:

the copy of endpoint metadata

getGroup

protected Group getGroup()

getEndpoint

protected Endpoint getEndpoint()

getHandler

protected ServiceMessageHandler getHandler()

getDispatcher

protected Dispatcher getDispatcher()

getStatsDataSupplier

protected java.util.function.Supplier<JsonValue> getStatsDataSupplier()

builder

public static ServiceEndpoint.Builder builder()

Get an instance of a ServiceEndpoint Builder.

Returns:

the instance