Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client

Interface OpcUaClientConfig

public interface OpcUaClientConfig

  • Method Details

    • getEndpoint

      org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription getEndpoint()
      Get the endpoint to connect to.
      Returns:
      the EndpointDescription to connect to.

    • getDiscoveryEndpoints

      List<org.eclipse.milo.opcua.stack.core.types.structured.EndpointDescription> getDiscoveryEndpoints()
      Get the endpoints that were returned during discovery, i.e., during the GetEndpoints service call.

      If not empty, and Session endpoint validation is enabled, this list will be compared with the list returned by the Server in the CreateSessionResponse when a Session is created.

      Returns:
      the endpoints that were returned during discovery.
      See Also:

    • getKeyPair

      Optional<KeyPair> getKeyPair()
      Get the KeyPair to use.

      May be absent if connecting without security, must be present if connecting with security.

      Returns:
      an Optional containing the KeyPair to use.

    • getCertificate

      Optional<X509Certificate> getCertificate()
      Get the X509Certificate to use.

      May be absent if connecting without security, must be present if connecting with security.

      Returns:
      an Optional containing the X509Certificate to use.

    • getCertificateChain

      Optional<X509Certificate[]> getCertificateChain()
      Get the X509Certificate to use as well as any certificates in the certificate chain.
      Returns:
      the X509Certificate to use as well as any certificates in the certificate chain.

    • getCertificateValidator

      org.eclipse.milo.opcua.stack.core.security.CertificateValidator getCertificateValidator()
      Get the CertificateValidator this client will use to validate server certificates when connecting.
      Returns:
      the validator this client will use to validate server certificates when connecting.

    • getApplicationName

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getApplicationName()
      Returns:
      the name of the client application, as a LocalizedText.

    • getApplicationUri

      String getApplicationUri()
      Returns:
      a URI for the client's application instance. This should be the same as the URI in the client certificate, if present.

    • getProductUri

      String getProductUri()
      Returns:
      the URI for the client's application product.

    • getSessionName

      Supplier<String> getSessionName()
      Returns:
      a Supplier for the session name.

    • getSessionLocaleIds

      String[] getSessionLocaleIds()
      Returns:
      the list of locale ids in priority order for localized strings

    • getSessionTimeout

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getSessionTimeout()
      Returns:
      the session timeout, in milliseconds, to request.

    • getRequestTimeout

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getRequestTimeout()
      Returns:
      the request timeout, in milliseconds.

    • getEncodingLimits

      org.eclipse.milo.opcua.stack.core.channel.EncodingLimits getEncodingLimits()
      Returns:
      the EncodingLimits used by this client.

    • getMaxResponseMessageSize

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxResponseMessageSize()
      Returns:
      the maximum size for a response from the server.

    • getMaxPendingPublishRequests

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getMaxPendingPublishRequests()
      Returns:
      the maximum number of outstanding PublishRequests allowed at any given time.

    • getIdentityProvider

      IdentityProvider getIdentityProvider()
      Returns:
      an IdentityProvider to use when activating a session.

    • getKeepAliveFailuresAllowed

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeepAliveFailuresAllowed()
      Returns:
      the number of consecutive keep-alive request failures allowed before a connection is determined to be in error state.

    • getKeepAliveInterval

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeepAliveInterval()
      Returns:
      the interval, in milliseconds, between consecutive keep-alive requests.

    • getKeepAliveTimeout

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getKeepAliveTimeout()
      Returns:
      the amount of time to wait, in milliseconds, for a keep-alive request before timing out.

    • isSessionEndpointValidationEnabled

      boolean isSessionEndpointValidationEnabled()
      Whether validation of the endpoints returned in CreateSessionResponse against the discovery endpoints is enabled. The discovery endpoints must be configured and non-empty.
      Returns:
      true if validation of the endpoints returned in CreateSessionResponse against the discovery endpoints is enabled.
      See Also:

    • builder

      static OpcUaClientConfigBuilder builder()
      Returns:
      a new OpcUaClientConfigBuilder.

    • copy

      static OpcUaClientConfigBuilder copy(OpcUaClientConfig config)
      Copy the values from an existing OpcUaClientConfig into a new OpcUaClientConfigBuilder. This builder can be used to make any desired modifications before invoking OpcUaClientConfigBuilder.build() to produce a new config.
      Parameters:
      config - the OpcUaClientConfig to copy from.
      Returns:
      a OpcUaClientConfigBuilder pre-populated with values from config.

    • copy

      static OpcUaClientConfig copy(OpcUaClientConfig config, Consumer<OpcUaClientConfigBuilder> consumer)
      Copy the values from an existing OpcUaClientConfig into a new OpcUaClientConfigBuilder and then submit the builder to the provided consumer for modification.
      Parameters:
      config - the OpcUaClientConfig to copy from.
      consumer - a Consumer that may modify the builder.
      Returns:
      a OpcUaClientConfig built from the builder provided to consumer.