UaServer (prosys-opc-ua-sdk-client-server-pubsub 5.6.2-227 API)

java.lang.Object
- com.prosysopc.ua.UaApplication
- - com.prosysopc.ua.server.UaServer

```
public class UaServer
extends UaApplication
```
Basic implementation of the OPC UA server.
You need to create a UaServer object and call init() for it after you have specified the security settings and endpointUrls to which you wish to bind it.
The endpoints are defined either as a list of URLs or even simpler by setting the Port and ServerName. The current host name of the server where the application is run is added to the list of URLs automatically. If you define UseLocalhost, the URL with the 'localhost' host name is also added to the list of Urls.
Note: Because the java stack currently only supports the OPC Binary protocol, you cannot define a port for the HTTP protocol.
By default, the server will contain a SessionManager, AttributeManager, SubscriptionManager and NodeManagerTable, which contains the NodeManagerRoot and the NodeManagerServer.
Use addNodeManager to add your own nodes into the server: do not add nodes to the NodeManagerRoot or NodeManagerServer.
You can also use addServiceHandler to add handlers for services that are not handled by the default implementation. However, you should take care that each service only has one handler in the server.
If you wish to replace the service handlers with your custom implementation, you must derive your own version of the server and override initServiceHandlers.
After you have finished with all initializations, call start() to make the server available for client connections, and to start the managers.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`UaServer.DiscoveryServer` Service handler that serves onFindServers & onRegisteredServer requests.
`static class`	`UaServer.NodeManagerUaServer` Server internal namespace (NamespaceIndex 1).

Nested classes/interfaces inherited from class com.prosysopc.ua.UaApplication
UaApplication.DiagnosticMask, UaApplication.Protocol

Field Summary

Fields
Modifier and Type	Field and Description
`protected ApplicationIdentity`	`applicationIdentity`
`protected AttributeServiceHandler`	`attributeServiceHandler`
`protected DiagnosticsManager`	`diagnosticsManager`
`protected Set<String>`	`discoveryUris`
`protected ScheduledExecutorService`	`executor`
`protected Set<SecurityMode>`	`httpsSecurityModes`
`protected Set<String>`	`httpsUris`
`protected UaServerListener`	`listener`
`protected NodeManagerRoot`	`nodeManagerRoot`
`protected NodeManagerTable`	`nodeManagerTable`
`protected UaServer.NodeManagerUaServer`	`nodeManagerUaServer`
`protected NodeManagementServiceHandler`	`nodeServiceHandler`
`protected Set<SecurityMode>`	`securityModes`
`protected Set<String>`	`serverUris`
`protected SessionManager`	`sessionManager`
`protected SessionManagerListener`	`sessionManagerListener`
`protected SessionServiceHandler`	`sessionServiceHandler`
`protected SubscriptionManager`	`subscriptionManager`
`protected SubscriptionServiceHandler`	`subscriptionServiceHandler`

Constructor Summary

Constructors
Constructor and Description

UaServer()
Creates a new UA Server.

