org.eclipse.milo.opcua.stack.client

Class DiscoveryClient

java.lang.Object

org.eclipse.milo.opcua.stack.client.DiscoveryClient

public class DiscoveryClient
extends Object

Constructor Summary

Constructors

Constructor and Description
DiscoveryClient(UaStackClient stackClient)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<DiscoveryClient>	connect()
CompletableFuture<DiscoveryClient>	disconnect()
static CompletableFuture<List<ApplicationDescription>>	findServers(String endpointUrl) Query the FindServers service at the endpointUrl.
static CompletableFuture<List<ApplicationDescription>>	findServers(String endpointUrl, Consumer<UaStackClientConfigBuilder> customizer) Query the FindServers service at the endpointUrl.
CompletableFuture<FindServersResponse>	findServers(String endpointUrl, String[] localeIds, String[] serverUris) Query the FindServers service at the endpointUrl.
static CompletableFuture<List<EndpointDescription>>	getEndpoints(String endpointUrl) Query the GetEndpoints service at endpointUrl.
static CompletableFuture<List<EndpointDescription>>	getEndpoints(String endpointUrl, Consumer<UaStackClientConfigBuilder> customizer) Query the GetEndpoints service at endpointUrl.
CompletableFuture<GetEndpointsResponse>	getEndpoints(String endpointUrl, String[] localeIds, String[] profileUris) Query the GetEndpoints service at endpointUrl.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscoveryClient

public DiscoveryClient(UaStackClient stackClient)

Method Detail

connect

public CompletableFuture<DiscoveryClient> connect()

disconnect

public CompletableFuture<DiscoveryClient> disconnect()

findServers

public CompletableFuture<FindServersResponse> findServers(String endpointUrl,
                                                          String[] localeIds,
                                                          String[] serverUris)

Query the FindServers service at the endpointUrl.

The endpoint URL(s) for each server ApplicationDescription in the response can then be used in a getEndpoints(String) call to discover the endpoints for that server.

Parameters:

endpointUrl - the endpoint URL to find servers at.

localeIds - list of locales to use. The server should return the applicationName in the ApplicationDescription using one of locales specified. If the server supports more than one of the requested locales then the server shall use the locale that appears first in this list. If the server does not support any of the requested locales it chooses an appropriate default locale. The server chooses an appropriate default locale if this list is empty.

serverUris - list of servers to return. All known servers are returned if the list is empty.

Returns:

the FindServersResponses returned by the FindServers service.

getEndpoints

public CompletableFuture<GetEndpointsResponse> getEndpoints(String endpointUrl,
                                                            String[] localeIds,
                                                            String[] profileUris)

Query the GetEndpoints service at endpointUrl.

Parameters:

endpointUrl - the endpoint URL to get endpoints from.

localeIds - list of locales to use. Specifies the locale to use when returning human-readable strings.

profileUris - list of Transport Profile that the returned Endpoints shall support. All Endpoints are returned if the list is empty.

Returns:

the GetEndpointsResponse returned by the GetEndpoints service.

findServers

public static CompletableFuture<List<ApplicationDescription>> findServers(String endpointUrl)

Query the FindServers service at the endpointUrl.

The discovery URL(s) for each server ApplicationDescription in the response can then be used in a getEndpoints(String) call to discover the endpoints for that server.

Parameters:

endpointUrl - the endpoint URL to find servers at.

Returns:

a List of ApplicationDescriptions returned by the FindServers service.

findServers

public static CompletableFuture<List<ApplicationDescription>> findServers(String endpointUrl,
                                                                          Consumer<UaStackClientConfigBuilder> customizer)

Query the FindServers service at the endpointUrl.

The discovery URL(s) for each server ApplicationDescription in the response can then be used in a getEndpoints(String) call to discover the endpoints for that server.

Parameters:

endpointUrl - the endpoint URL to find servers at.

customizer - a Consumer that accepts a UaStackClientConfigBuilder for customization.

Returns:

a List of ApplicationDescriptions returned by the FindServers service.

getEndpoints

public static CompletableFuture<List<EndpointDescription>> getEndpoints(String endpointUrl)

Query the GetEndpoints service at endpointUrl.

Parameters:

endpointUrl - the endpoint URL to get endpoints from.

Returns:

a List of EndpointDescriptions returned by the GetEndpoints service.

getEndpoints

public static CompletableFuture<List<EndpointDescription>> getEndpoints(String endpointUrl,
                                                                        Consumer<UaStackClientConfigBuilder> customizer)

Query the GetEndpoints service at endpointUrl.

Parameters:

endpointUrl - the endpoint URL to get endpoints from.

customizer - a Consumer that accepts a UaStackClientConfigBuilder for customization.

Returns:

a List of EndpointDescriptions returned by the GetEndpoints service.