org.eclipse.milo.opcua.sdk.server.api.config

Interface OpcUaServerConfig

All Superinterfaces:

UaTcpStackServerConfig

All Known Implementing Classes:

OpcUaServerConfigBuilder.OpcUaServerConfigImpl

public interface OpcUaServerConfig
extends UaTcpStackServerConfig

Field Summary

Fields

Modifier and Type	Field and Description
static UserTokenPolicy	USER_TOKEN_POLICY_ANONYMOUS A UserTokenPolicy for anonymous access.
static UserTokenPolicy	USER_TOKEN_POLICY_USERNAME A UserTokenPolicy for username-based access.
static UserTokenPolicy	USER_TOKEN_POLICY_X509

Method Summary

Modifier and Type	Method and Description
static OpcUaServerConfigBuilder	builder()
static OpcUaServerConfigBuilder	copy(OpcUaServerConfig config) Copy the values from an existing OpcUaServerConfig into a new OpcUaServerConfigBuilder.
static OpcUaServerConfig	copy(OpcUaServerConfig config, Consumer<OpcUaServerConfigBuilder> consumer) Copy the values from an existing OpcUaServerConfig into a new OpcUaServerConfigBuilder and then submit the builder to the provided consumer for modification.
List<String>	getBindAddresses()
int	getBindPort()
BuildInfo	getBuildInfo()
List<String>	getEndpointAddresses()
IdentityValidator	getIdentityValidator() Get the IdentityValidator for the server.
OpcUaServerConfigLimits	getLimits()
EnumSet<SecurityPolicy>	getSecurityPolicies() The set of SecurityPolicys supported by this server.

Methods inherited from interface org.eclipse.milo.opcua.stack.server.config.UaTcpStackServerConfig

copy, copy, getApplicationName, getApplicationUri, getCertificateManager, getCertificateValidator, getChannelConfig, getExecutor, getProductUri, getServerName, getSoftwareCertificates, getUserTokenPolicies, isStrictEndpointUrlsEnabled

Field Detail

USER_TOKEN_POLICY_ANONYMOUS

static final UserTokenPolicy USER_TOKEN_POLICY_ANONYMOUS

A UserTokenPolicy for anonymous access.

USER_TOKEN_POLICY_USERNAME

static final UserTokenPolicy USER_TOKEN_POLICY_USERNAME

A UserTokenPolicy for username-based access.

USER_TOKEN_POLICY_X509

static final UserTokenPolicy USER_TOKEN_POLICY_X509

Method Detail

getBindPort

int getBindPort()

Returns:

the port to bind to.

getBindAddresses

List<String> getBindAddresses()

Returns:

the list of addresses to bind to.

getEndpointAddresses

List<String> getEndpointAddresses()

Returns:

the list of addresses used to build endpoint URLs and EndpointDescriptions.

getSecurityPolicies

EnumSet<SecurityPolicy> getSecurityPolicies()

The set of SecurityPolicys supported by this server.

Any policies other than SecurityPolicy.None require the server to have a certificate configured.

Returns:

the set of SecurityPolicys supported by this server.

getIdentityValidator

IdentityValidator getIdentityValidator()

Get the IdentityValidator for the server.

Returns:

the IdentityValidator for the server.

See Also:

AnonymousIdentityValidator, UsernameIdentityValidator, X509IdentityValidator, CompositeValidator

getBuildInfo

BuildInfo getBuildInfo()

Returns:

the server BuildInfo.

getLimits

OpcUaServerConfigLimits getLimits()

Returns:

the OpcUaServerConfigLimits.

builder

static OpcUaServerConfigBuilder builder()

Specified by:

builder in interface UaTcpStackServerConfig

Returns:

a OpcUaServerConfigBuilder.

copy

static OpcUaServerConfigBuilder copy(OpcUaServerConfig config)

Copy the values from an existing OpcUaServerConfig into a new OpcUaServerConfigBuilder. This builder can be used to make any desired modifications before invoking OpcUaServerConfigBuilder.build() to produce a new config.

Parameters:

config - the OpcUaServerConfig to copy from.

Returns:

a OpcUaServerConfigBuilder pre-populated with values from config.

copy

static OpcUaServerConfig copy(OpcUaServerConfig config,
                              Consumer<OpcUaServerConfigBuilder> consumer)

Copy the values from an existing OpcUaServerConfig into a new OpcUaServerConfigBuilder and then submit the builder to the provided consumer for modification.

Parameters:

config - the OpcUaServerConfig to copy from.

consumer - a Consumer that may modify the builder.

Returns:

a OpcUaServerConfig built from the builder provided to consumer.