Chapter 212. OPC UA Server Component

Available as of Camel version 2.19

The Milo Server component provides an OPC UA server using the Eclipse Milo™ implementation.

Java 8: This component requires Java 8 at runtime.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-milo</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

Messages sent to the endpoint from Camel will be available from the OPC UA server to OPC UA Clients. Value write requests from OPC UA Client will trigger messages which are sent into Apache Camel.

The OPC UA Server component supports 19 options which are listed below.

NameDescriptionDefaultType

namespaceUri (common)

The URI of the namespace, defaults to urn:org:apache:camel

 

String

applicationName (common)

The application name

 

String

applicationUri (common)

The application URI

 

String

productUri (common)

The product URI

 

String

bindPort (common)

The TCP port the server binds to

 

int

strictEndpointUrls Enabled (common)

Set whether strict endpoint URLs are enforced

false

boolean

serverName (common)

Server name

 

String

hostname (common)

Server hostname

 

String

securityPolicies (common)

Security policies

 

Set

securityPoliciesById (common)

Security policies by URI or name

 

String>

userAuthentication Credentials (common)

Set user password combinations in the form of user1:pwd1,user2:pwd2 Usernames and passwords will be URL decoded

 

String

enableAnonymous Authentication (common)

Enable anonymous authentication, disabled by default

false

boolean

bindAddresses (common)

Set the addresses of the local addresses the server should bind to

 

String

buildInfo (common)

Server build info

 

BuildInfo

serverCertificate (common)

Server certificate

 

Result

certificateManager (common)

Server certificate manager

 

CertificateManager

certificateValidator (common)

Validator for client certificates

 

CertificateValidator>

defaultCertificate Validator (common)

Validator for client certificates using default file based approach

 

File

resolveProperty Placeholders (advanced)

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

boolean

212.1. URI format

milo-server:itemId[?options]

212.2. URI options

The OPC UA Server endpoint is configured using URI syntax:

milo-server:itemId

with the following path and query parameters:

212.2.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

itemId

Required ID of the item

 

String

212.2.2. Query Parameters (4 parameters):

NameDescriptionDefaultType

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

 

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange.

 

ExchangePattern

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

212.3. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started