Constructors
Constructor and Description
`UaServer()` Creates a new UA Server.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEndpoint(String uri, SecurityMode securityMode, UserTokenPolicy... userTokenPolicies)` Add an endpoint definition for a specific URI, SecurityMode & UserTokenPolicies combination You should call addEndpoint after `init()` has been called.
`String[]`	`addEndpointHost(String hostName)` Add a specific hostName to the list of server URIs, in addition to what the default properties define.
`void`	`addLocale(Locale locale)`
`void`	`addReverseConnection(ReverseConnectionParameters parameters)` Adds a ReverseHello connection.
`void`	`addReverseConnection(String clientServerEndpointUrl)` Adds a ReverseHello connection.
`void`	`addReverseConnection(String clientServerEndpointUrl, String endpointUrlForClientConnection)` Adds a ReverseHello connection.
`void`	`addServiceHandler(Object serviceHandler)` Add a custom serviceHandler.
`void`	`addToServerArray(String uri)` Add a server description to the serverArray.
`void`	`addUserTokenPolicy(UserTokenPolicy policy)`
`void`	`close()`
`protected AttributeServiceHandler`	`createAttributeServiceHandler()` Creates the AttributeServiceHandler to use for the server.
`protected DiagnosticsManager`	`createDiagnosticsManager()`
`protected ScheduledExecutorService`	`createExecutor()` This is called when a executor would be created for the UaServer.
`protected UaLoopbackClient`	`createLoopbackClient(Consumer<EndpointServiceRequest<?,?>> requestConsumer)` Creates a new `UaLoopbackClient` using the given consumer.
`protected NodeManager`	`createNewNodeManager(ServiceContext serviceContext, String namespaceUri)` Creates a new node manager as a response to an AddNodes request with a NodeId that is not managed by any node managers, yet.
`protected NodeManagementServiceHandler`	`createNodeManagementServiceHandler()` Return `NodeManagementServiceHandler`, this can be used to override the `NodeManagementServiceHandler` used by the server by returning a custom subtype.
`protected NodeManagerRoot`	`createNodeManagerRoot()` Return `NodeManagerRoot`, this can be used to override the `NodeManagerRoot` used by the server by returning a custom subtype.
`protected NodeManagerTable`	`createNodeManagerTable()` Return `NodeManagerTable`, this can be used to override the `NodeManagerTable` used by the server by returning a custom subtype.
`protected UaServer.NodeManagerUaServer`	`createNodeManagerUaServer(String applicationUri)` Return `UaServer.NodeManagerUaServer`, this can be used to override the `UaServer.NodeManagerUaServer` used by the server by returning a custom subtype.
`protected SessionManager`	`createSessionManager()` Return `SessionManager`, this can be used to override the `SessionManager` used by the server by returning a custom subtype.
`protected SessionServiceHandler`	`createSessionServiceHandler()` Return `SessionServiceHandler`, this can be used to override the `SessionServiceHandler` used by the server by returning a custom subtype.
`protected SubscriptionManager`	`createSubscriptionManager()` Return `SubscriptionManager`, this can be used to override the `SubscriptionManager` used by the server by returning a custom subtype.
`protected SubscriptionServiceHandler`	`createSubscriptionServiceHandler()` Return `SubscriptionServiceHandler`, this can be used to override the `SubscriptionServiceHandler` used by the server by returning a custom subtype.
`NodeManagerTable`	`getAddressSpace()`
`ApplicationIdentity`	`getApplicationIdentity()` Returns the `ApplicationIdentity` of this `UaServer`.
`AttributeServiceHandler`	`getAttributeServiceHandler()` Returns the `AttributeServiceHandler` of this `UaServer`.
`Set<InetAddress>`	`getBindAddresses()` Returns the InetAddresses the server should be bound to listen.
`Set<InetAddress>`	`getBindAddresses(UaApplication.Protocol protocol)` Get the addresses to bind the server endpoints that use a specific protocol.
`DiagnosticsManager`	`getDiagnosticsManager()`
`protected UaServer.DiscoveryServer`	`getDiscoveryServer()`
`UaAddress`	`getDiscoveryServerAddress()`
`long`	`getDiscoveryServerRegistrationPeriod()` The period used for re-registering to the Discovery Server.
`SecurityMode`	`getDiscoveryServerRegistrationSecurityMode()`
`String`	`getDiscoveryServerUrl()`
`protected String`	`getDiscoveryUriOf(String uri)`
`EncoderContext`	`getEncoderContext()`
`EndpointDescription`	`getEndpoint(String uri, SecurityMode securityMode)` Find an endpoint definition for a specific URI & SecurityMode combination
`EndpointConfiguration`	`getEndpointConfiguration()`
`String[]`	`getEndpointHosts()` Get all EndpointHosts defined with `addEndpointHost(String)`.
`EndpointDescription[]`	`getEndpoints()` Get the list of endpoints.
`EndpointDescription[]`	`getEndpoints(String uri)` Find all endpoint definitions for a specific URI
`static UnsignedByte`	`getEndpointSecurityLevel(SecurityMode sm)` Calculate the SecurityLevel of the SecurityMode.
`protected ScheduledExecutorService`	`getExecutor()`
`String[]`	`getHostNames()` Deprecated. Use `getEndpointHosts()` instead.
`protected int`	`getHttpsPort()`
`Set<SecurityMode>`	`getHttpsSecurityModes()`
`protected HttpsSecurityPolicy[]`	`getHttpsSecurityPolicies()`
`HttpsSettings`	`getHttpsSettings()`
`int`	`getHttpsWorkerThreadCount()`
`UaServerListener`	`getListener()`
`Locale[]`	`getLocales()`
`UaLoopbackClient`	`getLoopbackClient()` Returns an `UaClient`, that is directly connected (java-internally) to this Server.
`Integer`	`getMaxOpcHttpsConnections()` See `setMaxOpcHttpsConnections(Integer)`.
`Integer`	`getMaxOpcTcpConnections()` See `setMaxOpcTcpConnections(Integer)`.
`NodeManagementServiceHandler`	`getNodeManagementServiceHandler()` Returns the `NodeManagementServiceHandler` of this `UaServer`.
`NodeManagerRoot`	`getNodeManagerRoot()` Returns `NodeManagerRoot`, the NamespaceIndex 0 `NodeManager` of this UaServer.
`NodeManagerTable`	`getNodeManagerTable()` Deprecated. Use `getAddressSpace()`
`UaServer.NodeManagerUaServer`	`getNodeManagerUaServer()`
`int`	`getPort()` The port in which the server is listening to the OPC Binary protocol.
`int`	`getPort(UaApplication.Protocol protocol)` Get the protocol specific TCP/IP port number.
`PubSubConfigurator`	`getPubSubConfigurator()` This method is designed for SDK internal use only, but it is called from other packages thus being public.
`Set<SecurityMode>`	`getSecurityModes()` Live set to the security modes the server supports for the opc.tcp endpoints.
`protected Server`	`getServer()`
`String`	`getServerName()`
`String`	`getServerName(UaApplication.Protocol protocol)` Get the protocol specific serverName definition.
`ServerTable`	`getServerTable()` Returns the server's ServerTable (from node `VariableIdentifiers.Server_ServerArray`).
`String[]`	`getServerUris()` The endpoint URIs to which the server listens to.
`SessionManager`	`getSessionManager()`
`SessionServiceHandler`	`getSessionServiceHandler()`
`SubscriptionManager`	`getSubscriptionManager()`
`SubscriptionServiceHandler`	`getSubscriptionServiceHandler()`
`UserTokenPolicy[]`	`getUserTokenPolicies()`
`void`	`init()` Initializes the server.
`protected void`	`initAggregateFunctions()` Initialize the Aggregate Functions under the ServerCapabilities node, from the AggregateCalculator.
`protected void`	`initServerArray()`
`protected void`	`initServiceHandlers()`
`boolean`	`isDiscoveryEndpointEnabled()`
`boolean`	`isEnableIPv6()` Returns true if IPv6 networking is enabled or false otherwise.
`boolean`	`isFailOnBindError()`
`boolean`	`isRunning()`
`boolean`	`isUseAllIpAddresses()` Deprecated.
`boolean`	`isUseCanonicalHostName()` Deprecated.
`boolean`	`isUseHostName()` Deprecated.
`boolean`	`isUseLocalhost()` Deprecated.
`protected void`	`logRegisterServerError(String discoveryServerUrl, boolean isOnline, UaServerException e)`
`void`	`registerAndLoadModel(ServerCodegenModel codegenModel, URI nodeSetXml)` Specify an information model to use in the application.
`void`	`registerModel(ServerCodegenModel codegenModel)` Register an information model to use in the application.
`boolean`	`registerServer(boolean isOnline)` Register the server on the DiscoveryServer at `getDiscoveryServerUrl()`.
`protected boolean`	`registerServer(boolean isOnline, boolean callLDS)` Same as `registerServer(boolean)`, but allows skipping calling the LocalDiscoveryServer (with callLDS false).
`void`	`registerServer(String discoveryUrl, boolean isOnline)` Register the server on a discovery server with RegisterServer2 and then with RegisterServer if RegisterServer2 fails.
`void`	`removeEndpoint(String uri, SecurityMode securityMode)` Remove an endpoint definition for a specific URI & SecurityMode combination You should call addEnpoint after `init()` has been called.
`void`	`removeEndpointHost(String hostName)` Removes all endpoints that use hostName - as defined by `addEndpointHost(java.lang.String)`, or using the default HostName of the computer.
`void`	`removeEndpoints(String uri)` Removes all endpoints that have the given endpointUrl.
`void`	`removeLocale(Locale locale)`
`void`	`removeReverseConnection(ReverseConnectionParameters reverseConnectionParameters)` Removes a previously added reverse connection.
`void`	`removeReverseConnection(String clientServerEndpointUrl)` Removes a previously added reverse connection.
`void`	`removeReverseConnection(String clientServerEndpointUrl, String endpointUrlForClientConnection)` Deprecated. starting from SDK 5.1.0, the second parameter no longer has a meaning as `ReverseConnectionParameters.equals(Object)` is only based on the `ReverseConnectionParameters.getClientServerEndpointUrl()`. Thus, `removeReverseConnection(String)` should be used instead.
`void`	`removeUserTokenPolicy(UserTokenPolicy policy)`
`boolean`	`requestServerStateChange(ServiceContext serviceContext, ServerState state, DateTime estimatedReturnTime, UnsignedInteger secondsTillShutdown, LocalizedText reason, Boolean restart)` Request a change in server state (shutdown or restart server).
`void`	`setApplicationIdentity(ApplicationIdentity identity)` Define the application identity of the server.
`void`	`setBindAddresses(Set<InetAddress> bindAddresses)` Define the InetAddresses the server endpoints should be bound to.
`void`	`setBindAddresses(UaApplication.Protocol protocol, Set<InetAddress> bindAddresses)` Define the InetAddresses the server endpoints should be bound to.
`void`	`setDiscoveryEndpointEnabled(boolean discoveryEndpointEnabled)` If this is set to false, the internal discovery server is not created and this server does not offer any Discovery Services, e.g.
`void`	`setDiscoveryServerAddress(UaAddress discoveryServerAddress)` Set DiscoveryServer address, same as setDiscoveryServerUrl, but this method does not throw exception as UaAddress instances have valid syntax.
`void`	`setDiscoveryServerRegistrationPeriod(long discoveryServerRegistrationPeriod)` Define the period used for re-registering to the Discovery Server.
`void`	`setDiscoveryServerRegistrationSecurityMode(SecurityMode discoveryServerRegistrationSecurityMode)` Define the SecurityMode to use when registering to the Discovery Server.
`void`	`setDiscoveryServerUrl(String discoveryServerUrl)` Define the discovery server in which the server is registered automatically.
`void`	`setEnableIPv6(boolean enableIPv6)` Define whether to use IPv6 addresses.
`void`	`setEndpointConfiguration(EndpointConfiguration endpointConfiguration)` Define the EndpointConfiguration to use for all default endpoints.
`void`	`setFailOnBindError(boolean failOnBindError)` Define whether the server `start()` should fail, if any of the endpoint bindings fail.
`protected void`	`setHttpsPort(int httpsPort)` Defines the IP port number to use for the HTTPS connection.
`void`	`setHttpsSecurityPolicies(HttpsSecurityPolicy... httpsSecurityPolicies)` Define the security policies used for the HTTPS protocol.
`void`	`setHttpsSettings(HttpsSettings httpsSettings)`
`void`	`setHttpsWorkerThreadCount(int httpsWorkerThreadCount)` The number of worker threads to use for the HTTPS server.
`void`	`setListener(UaServerListener listener)`
`void`	`setMaxOpcHttpsConnections(Integer maxOpcHttpsConnections)` Maximum number of concurrent opc.https connections.
`void`	`setMaxOpcTcpConnections(Integer maxOpcTcpConnections)` Maximum number of concurrent opc.tcp connections.
`void`	`setPort(int port)` The port in which the server is listening to the OPC Binary protocol.
`void`	`setPort(UaApplication.Protocol protocol, int port)` Define the TCP/IP port number for a specific protocol.
`void`	`setPubSubConfigurator(PubSubConfigurator pubSubConfigurator)`
`void`	`setSecurityModes(SecurityMode[] securityModes)` Deprecated. use `getSecurityModes()` and add to the set directly. This method replaces all existing ones.
`void`	`setServerName(String serverName)` Define the default server name.
`void`	`setServerName(UaApplication.Protocol protocol, String serverName)` Define the server name for a specific protocol.
`void`	`setUseAllIpAddresses(boolean useAllIpAddresses)` Deprecated. The server is no longer defining endpoints for different IP addresses. Use `setBindAddresses(Set)` instead to define to which actual addresses the endpoints are bound to.
`void`	`setUseCanonicalHostName(boolean useCanonicalHostName)` Deprecated. The server is no longer defining endpoints for different host names. Use `setBindAddresses(Set)` instead to define to which actual addresses the endpoints are bound to.
`void`	`setUseHostName(boolean useHostName)` Deprecated. The server is no longer defining endpoints for different host names. Use `setBindAddresses(Set)` instead to define to which actual addresses the endpoints are bound to.
`void`	`setUseLocalhost(boolean useLocalhost)` Deprecated.
`void`	`setUserTokenPolicies(UserTokenPolicy... userTokenPolicies)` Define the supported UserTokenPolicies.
`void`	`setUserValidator(UserValidator userValidator)` Define your custom user validator to check the users that are logging in to the server.
`void`	`shutdown(int secondsTillShutdown, LocalizedText shutdownReason)` Shutdown the server.
`void`	`shutdown(int secondsTillShutdown, LocalizedText shutdownReason, boolean closeServer)` Shutdown the server.
`void`	`shutdown(int secondsTillShutdown, String shutdownReason)` Shutdown the server.
`void`	`shutdown(int secondsTillShutdown, String shutdownReason, boolean closeServer)` Shutdown the server.
`protected void`	`shutdownBegin(int secondsTillShutdown, LocalizedText shutdownReason)` Begin server shutdown process
`protected void`	`shutdownEnd(boolean closeServer)` Complete the shutdown process
`protected void`	`shutdownSleep(int secondsTillShutdown)` Wait before completing shutdown
`void`	`start()` Starts the server using the current configuration.
`protected static RegisteredServer`	`toRegisteredServer(String semaphoreFilePath, boolean isOnline, UaServer uaServer)`
`protected void`	`updateNamespaceArray()`
`protected void`	`updateServerArray()`
`protected void`	`updateServerCapabilities()` Sets the ServerCabalitities, Updates Nodes below /Root/Objects/Server/ServerCapabilities/.
`protected void`	`validateUserError(Session session, UserIdentityToken userToken, Exception e)`
`protected boolean`	`validateUserIdentity(Session session, ServerUserIdentity userIdentity)`

Methods inherited from class com.prosysopc.ua.UaApplication
formatUri, getAggregateCalculator, getCertificateValidator, getKnownDataTypeDictionary, getNamespaceTable, getOperationLimits, getRegisteredClasses, getSdkVersion, getVersion, isAutoDiscoverCodegenModels, registerAutoDiscoveredModels, registerModelInternal, setAutoDiscoverCodegenModels, setCertificateValidator, setOperationLimits, validateApplicationCertificate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - applicationIdentity
```
protected ApplicationIdentity applicationIdentity
```
  - attributeServiceHandler
```
protected AttributeServiceHandler attributeServiceHandler
```
  - discoveryUris
```
protected Set<String> discoveryUris
```
  - httpsUris
```
protected Set<String> httpsUris
```
  - listener
```
protected UaServerListener listener
```
  - nodeManagerRoot
```
protected NodeManagerRoot nodeManagerRoot
```
  - nodeManagerTable
```
protected NodeManagerTable nodeManagerTable
```
  - nodeManagerUaServer
```
protected UaServer.NodeManagerUaServer nodeManagerUaServer
```
  - nodeServiceHandler
```
protected NodeManagementServiceHandler nodeServiceHandler
```
  - httpsSecurityModes
```
protected Set<SecurityMode> httpsSecurityModes
```
  - securityModes
```
protected Set<SecurityMode> securityModes
```
  - serverUris
```
protected Set<String> serverUris
```
  - sessionManager
```
protected SessionManager sessionManager
```
  - executor
```
protected ScheduledExecutorService executor
```
  - sessionManagerListener
```
protected final SessionManagerListener sessionManagerListener
```
  - sessionServiceHandler
```
protected SessionServiceHandler sessionServiceHandler
```
  - subscriptionManager
```
protected SubscriptionManager subscriptionManager
```
  - subscriptionServiceHandler
```
protected SubscriptionServiceHandler subscriptionServiceHandler
```
  - diagnosticsManager
```
protected DiagnosticsManager diagnosticsManager
```
- Constructor Detail
  - UaServer
```
public UaServer()
```
    Creates a new UA Server. Use setPort (and setServerName) or setUri to define the server endpointUrl. Also use setIdentity to define the server identity, including the certificate.
- Method Detail
  - getEndpointSecurityLevel
```
public static UnsignedByte getEndpointSecurityLevel(SecurityMode sm)
```
    Calculate the SecurityLevel of the SecurityMode. Returns a value that is used to define the securityLevel of an endpoint.
    The value is calculated from MessageSecurityMode and SecurityPolicy: MessageSecurityMode.SignAndEncrypt gives the highest values.
    You can use this if you are defining the endpoints yourself.
  - toRegisteredServer
```
protected static RegisteredServer toRegisteredServer(String semaphoreFilePath,
                                                     boolean isOnline,
                                                     UaServer uaServer)
