Package com.linecorp.armeria.client.endpoint

Class EndpointGroupRegistry

java.lang.Object

com.linecorp.armeria.client.endpoint.EndpointGroupRegistry

public final class EndpointGroupRegistry
extends Object

An in-memory registry of server groups.

Method Summary

Modifier and Type	Method	Description
static EndpointGroup	get(String groupName)	Get the EndpointGroup for the specified case-insensitive groupName.
static EndpointSelector	getNodeSelector(String groupName)	Returns the EndpointSelector for the specified case-insensitive groupName.
static boolean	register(String groupName, EndpointGroup endpointGroup, EndpointSelectionStrategy endpointSelectionStrategy)	Registers the specified EndpointGroup.
static Endpoint	selectNode(ClientRequestContext ctx, String groupName)	Selects an Endpoint from the EndpointGroup associated with the specified ClientRequestContext and case-insensitive groupName.
static boolean	unregister(String groupName)	Unregisters the EndpointGroup with the specified case-insensitive groupName.

Methods inherited from class java.lang.Object

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

Method Detail

register

public static boolean register(String groupName,
                               EndpointGroup endpointGroup,
                               EndpointSelectionStrategy endpointSelectionStrategy)

Registers the specified EndpointGroup. If there's already an EndpointGroup with the specified groupName, this method will replace it with the new one.

Parameters:

groupName - the case-insensitive name of the EndpointGroup that matches the regular expression /^[-_.0-9a-zA-Z]+$/

endpointGroup - the EndpointGroup to register

endpointSelectionStrategy - the EndpointSelectionStrategy of the registered group

Returns:

true if there was no EndpointGroup with the specified groupName. false if there was already an EndpointGroup with the specified groupName and it has been replaced with the new one.

unregister

public static boolean unregister(String groupName)

Unregisters the EndpointGroup with the specified case-insensitive groupName. Note that this is potentially a dangerous operation; make sure the groupName of the unregistered EndpointGroup is not in use by any clients.

Returns:

true if the EndpointGroup with the specified groupName has been removed. false if there's no such EndpointGroup in the registry.

getNodeSelector

@Nullable
public static EndpointSelector getNodeSelector(String groupName)

Returns the EndpointSelector for the specified case-insensitive groupName.

Returns:

the EndpointSelector, or null if groupName has not been registered yet.

get

@Nullable
public static EndpointGroup get(String groupName)

Get the EndpointGroup for the specified case-insensitive groupName.

Returns:

the EndpointSelector, or null if groupName has not been registered yet.

selectNode

public static Endpoint selectNode(ClientRequestContext ctx,
                                  String groupName)

Selects an Endpoint from the EndpointGroup associated with the specified ClientRequestContext and case-insensitive groupName.