PropertiesEndpointGroup (filter-service-metrics 1.12 1.12 API)

java.lang.Object
- com.linecorp.armeria.common.util.AbstractListenable<List<Endpoint>>
- - com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
  - - com.linecorp.armeria.client.endpoint.PropertiesEndpointGroup

All Implemented Interfaces:

EndpointGroup, Listenable<List<Endpoint>>, SafeCloseable, AutoCloseable
```
public final class PropertiesEndpointGroup
extends DynamicEndpointGroup
```
A Properties backed EndpointGroup. The list of Endpoints are loaded from the Properties.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`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(Path path, String endpointKeyPrefix)` Creates a new `EndpointGroup` instance that loads the host names (or IP address) and the port numbers of the `Endpoint` from the `path` of a resource file.
`static PropertiesEndpointGroup`	`of(Path path, 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 `path` of a 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 com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
addEndpoint, endpoints, initialEndpointsFuture, removeEndpoint, setEndpoints

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable
addListener, notifyListeners, removeListener

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, awaitInitialEndpoints, awaitInitialEndpoints, empty, of, of, 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 loads properties 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
  - 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 loads properties 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
  - 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 is filtered to properties 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
  - 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 is filtered to properties 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
  - of
```
public static PropertiesEndpointGroup of(Path path,
                                         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 path of a resource file. The resource file loads properties whose name starts with endpointKeyPrefix. The path is watched for further updates.
```
 example.hosts.0=example1.com:36462
 example.hosts.1=example2.com:36462
 example.hosts.2=example3.com:36462
 
```
    Parameters:
    
    path - the path of the file where list of Endpoints is loaded from
    
    endpointKeyPrefix - the property name prefix
    
    defaultPort - the default port number to use
  - of
```
public static PropertiesEndpointGroup of(Path path,
                                         String endpointKeyPrefix)
```
    Creates a new EndpointGroup instance that loads the host names (or IP address) and the port numbers of the Endpoint from the path of a resource file. The resource file loads properties whose name starts with endpointKeyPrefix. The path is watched for further updates.
```
 example.hosts.0=example1.com:36462
 example.hosts.1=example2.com:36462
 example.hosts.2=example3.com:36462
 
```
    Parameters:
    
    path - the path of the file where list of Endpoints is loaded from
    
    endpointKeyPrefix - the property name prefix
  - close
```
public void close()
```
    Specified by:
    
    close in interface EndpointGroup
    
    Specified by:
    
    close in interface SafeCloseable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class DynamicEndpointGroup

Class PropertiesEndpointGroup

Method Summary

Methods inherited from class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable

Methods inherited from class java.lang.Object

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

Method Detail

of

of

of

of

of

of

close