```
  - addEndpoint
```
public void addEndpoint(String uri,
                        SecurityMode securityMode,
                        UserTokenPolicy... userTokenPolicies)
                 throws UaServerException
```
    Add an endpoint definition for a specific URI, SecurityMode & UserTokenPolicies combination
    You should call addEndpoint after init() has been called.
    Cannot be modified after calling start(), i.e. when the server isRunning().
    
    Parameters:
    
    uri - the server URI. Use UaApplication.formatUri(Protocol, String, int, String) to compose one.
    
    securityMode - The security mode of the endpoint
    
    userTokenPolicies - Supported user token policies
    
    Throws:
    
    UaServerException - if the server is running, i.e start has been called
    
    See Also:
    
    removeEndpoint(String, SecurityMode)
  - addEndpointHost
```
public String[] addEndpointHost(String hostName)
                         throws UaServerException
```
    Add a specific hostName to the list of server URIs, in addition to what the default properties define.
    This is a "light-weight" alternative to defining the endpoints yourself, if you wish to use the same security mode for every URI.
    The method must be used before start() is called.
    Note that by default, the server is always initialized using ApplicationIdentity.getActualHostName().
    
    Parameters:
    
    hostName - the hostname or IP address to use for the endpointUrls when initializing the server endpoints.
    
    Returns:
    
    the endpointUrl that is defined by the hostName
    
    Throws:
    
    UaServerException
    
    See Also:
    
    removeEndpointHost(String), getEndpointHosts()
  - addLocale
```
public void addLocale(Locale locale)
               throws UaServerException
```
    Parameters:
    
    locale -
    
    Throws:
    
    UaServerException
  - addReverseConnection
```
public void addReverseConnection(ReverseConnectionParameters parameters)
```
    Adds a ReverseHello connection. These are initialized when the server start()s. Calling this method while the server is running will add and initialize the reverse connection. NOTE! Calling this method multiple times only adds one connection, additional calls have no effect. Additionally, please note that only ReverseConnectionParameters.getClientServerEndpointUrl() is used to determine is there already a connection. This is to say, there can only be a single connection per client listening address.
    
    Parameters:
    
    parameters - for the reverse connection
    
    Throws:
    
    IllegalArgumentException - if called while the server is running and the reverse connection cannot be initialized
  - addReverseConnection
```
public void addReverseConnection(String clientServerEndpointUrl)
```
    Adds a ReverseHello connection. These are initialized when the server start()s. Calling this method while the server is running will add and initialize the reverse connection. NOTE! Calling this method multiple times only adds one connection, additional calls have no effect.
    NOTE! This method assumes the server has only one EndpointUrl, which is typically based on the hostname of this machine. If there are multiple, one of them is used. Typically it shouldn't matter which one is used, but if it does, please use addReverseConnection(String, String) instead.
    
    Parameters:
    
    clientServerEndpointUrl - address of a client, that has opened a Socket for ReverseHello calls made by the server.
    
    Throws:
    
    IllegalArgumentException - if called while the server is running and the reverse connection cannot be initialized
  - addReverseConnection
```
public void addReverseConnection(String clientServerEndpointUrl,
                                 String endpointUrlForClientConnection)
```
    Adds a ReverseHello connection. These are initialized when the server start()s. Calling this method while the server is running will add and initialize the reverse connection. NOTE! Calling this method multiple times only adds one connection, additional calls have no effect.
    
    Parameters:
    
    clientServerEndpointUrl - address of a client, that has opened a Socket for ReverseHello calls made by the server.
    
    endpointUrlForClientConnection - The EndpointUrl, which the client should use when connecting. This must be one of the EndpointUrls in EndpointDescriptions provided by the server. Additionally a client might listen only on one of them, so this must be coordinated with the client side application configuration.
    
    Throws:
    
    IllegalArgumentException - if called while the server is running and the reverse connection cannot be initialized
  - addServiceHandler
```
public void addServiceHandler(Object serviceHandler)
```
    Add a custom serviceHandler. You should take care that each service only has one handler in the server.
    
    Parameters:
    
    serviceHandler -
  - addToServerArray
```
public void addToServerArray(String uri)
                      throws StatusException
