PropertiesEndpointGroup (filter-service-metrics 1.13 1.13 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, EndpointSelector, AsyncCloseable, Listenable<List<Endpoint>>, ListenableAsyncCloseable, 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 Deprecated Methods
Modifier and Type	Method and Description
`static PropertiesEndpointGroupBuilder`	`builder(ClassLoader classLoader, String resourceName, String endpointKeyPrefix)` Returns a new `PropertiesEndpointGroupBuilder` created from the specified classpath resource.
`static PropertiesEndpointGroupBuilder`	`builder(Path path, String endpointKeyPrefix)` Returns a new `PropertiesEndpointGroupBuilder` created from the file at the specified `Path`.
`static PropertiesEndpointGroupBuilder`	`builder(Properties properties, String endpointKeyPrefix)` Returns a new `PropertiesEndpointGroupBuilder` created from the specified `Properties`.
`protected void`	`doCloseAsync(CompletableFuture<?> future)` Override this method to release the resources held by this `EndpointGroup` and complete the specified `CompletableFuture`.
`static PropertiesEndpointGroup`	`of(ClassLoader classLoader, String resourceName, String endpointKeyPrefix)` Returns a new `PropertiesEndpointGroup` created from the specified classpath resource.
`static PropertiesEndpointGroup`	`of(ClassLoader classLoader, String resourceName, String endpointKeyPrefix, int defaultPort)` Deprecated. Use `builder(ClassLoader, String, String)` and `PropertiesEndpointGroupBuilder.defaultPort(int)`.
`static PropertiesEndpointGroup`	`of(Path path, String endpointKeyPrefix)` Returns a new `PropertiesEndpointGroup` created from the file at the specified `Path`.
`static PropertiesEndpointGroup`	`of(Path path, String endpointKeyPrefix, int defaultPort)` Deprecated. Use `builder(Path, String)` and `PropertiesEndpointGroupBuilder.defaultPort(int)`.
`static PropertiesEndpointGroup`	`of(Properties properties, String endpointKeyPrefix)` Returns a new `PropertiesEndpointGroup` created from the specified `Properties`.
`static PropertiesEndpointGroup`	`of(Properties properties, String endpointKeyPrefix, int defaultPort)` Deprecated. Use `builder(Properties, String)` and `PropertiesEndpointGroupBuilder.defaultPort(int)`.

Methods inherited from class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup
addEndpoint, close, closeAsync, endpoints, isClosed, isClosing, removeEndpoint, select, selectionStrategy, setEndpoints, whenClosed, whenReady

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, initialEndpointsFuture, of, of, of, of, orElse, removeListener

- Method Detail
  - of
```
public static PropertiesEndpointGroup of(ClassLoader classLoader,
                                         String resourceName,
                                         String endpointKeyPrefix)
```
    Returns a new PropertiesEndpointGroup created from the specified classpath resource. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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
```
@Deprecated
public static PropertiesEndpointGroup of(ClassLoader classLoader,
                                                     String resourceName,
                                                     String endpointKeyPrefix,
                                                     int defaultPort)
```
    Deprecated. Use builder(ClassLoader, String, String) and PropertiesEndpointGroupBuilder.defaultPort(int).
    Returns a new PropertiesEndpointGroup created from the specified classpath resource. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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)
```
    Returns a new PropertiesEndpointGroup created from the specified Properties. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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
```
@Deprecated
public static PropertiesEndpointGroup of(Properties properties,
                                                     String endpointKeyPrefix,
                                                     int defaultPort)
```
    Deprecated. Use builder(Properties, String) and PropertiesEndpointGroupBuilder.defaultPort(int).
    Returns a new PropertiesEndpointGroup created from the specified Properties. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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)
```
    Returns a new PropertiesEndpointGroup created from the file at the specified Path. Any updates in the file will trigger a dynamic reload. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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
  - of
```
@Deprecated
public static PropertiesEndpointGroup of(Path path,
                                                     String endpointKeyPrefix,
                                                     int defaultPort)
```
    Deprecated. Use builder(Path, String) and PropertiesEndpointGroupBuilder.defaultPort(int).
    Returns a new PropertiesEndpointGroup created from the file at the specified Path. Any updates in the file will trigger a dynamic reload. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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
  - builder
```
public static PropertiesEndpointGroupBuilder builder(ClassLoader classLoader,
                                                     String resourceName,
                                                     String endpointKeyPrefix)
```
    Returns a new PropertiesEndpointGroupBuilder created from the specified classpath resource. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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
  - builder
```
public static PropertiesEndpointGroupBuilder builder(Properties properties,
                                                     String endpointKeyPrefix)
```
    Returns a new PropertiesEndpointGroupBuilder created from the specified Properties. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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
  - builder
```
public static PropertiesEndpointGroupBuilder builder(Path path,
                                                     String endpointKeyPrefix)
```
    Returns a new PropertiesEndpointGroupBuilder created from the file at the specified Path. Any updates in the file will trigger a dynamic reload. The value of each property whose name starts with endpointKeyPrefix will be parsed with Endpoint.parse(String), and then loaded into the PropertiesEndpointGroup, e.g.
```
 # endpointKeyPrefix = 'example.hosts.'
 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
  - doCloseAsync
```
protected void doCloseAsync(CompletableFuture<?> future)
```
    Description copied from class: DynamicEndpointGroup
    
    Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.
    
    Overrides:
    
    doCloseAsync 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

builder

builder

builder

doCloseAsync