Package com.linecorp.armeria.client.endpoint

Class PropertiesEndpointGroup

java.lang.Object

com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup

All Implemented Interfaces:

EndpointGroup, Listenable<List<Endpoint>>, SafeCloseable, AutoCloseable

public final class PropertiesEndpointGroup
extends Object
implements EndpointGroup

A Properties backed EndpointGroup. The list of Endpoints are loaded from the Properties.

Method Summary

Modifier and Type	Method	Description
List<Endpoint>	endpoints()	Return the endpoints held by this EndpointGroup.
static PropertiesEndpointGroup	of(ClassLoader classLoader, String resourceName, String endpointKeyPrefix)	Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the resourceName resource file.
static PropertiesEndpointGroup	of(ClassLoader classLoader, String resourceName, String endpointKeyPrefix, int defaultPort)	Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the resourceName resource file.
static PropertiesEndpointGroup	of(Properties properties, String endpointKeyPrefix)	Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the Properties.
static PropertiesEndpointGroup	of(Properties properties, String endpointKeyPrefix, int defaultPort)	Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the Properties.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.endpoint.EndpointGroup

addListener, close, orElse, removeListener

Method Detail

of

public static PropertiesEndpointGroup of(ClassLoader classLoader,
                                         String resourceName,
                                         String endpointKeyPrefix)

Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the resourceName resource file. The resource file must contain at least one property whose name starts with endpointKeyPrefix:

 example.hosts.0=example1.com:36462
 example.hosts.1=example2.com:36462
 example.hosts.2=example3.com:36462
 

Parameters:

resourceName - the name of the resource where the list of Endpoints is loaded from

endpointKeyPrefix - the property name prefix

Throws:

IllegalArgumentException - if failed to load any hosts from the specified resource file

of

public static PropertiesEndpointGroup of(ClassLoader classLoader,
                                         String resourceName,
                                         String endpointKeyPrefix,
                                         int defaultPort)

Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the resourceName resource file. The resource file must contain at least one property whose name starts with endpointKeyPrefix:

 example.hosts.0=example1.com:36462
 example.hosts.1=example2.com:36462
 example.hosts.2=example3.com:36462
 

Parameters:

resourceName - the name of the resource where the list of Endpoints is loaded from

endpointKeyPrefix - the property name prefix

defaultPort - the default port number to use

Throws:

IllegalArgumentException - if failed to load any hosts from the specified resource file

of

public static PropertiesEndpointGroup of(Properties properties,
                                         String endpointKeyPrefix)

Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the Properties. The Properties must contain at least one property whose name starts with endpointKeyPrefix:

 example.hosts.0=example1.com:36462
 example.hosts.1=example2.com:36462
 example.hosts.2=example3.com:36462
 

Parameters:

properties - the Properties where the list of Endpoints is loaded from

endpointKeyPrefix - the property name prefix

Throws:

IllegalArgumentException - if failed to load any hosts from the specified Properties

of

public static PropertiesEndpointGroup of(Properties properties,
                                         String endpointKeyPrefix,
                                         int defaultPort)

Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the Properties. The Properties must contain at least one property whose name starts with endpointKeyPrefix:

 example.hosts.0=example1.com:36462
 example.hosts.1=example2.com:36462
 example.hosts.2=example3.com:36462
 

Parameters:

properties - the Properties where the list of Endpoints is loaded from

endpointKeyPrefix - the property name prefix

defaultPort - the default port number to use

Throws:

IllegalArgumentException - if failed to load any hosts from the specified Properties

endpoints

public List<Endpoint> endpoints()

Description copied from interface: EndpointGroup

Return the endpoints held by this EndpointGroup.

Specified by:

endpoints in interface EndpointGroup