```
    Add a server description to the serverArray. The ServerArray is available from the namespace.
    
    Parameters:
    
    uri - the URI of the server to add.
    
    Throws:
    
    StatusException
  - addUserTokenPolicy
```
public void addUserTokenPolicy(UserTokenPolicy policy)
                        throws UaServerException
```
    Parameters:
    
    policy -
    
    Throws:
    
    UaServerException
  - close
```
public void close()
```
  - getAddressSpace
```
public NodeManagerTable getAddressSpace()
```
    Specified by:
    
    getAddressSpace in class UaApplication
    
    Returns:
    
    the AddressSpace, which provides access to the UA nodes.
  - getApplicationIdentity
```
public ApplicationIdentity getApplicationIdentity()
```
    Returns the ApplicationIdentity of this UaServer.
    
    Specified by:
    
    getApplicationIdentity in class UaApplication
  - getAttributeServiceHandler
```
public AttributeServiceHandler getAttributeServiceHandler()
```
    Returns the AttributeServiceHandler of this UaServer.
  - getBindAddresses
```
public Set<InetAddress> getBindAddresses()
```
    Returns the InetAddresses the server should be bound to listen. By default uses the IPv6 wildcard '[::]' if isEnableIPv6() is true, otherwise the IPv4 wildcard '0.0.0.0'.
  - getBindAddresses
```
public Set<InetAddress> getBindAddresses(UaApplication.Protocol protocol)
```
    Get the addresses to bind the server endpoints that use a specific protocol. Returns getBindAddresses(), if no protocol specific values are defined with #setBindAddresses(Protocol, Set).
    
    Parameters:
    
    protocol -
    
    Returns:
    
    the inet addresses the server should be bound to.
    
    Throws:
    
    SocketException
  - getDiagnosticsManager
```
public DiagnosticsManager getDiagnosticsManager()
```
  - getDiscoveryServerAddress
```
public UaAddress getDiscoveryServerAddress()
```
    Returns:
    
    the address to use when registering the server to the (Local) Discovery Server.
  - getDiscoveryServerRegistrationPeriod
```
public long getDiscoveryServerRegistrationPeriod()
```
    The period used for re-registering to the Discovery Server.
    
    Returns:
    
    the discoveryServerRegistrationPeriod in minutes
  - getDiscoveryServerRegistrationSecurityMode
```
public SecurityMode getDiscoveryServerRegistrationSecurityMode()
```
    Returns:
    
    the security mode to use for registering the server to getDiscoveryServerAddress()
    
    See Also:
    
    setDiscoveryServerRegistrationSecurityMode(SecurityMode)
  - getDiscoveryServerUrl
```
public String getDiscoveryServerUrl()
```
    Returns:
    
    the address to use when registering the server to the (Local) Discovery Server. Equals to getDiscoveryServerAddress().getAddress()
  - getEncoderContext
```
public EncoderContext getEncoderContext()
```
    Specified by:
    
    getEncoderContext in class UaApplication
    
    Returns:
    
    the encoder context, which is used for mapping namespaces and nodeIds in the stack layer.
  - getEndpoint
```
public EndpointDescription getEndpoint(String uri,
                                       SecurityMode securityMode)
```
    Find an endpoint definition for a specific URI & SecurityMode combination
    
    Parameters:
    
    uri - the server URI. Use UaApplication.formatUri(Protocol, String, int, String) to compose one.
    
    securityMode - The security mode of the endpoint
    
    Returns:
    
    the endpoint that matches the request or null if there is no match
  - getEndpointConfiguration
```
public EndpointConfiguration getEndpointConfiguration()
```
    Returns:
    
    the EndpointConfiguration used for all default endpoints.
  - getEndpointHosts
```
public String[] getEndpointHosts()
```
    Get all EndpointHosts defined with addEndpointHost(String).
    * Note that by default, the server is always initialized using ApplicationIdentity.getActualHostName().
    
    See Also:
    
    removeEndpointHost(String)
  - getEndpoints
```
public EndpointDescription[] getEndpoints()
```
    Get the list of endpoints. The endpoints is filled in when you call init(), and they are bound when you call start(). Between those calls, you can modify the list according to your needs using addEndpoint(String, SecurityMode, UserTokenPolicy...) and removeEndpoint(String, SecurityMode).
    
    Returns:
    
    all defined endpoints
  - getEndpoints
```
public EndpointDescription[] getEndpoints(String uri)
```
    Find all endpoint definitions for a specific URI
    
    Parameters:
    
    uri - the server URI. Use UaApplication.formatUri(Protocol, String, int, String) to compose one.
    
    Returns:
    
    the endpoints that match the request or an empty array if there are none
  - getHostNames
```
@Deprecated
public String[] getHostNames()
```
    Deprecated. Use getEndpointHosts() instead.
    
    Returns all HostNames of the server as defined with addEndpointHost(String).
  - getHttpsSecurityModes
```
public Set<SecurityMode> getHttpsSecurityModes()
```
  - getHttpsSettings
```
public HttpsSettings getHttpsSettings()
```
    Returns:
    
    the httpsSettings
  - getHttpsWorkerThreadCount
```
public int getHttpsWorkerThreadCount()
```
    Returns:
    
    the current httpsWorkerThreadCount
    
    See Also:
    
    setHttpsWorkerThreadCount(int)
  - getListener
```
public UaServerListener getListener()
```
    Returns:
    
    the listener
  - getLocales
```
public Locale[] getLocales()
```
    Returns:
    
    See Also:
    
    Application.getLocales()
  - getLoopbackClient
```
public UaLoopbackClient getLoopbackClient()
```
    Returns an UaClient, that is directly connected (java-internally) to this Server. Calls made using this client are directly forward to the ServiceHandlers (such as AttributeServiceHandler e.g. for Read/Write) if this UaServer. The Session Session of this Client is the same as Session.INTERNAL_SESSION and has access to everything.
  - getMaxOpcHttpsConnections
```
public Integer getMaxOpcHttpsConnections()
```
    See setMaxOpcHttpsConnections(Integer).
  - getMaxOpcTcpConnections
```
public Integer getMaxOpcTcpConnections()
```
    See setMaxOpcTcpConnections(Integer).
  - getNodeManagementServiceHandler
```
public NodeManagementServiceHandler getNodeManagementServiceHandler()
```
    Returns the NodeManagementServiceHandler of this UaServer.
  - getNodeManagerRoot
```
public NodeManagerRoot getNodeManagerRoot()
```
    Returns NodeManagerRoot, the NamespaceIndex 0 NodeManager of this UaServer. It contains the Core Information Model of the OPC UA Specification.
  - getNodeManagerTable
```
@Deprecated
public NodeManagerTable getNodeManagerTable()
```
    Deprecated. Use getAddressSpace()
    
    Returns the NodeManagerTable, which contains all the NodeManager's of the server and in effect makes up the server address space.
  - getNodeManagerUaServer
```
public UaServer.NodeManagerUaServer getNodeManagerUaServer()
```
    Returns:
  - getPort
```
public int getPort()
```
    The port in which the server is listening to the OPC Binary protocol.
    Equals to calling #getPort(Protocol) with Protocol.Opc.
    
    Returns:
    
    the port
  - getPort
```
public int getPort(UaApplication.Protocol protocol)
```
    Get the protocol specific TCP/IP port number.
    
    Parameters:
    
    protocol - the protocol whose port you want
    
    Returns:
    
    the defined value - if 0, the protocol is not in use.
  - getPubSubConfigurator
```
public PubSubConfigurator getPubSubConfigurator()
                                         throws StatusException
```
    This method is designed for SDK internal use only, but it is called from other packages thus being public.
    
    Throws:
    
    StatusException
  - getSecurityModes
```
public Set<SecurityMode> getSecurityModes()
```
    Live set to the security modes the server supports for the opc.tcp endpoints. Note that edits to this set are only applied when the server starts. The set is by default empty.
    
    Returns:
    
    SecurityModes that opc.tcp endpoints of the server support
  - getServerName
```
public String getServerName()
```
    Returns:
    
    the serverName
  - getServerName
```
public String getServerName(UaApplication.Protocol protocol)
```
    Get the protocol specific serverName definition.
    
    Parameters:
    
    protocol - the protocol whose serverName you want
    
    Returns:
    
    the specific serverName or the default one given by getServerName() if no specific value is deifned.
  - getServerTable
```
public ServerTable getServerTable()
```
    Description copied from class: UaApplication
    
    Returns the server's ServerTable (from node VariableIdentifiers.Server_ServerArray). The indexes of the table are used if References of a node in the server points to another server via ExpandedNodeId.getServerIndex(). The index 0 always means the local server and has the local server's ApplicationUri
    
    Specified by:
    
    getServerTable in class UaApplication
  - getServerUris
```
public String[] getServerUris()
                       throws UaServerException
```
    The endpoint URIs to which the server listens to.
    The list is made up of all the possible "hostnames" defined for the current computer. See the setters in the 'see also' part - these are ultimately defining the set.
    
    Returns:
    
    an array of all endpoint URI strings, which the server uses.
    
    Throws:
    
    UaServerException - if the local hostname or all IP addresses cannot be resolved
    
    See Also:
    
    setUseLocalhost(boolean), setUseHostName(boolean), setUseAllIpAddresses(boolean), setPort(int), setServerName(String)
  - getSessionManager
```
public SessionManager getSessionManager()
```
    Returns:
    
    The SessionManager that handles client sessions to the server.
  - getSessionServiceHandler
```
public SessionServiceHandler getSessionServiceHandler()
```
    Returns:
    
    the SessionServiceHandler
  - getSubscriptionManager
```
public SubscriptionManager getSubscriptionManager()
```
    Returns:
  - getSubscriptionServiceHandler
```
public SubscriptionServiceHandler getSubscriptionServiceHandler()
```
    Returns:
    
    the SubscriptionServiceHandler
  - getUserTokenPolicies
```
public UserTokenPolicy[] getUserTokenPolicies()
```
    Returns:
    
    the configured user token policies
    
    See Also:
    
    addUserTokenPolicy(UserTokenPolicy), removeUserTokenPolicy(UserTokenPolicy)
  - init
```
public void init()
          throws UaServerException
```
    Initializes the server. You should call init before doing your own server initializations. After you have finished with all initializations, call start().
    
    Throws:
    
    UaServerException - if the initialization fails
  - isDiscoveryEndpointEnabled
```
public boolean isDiscoveryEndpointEnabled()
```
    Returns:
    
    true if DiscoveryEndpoint should be created when the server is started, default is true
    
    See Also:
    
    setDiscoveryEndpointEnabled(boolean)
  - isEnableIPv6
```
public boolean isEnableIPv6()
```
    Returns true if IPv6 networking is enabled or false otherwise. Can be set with setEnableIPv6(boolean). Default value is true.
    
    Returns:
    
    the enableIPv6
  - isFailOnBindError
```
public boolean isFailOnBindError()
```
    Returns:
    
    the failOnBindError
    
    See Also:
    
    setFailOnBindError(boolean)
  - isRunning
```
public boolean isRunning()
```
    Returns:
    
    true when the server is running and accepts connections.
    
    See Also:
    
    start(), shutdown(int, LocalizedText)
  - isUseAllIpAddresses
```
@Deprecated
public boolean isUseAllIpAddresses()
```
    Deprecated.
    
    Returns:
  - isUseCanonicalHostName
```
@Deprecated
public boolean isUseCanonicalHostName()
```
    Deprecated.
    
    Define whether InetAddress.getLocalHost().getCanonicalHostName() is added to the endpoints (getServerUris()).
    Default: true
    
    Returns:
    
    the useCanonicalHostName
    
    See Also:
    
    isUseHostName()
  - isUseHostName
```
@Deprecated
public boolean isUseHostName()
```
    Deprecated.
    
    Define whether InetAddress.getLocalHost().getHostName() is added to the endpoints (getServerUris()).
    Default: true
    
    Returns:
    
    the useHostName
    
    See Also:
    
    isUseCanonicalHostName()
  - isUseLocalhost
```
@Deprecated
public boolean isUseLocalhost()
```
    Deprecated.
    
    Define whether 'localhost' is added to the endpoints ( getServerUris()).
    Default: true
    
    Returns:
    
    the useLocalhost
  - registerAndLoadModel
```
public void registerAndLoadModel(ServerCodegenModel codegenModel,
                                 URI nodeSetXml)
                          throws SAXException,
                                 IOException,
                                 ModelException,
                                 ServiceException
```
    Specify an information model to use in the application. The model is registered for node creation and the respective types are also loaded to the type address space from the UA Nodeset XML.
    Uses registerModel(com.prosysopc.ua.server.ServerCodegenModel) and NodeManagerTable.loadModel(URI).
    
    Parameters:
    
    codegenModel - the InformationModel generated by the Code Generator
    
    nodeSetXml - the XML definition of the information model in NodeSet2.xml format
    
    Throws:
    
    ServiceException - if the mode cannot be loaded into the server
    
    ModelException
    
    IOException
    
    SAXException
  - registerModel
```
public void registerModel(ServerCodegenModel codegenModel)
```
    Register an information model to use in the application. All the types in the model are then available for the application, when it constructs new instances.
    
    Parameters:
    
    codegenModel - the model created by the codegen.
  - registerServer
```
public boolean registerServer(boolean isOnline)
```
    Register the server on the DiscoveryServer at getDiscoveryServerUrl().
    Also if isDiscoveryEndpointEnabled() is true it registers the server in the internal DiscoveryServer, which is available from the same port as the server.
    The method does not raise any exceptions, contrary to registerServer(String, boolean), which does not use discoveryServerUrl.
    The method is called automatically from init(), start() and shutdown(int, LocalizedText).
    
    Parameters:
    
    isOnline - whether to register the server online or offline
    
    Returns:
    
    true if the registration succeeds, false if it fails or is skipped (DiscoveryServerUrl is not defined)
  - registerServer
```
public void registerServer(String discoveryUrl,
                           boolean isOnline)
                    throws UaServerException
```
    Register the server on a discovery server with RegisterServer2 and then with RegisterServer if RegisterServer2 fails.
    Note that you can also define the discoveryServerUrl to make the server register itself automatically on a discovery server.
    
    Parameters:
    
    discoveryUrl - the URL of the discovery server
    
    isOnline - whether to register online (server running) or offline
    
    Throws:
    
    UaServerException
    
    See Also:
    
    setDiscoveryServerUrl(java.lang.String)
  - removeEndpoint
```
public void removeEndpoint(String uri,
                           SecurityMode securityMode)
```
    Remove an endpoint definition for a specific URI & SecurityMode combination
    You should call addEnpoint after init() has been called.
    If you modify the list after calling start(), your list will not be up to date according to what is actually in use in the server.
    
    Parameters:
    
    uri - the server URI. Use UaApplication.formatUri(Protocol, String, int, String) to compose one.
    
    securityMode - The security mode of the endpoint
    
    See Also:
    
    addEndpoint(String, SecurityMode, UserTokenPolicy...)
  - removeEndpointHost
```
public void removeEndpointHost(String hostName)
```
    Removes all endpoints that use hostName - as defined by addEndpointHost(java.lang.String), or using the default HostName of the computer.
    
    Parameters:
    
    hostName - the hostName or IP address for which to remove all Endpoints. Corresponds to the host added with addEndpointHost
  - removeEndpoints
```
public void removeEndpoints(String uri)
```
    Removes all endpoints that have the given endpointUrl. Note that this method should be called after init(), otherwise it wont do anything. Also calling this after start() does not have effect on the bound endpoints.
    
    Parameters:
    
    uri - the given endpointUrl
  - removeLocale
```
public void removeLocale(Locale locale)
                  throws UaServerException
```
    Parameters:
    
    locale -
    
    Throws:
    
    UaServerException
  - removeReverseConnection
```
public void removeReverseConnection(ReverseConnectionParameters reverseConnectionParameters)
```
    Removes a previously added reverse connection. This method can be called while the server runs, the removed connection is not formed again until added via addReverseConnection(ReverseConnectionParameters) again. Please note that only ReverseConnectionParameters.getClientServerEndpointUrl() matters here and this method behaves the same as calling removeReverseConnection(String) with it.
    
    Parameters:
    
    reverseConnectionParameters - same as in a previous addReverseConnection(ReverseConnectionParameters) or ReverseConnectionParameters.equals(Object) to it (Note that that only depends on ReverseConnectionParameters.getClientServerEndpointUrl()).
  - removeReverseConnection
```
public void removeReverseConnection(String clientServerEndpointUrl)
```
    Removes a previously added reverse connection. This method can be called while the server runs, the removed connection is not formed again until added via addReverseConnection(String) again.
    
    Parameters:
    
    clientServerEndpointUrl - same as in a previous addReverseConnection(String, String)
  - removeReverseConnection
```
@Deprecated
public void removeReverseConnection(String clientServerEndpointUrl,
                                                 String endpointUrlForClientConnection)
```
    Deprecated. starting from SDK 5.1.0, the second parameter no longer has a meaning as ReverseConnectionParameters.equals(Object) is only based on the ReverseConnectionParameters.getClientServerEndpointUrl(). Thus, removeReverseConnection(String) should be used instead.
    
    Removes a previously added reverse connection. This method can be called while the server runs, the removed connection is not formed again until added via addReverseConnection(String, String) again.
    
    Parameters:
    
    clientServerEndpointUrl - same as in a previous addReverseConnection(String, String)
    
    endpointUrlForClientConnection - same as in a previous addReverseConnection(String, String)
  - removeUserTokenPolicy
```
public void removeUserTokenPolicy(UserTokenPolicy policy)
                           throws UaServerException
```
    Parameters:
    
    policy -
    
    Throws:
    
    UaServerException
  - requestServerStateChange
```
public boolean requestServerStateChange(ServiceContext serviceContext,
                                        ServerState state,
                                        DateTime estimatedReturnTime,
                                        UnsignedInteger secondsTillShutdown,
                                        LocalizedText reason,
                                        Boolean restart)
                                 throws StatusException
```
    Request a change in server state (shutdown or restart server).
    
    Parameters:
    
    serviceContext - calling context, including the session information, which defines the userIdentity
    
    state - the state in which the server will be
    
    estimatedReturnTime - the time in which the server is expected to be in running state
    
    secondsTillShutdown - the number of seconds until shutdown
    
    reason - reason for the request
    
    restart - a flag indicating whether the server will be restarted after shutdown
    
    Returns:
    
    a boolean value indicating whether the state change is allowed
    
    Throws:
    
    StatusException - StatusCodes.Bad_UserAccessDenied if the user is not authorized to request the state change
  - setApplicationIdentity
```
public void setApplicationIdentity(ApplicationIdentity identity)
```
    Define the application identity of the server. The identity should have the certificate initialized (for example, by creating the identity using ApplicationIdentity.loadOrCreateCertificate(com.prosysopc.ua.stack.core.ApplicationDescription, java.lang.String, java.lang.String, java.io.File, boolean, java.lang.String...)). Also make sure the the ApplicationDescription is set in the identity.
    
    Parameters:
    
    identity -
  - setBindAddresses
```
public void setBindAddresses(UaApplication.Protocol protocol,
                             Set<InetAddress> bindAddresses)
```
    Define the InetAddresses the server endpoints should be bound to. By default, the server is bound to all addresses as given by EndpointUtil.getInetAddresses(boolean enableIPv6), using the current value of isEnableIPv6().
    Use the method to make the server respond in only some of the available network interfaces.
    Default: Use what is available from EndpointUtil.getInetAddresses(boolean enableIPv6), using the current value of isEnableIPv6().
    
    Parameters:
    
    protocol - the protocol to which these addresses are used. Must not be null
    
    bindAddresses - the bindAddresses to set. If null, the protocol specific values are not to be used. The common values available from getBindAddresses() are to be used then.
  - setBindAddresses
```
public void setBindAddresses(Set<InetAddress> bindAddresses)
```
    Define the InetAddresses the server endpoints should be bound to. By default, the server is bound to all addresses as given by EndpointUtil.getInetAddresses(boolean enableIPv6), using the current value of isEnableIPv6().
    Use the method to make the server respond in only some of the available network interfaces.
    Default: Use what is available from EndpointUtil.getInetAddresses(boolean enableIPv6), using the current value of isEnableIPv6().
    
    Parameters:
    
    bindAddresses - the bindAddresses to set. Use null to reset to default value.
  - setDiscoveryEndpointEnabled
```
public void setDiscoveryEndpointEnabled(boolean discoveryEndpointEnabled)
```
    If this is set to false, the internal discovery server is not created and this server does not offer any Discovery Services, e.g. clients cannot make FindServers requests. Default value is true, i.e. the internal DiscoveryServer is created.
    
    Parameters:
    
    discoveryEndpointEnabled -
  - setDiscoveryServerAddress
```
public void setDiscoveryServerAddress(UaAddress discoveryServerAddress)
```
    Set DiscoveryServer address, same as setDiscoveryServerUrl, but this method does not throw exception as UaAddress instances have valid syntax.
    
    Parameters:
    
    discoveryServerAddress - the address
    
    See Also:
    
    setDiscoveryServerUrl(java.lang.String)
  - setDiscoveryServerRegistrationPeriod
```
public void setDiscoveryServerRegistrationPeriod(long discoveryServerRegistrationPeriod)
```
    Define the period used for re-registering to the Discovery Server.
    If the discoveryServerUrl is not defined or the period is set to 0, no periodic registration will take place.
    Default: 10 minutes
    
    Parameters:
    
    discoveryServerRegistrationPeriod - the period to set in minutes
    
    See Also:
    
    registerServer(boolean), setDiscoveryServerUrl(java.lang.String)
  - setDiscoveryServerRegistrationSecurityMode
```
public void setDiscoveryServerRegistrationSecurityMode(SecurityMode discoveryServerRegistrationSecurityMode)
```
    Define the SecurityMode to use when registering to the Discovery Server.
    Note that according to the OPC UA specification, only secure connections are enabled, but the actual mode to use may be configurable, depending on the actual Discovery Server installation.
    
    Default: SecurityMode.BASIC128RSA15_SIGN_ENCRYPT
    
    Parameters:
    
    discoveryServerRegistrationSecurityMode - the discoveryServerRegistrationSecurityMode to set
  - setDiscoveryServerUrl
```
public void setDiscoveryServerUrl(String discoveryServerUrl)
                           throws URISyntaxException
```
    Define the discovery server in which the server is registered automatically. Normally, this is the Local Discovery Server, at 'opc.tcp://localhost:4840'
    
    Parameters:
    
    discoveryServerUrl - the discoveryServerUrl to set
    
    Throws:
    
    URISyntaxException - if the url is not valid
    
    See Also:
    
    registerServer(boolean), setDiscoveryServerRegistrationPeriod(long), setDiscoveryServerAddress(com.prosysopc.ua.UaAddress)
  - setEnableIPv6
```
public void setEnableIPv6(boolean enableIPv6)
```
    Define whether to use IPv6 addresses. Windows requires Java 7 or newer in order to use IPv6. Default value true.
    
    Parameters:
    
    enableIPv6 - set true to enable or false to disable IPv6 networking.
  - setEndpointConfiguration
```
public void setEndpointConfiguration(EndpointConfiguration endpointConfiguration)
```
    Define the EndpointConfiguration to use for all default endpoints.
    
    Parameters:
    
    endpointConfiguration - the value to set. Use null to reset back to Endpoint.createDefaultEndpointConfiguration().
  - setFailOnBindError
```
public void setFailOnBindError(boolean failOnBindError)
```
    Define whether the server start() should fail, if any of the endpoint bindings fail.
    The property can be used to overcome problems in some hostname/IP address problems, in case the server tries to bind to invalid addresses, for example.
    The draw back is that if there is a server already bound to the address, the new one will start up, but never runs.
    Default: true
    
    Parameters:
    
    failOnBindError - the failOnBindError to set
  - setHttpsSecurityPolicies
```
public void setHttpsSecurityPolicies(HttpsSecurityPolicy... httpsSecurityPolicies)
                              throws UaServerException
```
    Define the security policies used for the HTTPS protocol.
    Default: HttpsSecurityPolicy.ALL
    
    Parameters:
    
    httpsSecurityPolicies - the httpsSecurityPolicies to set
    
    Throws:
    
    UaServerException - if the server is running
  - setHttpsSettings
```
public void setHttpsSettings(HttpsSettings httpsSettings)
```
    Parameters:
    
    httpsSettings - the httpsSettings to set
  - setHttpsWorkerThreadCount
```
public void setHttpsWorkerThreadCount(int httpsWorkerThreadCount)
```
    The number of worker threads to use for the HTTPS server. Defines how many worker threads are initialized to handle incoming HTTPS requests. Note that this does not limit the number of UA sessions, since all sessions will share these threads. The value must be defined before init() is called.
    Default: 10
    
    Parameters:
    
    httpsWorkerThreadCount - the httpsWorkerThreadCount to set
  - setListener
```
public void setListener(UaServerListener listener)
```
    Parameters:
    
    listener - the listener to set
  - setMaxOpcHttpsConnections
```
public void setMaxOpcHttpsConnections(Integer maxOpcHttpsConnections)
```
    Maximum number of concurrent opc.https connections. Must be larger than 0. NOTE! Changing this value after start() has been called has no effect unless the server is restarted. Default value: 'null', in which case the value from getSessionManager() is used (SessionManager.getMaxSessionCount()) as the limit.
  - setMaxOpcTcpConnections
```
public void setMaxOpcTcpConnections(Integer maxOpcTcpConnections)
```
    Maximum number of concurrent opc.tcp connections. Must be larger than 0. NOTE! Changing this value after start() has been called has no effect unless the server is restarted. Default value: 'null', in which case the value from getSessionManager() is used (SessionManager.getMaxSessionCount()) as the limit.
  - setPort
```
public void setPort(int port)
             throws UaServerException
```
    The port in which the server is listening to the OPC Binary protocol.
    The method equals to calling #setPort(Protocol, int) with Protocol.Opc.
    
    Parameters:
    
    port - The binary port number. If 0, the binary protocol is disabled. If -1, the OS will automatically select a free port. Do not use any of the standard port numbers used by well-known TCP/IP services. Recommended numbers start from 1024. 4840 is reserved for the Local Discovery Server, but if you do not intend to run one, you can bind your server in there.
    
    Throws:
    
    UaServerException - if the server isRunning already
  - setPort
```
public void setPort(UaApplication.Protocol protocol,
                    int port)
             throws UaServerException
```
    Define the TCP/IP port number for a specific protocol. This is used to initialize the endpoint URL. So the endpoint URLs are of the form "<protocol>://<host>:<port>/<servername>".
    It is also used to define which protocols are enabled in the server. If the value is 0, the specific protocol is disabled. By default the protocols are not defined.
    Setting port number to -1 will make the OS automatically select a free port, typically from the ephemeral port range.
    
    Parameters:
    
    protocol - the UA protocol for which the name is applied to
    
    port - the port number to set. If 0, the specific protocol is not enabled in the server. If -1, the OS will automatically select a free port.
    
    Throws:
    
    UaServerException - if the server isRunning already
  - setPubSubConfigurator
```
public void setPubSubConfigurator(PubSubConfigurator pubSubConfigurator)
```
  - setSecurityModes
```
@Deprecated
public void setSecurityModes(SecurityMode[] securityModes)
                                   throws UaServerException
```
    Deprecated. use getSecurityModes() and add to the set directly. This method replaces all existing ones.
    
    Define the supported SecurityModes.
    
    Parameters:
    
    securityModes - the securityMode to set
    
    Throws:
    
    UaServerException - if the server isRunning already
  - setServerName
```
public void setServerName(UaApplication.Protocol protocol,
                          String serverName)
                   throws UaServerException
```
    Define the server name for a specific protocol. This is appended to the endpoint URLs, in addition to the host name and port. So the endpoint URLs are of form "://:/".
    
    Parameters:
    
    protocol - the UA protocol for which the name is applied to
    
    serverName - the serverName to set. If null, then the specific value is reset and the default will be used.
    
    Throws:
    
    UaServerException - if the server isRunning already
    
    See Also:
    
    setServerName(String)
  - setServerName
```
public void setServerName(String serverName)
                   throws UaServerException
```
    Define the default server name. This is appended to the endpoint URLs, in addition to the host name and port. So the endpoint URLs are of form "://:/".
    The default value is used for all protocols, unless specific values are defined with #setServerName(Protocol, String)
    
    Parameters:
    
    serverName - the serverName to set
    
    Throws:
    
    UaServerException - if the server isRunning already
    
    See Also:
    
    setServerName(String)
  - setUseAllIpAddresses
```
@Deprecated
public void setUseAllIpAddresses(boolean useAllIpAddresses)
```
    Deprecated. The server is no longer defining endpoints for different IP addresses. Use setBindAddresses(Set) instead to define to which actual addresses the endpoints are bound to.
    
    Define that an endpoint URL should be defined for every IP Address defined for the server. By default the host name of the server is used in the endpoints only.
    Default: false.
    
    Parameters:
    
    useAllIpAddresses - if true, all IP addresses are added to endpointUrls
    
    See Also:
    
    setUseHostName(boolean), setUseCanonicalHostName(boolean), setUseLocalhost(boolean)
  - setUseCanonicalHostName
```
@Deprecated
public void setUseCanonicalHostName(boolean useCanonicalHostName)
```
    Deprecated. The server is no longer defining endpoints for different host names. Use setBindAddresses(Set) instead to define to which actual addresses the endpoints are bound to.
    
    Define whether InetAddress#getLocalHost().getCanonicalHostName() is added to the endpoints (getServerUris()).
    Depending on the Operating system, CanonicalHostName can contain the domain part of the host name or be without it.
    Default: true
    
    Parameters:
    
    useCanonicalHostName - the useCanonicalHostName to set
    
    See Also:
    
    setUseAllIpAddresses(boolean), setUseHostName(boolean), setUseLocalhost(boolean)
  - setUseHostName
```
@Deprecated
public void setUseHostName(boolean useHostName)
```
    Deprecated. The server is no longer defining endpoints for different host names. Use setBindAddresses(Set) instead to define to which actual addresses the endpoints are bound to.
    
    Define whether InetAddress.getLocalHost().getHostName() is added to the endpoints (getServerUris()).
    Depending on the Operating system, HostName can contain the domain part of the host name or be without it.
    Default: true
    
    Parameters:
    
    useHostName - the useHostName to set
    
    See Also:
    
    setUseAllIpAddresses(boolean), setUseCanonicalHostName(boolean), setUseLocalhost(boolean)
  - setUseLocalhost
```
@Deprecated
public void setUseLocalhost(boolean useLocalhost)
                                  throws UaServerException
```
    Deprecated.
    
    Add 'localhost' to the list of endpoints (getServerUris()).
    Default: false
    
    Parameters:
    
    useLocalhost - if true, 'localhost' will be added to the list of endpoints.
    
    Throws:
    
    UaServerException - if the server isRunning already
    
    See Also:
    
    setUseAllIpAddresses(boolean), setUseCanonicalHostName(boolean), setUseHostName(boolean)
  - setUserTokenPolicies
```
public void setUserTokenPolicies(UserTokenPolicy... userTokenPolicies)
                          throws UaServerException
```
    Define the supported UserTokenPolicies.
    
    Parameters:
    
    userTokenPolicies - the securityMode to set
    
    Throws:
    
    UaServerException - if the server isRunning already
  - setUserValidator
```
public void setUserValidator(UserValidator userValidator)
```
    Define your custom user validator to check the users that are logging in to the server.
    
    Parameters:
    
    userValidator - the validator to use. Set to null to accept all users.
  - shutdown
```
public void shutdown(int secondsTillShutdown,
                     LocalizedText shutdownReason)
```
    Shutdown the server. The clients are notified about the shutdown via ServerStatus. The method waits for secondsTillShutdown and then closes down all service managers and returns.
    
    Parameters:
    
    secondsTillShutdown - the delay after notifying the clients about the shutdown
    
    shutdownReason - the shutdown reason message provided for the clients
  - shutdown
```
public void shutdown(int secondsTillShutdown,
                     LocalizedText shutdownReason,
                     boolean closeServer)
```
    Shutdown the server. The clients are notified about the shutdown via ServerStatus. The method waits for secondsTillShutdown and then closes down all service managers and returns.
    
    Parameters:
    
    secondsTillShutdown - the delay after notifying the clients about the shutdown
    
    shutdownReason - the shutdown reason message provided for the clients
    
    closeServer - determine whether the server is also closed at the same. Use 'false' if you intend to restart the server again, by calling start(). It will leave the node managers intact, and they will not need to be re-initialized. Default is true.
  - shutdown
```
public void shutdown(int secondsTillShutdown,
                     String shutdownReason)
```
    Shutdown the server. The clients are notified about the shutdown via ServerStatus. The method waits for secondsTillShutdown and then closes down all service managers and returns.
    
    Parameters:
    
    secondsTillShutdown - the delay after notifying the clients about the shutdown
    
    shutdownReason - the shutdown reason message provided for the clients (without any locale information)
  - shutdown
```
public void shutdown(int secondsTillShutdown,
                     String shutdownReason,
                     boolean closeServer)
```
    Shutdown the server. The clients are notified about the shutdown via ServerStatus. The method waits for secondsTillShutdown and then closes down all service managers and returns.
    
    Parameters:
    
    secondsTillShutdown - the delay after notifying the clients about the shutdown
    
    shutdownReason - the shutdown reason message provided for the clients (without any locale information)
    
    closeServer - determine whether the server is also closed at the same. Use 'false' if you intend to restart the server again, by calling start(). It will leave the node managers intact, and they will not need to be re-initialized. Default is true.
  - start
```
public void start()
           throws UaServerException
```
    Starts the server using the current configuration. Calls init(), if it is not called. generally, you should call init, initialize your own server stuff, and call start.
    
    Throws:
    
    UaServerException - if the server fails to start.
    
    See Also:
    
    init(), close()
  - createAttributeServiceHandler
```
protected AttributeServiceHandler createAttributeServiceHandler()
```
    Creates the AttributeServiceHandler to use for the server. You can override the method to provide your own version of the handler.
  - createDiagnosticsManager
```
protected DiagnosticsManager createDiagnosticsManager()
```
  - createExecutor
```
protected ScheduledExecutorService createExecutor()
```
    This is called when a executor would be created for the UaServer. This can be overrided to change the default behavior that uses Executors.newSingleThreadScheduledExecutor().
    
    Returns:
    
    an executor
  - createLoopbackClient
```
protected UaLoopbackClient createLoopbackClient(Consumer<EndpointServiceRequest<?,?>> requestConsumer)
```
    Creates a new UaLoopbackClient using the given consumer. This method can be be used to override the UaLoopbackClient returned by getLoopbackClient().
    
    Parameters:
    
    requestConsumer - the EndpointServiceRequest Consumer
    
    Returns:
    
    UaLoopbackClient
  - createNewNodeManager
```
protected NodeManager createNewNodeManager(ServiceContext serviceContext,
                                           String namespaceUri)
                                    throws StatusException
```
    Creates a new node manager as a response to an AddNodes request with a NodeId that is not managed by any node managers, yet.
    It will call getListener().onCreateNewNodeManager() unless it is not set, in which case a new NodeManagerUaNode is created.
    
    Throws:
    
    StatusException
  - createNodeManagementServiceHandler
```
protected NodeManagementServiceHandler createNodeManagementServiceHandler()
```
    Return NodeManagementServiceHandler, this can be used to override the NodeManagementServiceHandler used by the server by returning a custom subtype.
  - createNodeManagerRoot
```
protected NodeManagerRoot createNodeManagerRoot()
```
    Return NodeManagerRoot, this can be used to override the NodeManagerRoot used by the server by returning a custom subtype.
  - createNodeManagerTable
```
protected NodeManagerTable createNodeManagerTable()
```
    Return NodeManagerTable, this can be used to override the NodeManagerTable used by the server by returning a custom subtype.
  - createNodeManagerUaServer
```
protected UaServer.NodeManagerUaServer createNodeManagerUaServer(String applicationUri)
```
    Return UaServer.NodeManagerUaServer, this can be used to override the UaServer.NodeManagerUaServer used by the server by returning a custom subtype. The returned NodeManagerUaServer (or subtype) shall use the given 'applicationUri' parameter as the NamespaceUri.
  - createSessionManager
```
protected SessionManager createSessionManager()
```
    Return SessionManager, this can be used to override the SessionManager used by the server by returning a custom subtype. The returned SessionManager shall use 'this' as the constructor parameter.
  - createSessionServiceHandler
```
protected SessionServiceHandler createSessionServiceHandler()
```
    Return SessionServiceHandler, this can be used to override the SessionServiceHandler used by the server by returning a custom subtype.
  - createSubscriptionManager
```
protected SubscriptionManager createSubscriptionManager()
```
    Return SubscriptionManager, this can be used to override the SubscriptionManager used by the server by returning a custom subtype.
  - createSubscriptionServiceHandler
```
protected SubscriptionServiceHandler createSubscriptionServiceHandler()
```
    Return SubscriptionServiceHandler, this can be used to override the SubscriptionServiceHandler used by the server by returning a custom subtype.
  - getDiscoveryServer
```
protected UaServer.DiscoveryServer getDiscoveryServer()
```
    Returns:
  - getDiscoveryUriOf
```
protected String getDiscoveryUriOf(String uri)
```
    Parameters:
    
    uri -
    
    Returns:
    
    Throws:
    
    IllegalArgumentException
  - getExecutor
```
protected ScheduledExecutorService getExecutor()
```
  - getHttpsPort
```
protected int getHttpsPort()
```
    Returns:
    
    the httpsPort
  - getHttpsSecurityPolicies
```
protected HttpsSecurityPolicy[] getHttpsSecurityPolicies()
```
    Returns:
    
    the httpsSecurityModes used for the HTTPS protocol
  - getServer
```
protected Server getServer()
```
    Returns:
    
    the server
  - initAggregateFunctions
```
protected void initAggregateFunctions()
```
    Initialize the Aggregate Functions under the ServerCapabilities node, from the AggregateCalculator.
  - initServerArray
```
protected void initServerArray()
                        throws UaServerException
```
    Throws:
    
    UaServerException
  - initServiceHandlers
```
protected void initServiceHandlers()
                            throws UaServerException
```
    Throws:
    
    UaServerException
  - logRegisterServerError
```
protected void logRegisterServerError(String discoveryServerUrl,
                                      boolean isOnline,
                                      UaServerException e)
```
    Parameters:
    
    isOnline -
    
    discoveryServerUrl -
    
    e -
  - registerServer
```
protected boolean registerServer(boolean isOnline,
                                 boolean callLDS)
```
    Same as registerServer(boolean), but allows skipping calling the LocalDiscoveryServer (with callLDS false).
  - setHttpsPort
```
protected void setHttpsPort(int httpsPort)
                     throws UaServerException
```
    Defines the IP port number to use for the HTTPS connection. If the value is not set, then HTTPS will not be available.
    The standard Internet port number for HTTPS is 443, but you should probably normally use a custom port number for the UA Server, unless you know that there is no other HTTPS server installed on the same computer.
    
    Parameters:
    
    httpsPort - the httpsPort to set
    
    Throws:
    
    UaServerException
  - shutdownBegin
```
protected void shutdownBegin(int secondsTillShutdown,
                             LocalizedText shutdownReason)
```
    Begin server shutdown process
    
    Parameters:
    
    secondsTillShutdown - seconds to wait until shutdown
    
    shutdownReason - reason for shutdown
  - shutdownEnd
```
protected void shutdownEnd(boolean closeServer)
```
    Complete the shutdown process
    
    Parameters:
    
    closeServer - whether the server is closed
  - shutdownSleep
```
protected void shutdownSleep(int secondsTillShutdown)
```
    Wait before completing shutdown
    
    Parameters:
    
    secondsTillShutdown - seconds to wait
  - updateNamespaceArray
```
protected void updateNamespaceArray()
```
  - updateServerArray
```
protected void updateServerArray()
                          throws StatusException
```
    Throws:
    
    StatusException
  - updateServerCapabilities
```
protected void updateServerCapabilities()
```
    Sets the ServerCabalitities, Updates Nodes below /Root/Objects/Server/ServerCapabilities/.
  - validateUserError
```
protected void validateUserError(Session session,
                                 UserIdentityToken userToken,
                                 Exception e)
```
    Parameters:
    
    session -
    
    userToken -
    
    e -
  - validateUserIdentity
```
protected boolean validateUserIdentity(Session session,
                                       ServerUserIdentity userIdentity)
                                throws StatusException
```
    Parameters:
    
    session -
    
    userIdentity -
    
    Returns:
    
    true if the user is valid.
    
    Throws:
    
    StatusException

Class UaServer

Nested Class Summary

Nested classes/interfaces inherited from class com.prosysopc.ua.UaApplication

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.prosysopc.ua.UaApplication

Methods inherited from class java.lang.Object

Field Detail

applicationIdentity

attributeServiceHandler

discoveryUris

httpsUris

listener

nodeManagerRoot

nodeManagerTable

nodeManagerUaServer

nodeServiceHandler

httpsSecurityModes

securityModes

serverUris

sessionManager

executor

sessionManagerListener

sessionServiceHandler

subscriptionManager

subscriptionServiceHandler

diagnosticsManager

Constructor Detail

UaServer

Method Detail

getEndpointSecurityLevel

toRegisteredServer

addEndpoint

addEndpointHost

addLocale

addReverseConnection

addReverseConnection

addReverseConnection

addServiceHandler

addToServerArray

addUserTokenPolicy

close

getAddressSpace

getApplicationIdentity

getAttributeServiceHandler

getBindAddresses

getBindAddresses

getDiagnosticsManager

getDiscoveryServerAddress

getDiscoveryServerRegistrationPeriod

getDiscoveryServerRegistrationSecurityMode

getDiscoveryServerUrl

getEncoderContext

getEndpoint

getEndpointConfiguration

getEndpointHosts

getEndpoints

getEndpoints

getHostNames

getHttpsSecurityModes

getHttpsSettings

getHttpsWorkerThreadCount

getListener

getLocales

getLoopbackClient

getMaxOpcHttpsConnections

getMaxOpcTcpConnections

getNodeManagementServiceHandler

getNodeManagerRoot

getNodeManagerTable

getNodeManagerUaServer

getPort

getPort

getPubSubConfigurator

getSecurityModes

getServerName

getServerName

getServerTable

getServerUris