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

java.lang.Object
- com.prosysopc.ua.UaAddress

```
public class UaAddress
extends Object
```
OPC UA Connection address.

Constructor Summary

Constructors
Constructor and Description
`UaAddress(String uri)` Deprecated. use `parse(String)` instead.
`UaAddress(UaApplication.Protocol protocol, String host, int port)` Deprecated. use `UaAddress#fromComponents(Protocol, String, int)` instead.
`UaAddress(UaApplication.Protocol protocol, String host, int port, String serverName)` Deprecated. use `UaAddress#fromComponents(Protocol, String, int, String)` instead.
`UaAddress(URI uri)` Deprecated. use `parse(URI)` instead.
`UaAddress(URL uri)` Deprecated. use `parse(URL)` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`equalsAddress(String uri)`
`static String`	`formatUri(UaApplication.Protocol protocol, String host, int port, String serverName)` Compose a valid OPCUA connection address from the parts.
`static UaAddress`	`fromComponents(UaApplication.Protocol protocol, String host, int port)` Creates UaAddress with the given components.
`static UaAddress`	`fromComponents(UaApplication.Protocol protocol, String host, int port, String serverName)` Creates a new UaAddress with the given components.
`String`	`getAddress()`
`static UaApplication.Protocol`	`getDefaultProtocol()`
`String`	`getHost()`
`int`	`getPort()`
`UaApplication.Protocol`	`getProtocol()`
`String`	`getServerName()`
`int`	`hashCode()`
`static UaAddress`	`parse(String address)` Create a new UaAddress from a string representation.
`static UaAddress`	`parse(URI uri)` Create a new UaAddress from an URI.
`static UaAddress`	`parse(URL url)` Create a new UaAddress from an URI.
`static void`	`setDefaultProtocol(UaApplication.Protocol defaultProtocol)`
`String`	`toString()`
`static void`	`validate(String address)` Validates that a string value is a valid OPC UA connection URI.
`static UaAddress`	`wildcardOpcTcp(int port)` Returns a wildcard address for the given port using opc.tcp protocol.
`static UaAddress`	`wildcardOpcTcpIPv4(int port)` Convenience factory method for creating an address opc.tcp://0.0.0.0:port where the port is the given port.
`static UaAddress`	`wildcardOpcTcpIPv6(int port)` Convenience factory method for creating an address opc.tcp://[::]:port where the port is the given port.

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

- Constructor Detail
  - UaAddress
```
@Deprecated
public UaAddress(UaApplication.Protocol protocol,
                              String host,
                              int port)
                       throws URISyntaxException
```
    Deprecated. use UaAddress#fromComponents(Protocol, String, int) instead.
    
    Create a new UaAddress using the address components.
    
    Throws:
    
    URISyntaxException
  - UaAddress
```
@Deprecated
public UaAddress(UaApplication.Protocol protocol,
                              String host,
                              int port,
                              String serverName)
                       throws URISyntaxException
```
    Deprecated. use UaAddress#fromComponents(Protocol, String, int, String) instead.
    
    Create a new UaAddress using the address components.
    
    Throws:
    
    URISyntaxException
  - UaAddress
```
@Deprecated
public UaAddress(String uri)
                       throws URISyntaxException
```
    Deprecated. use parse(String) instead.
    
    Create a new UaAddress using a string.
    
    Parameters:
    
    uri - The connection URI to be parsed.
    
    Throws:
    
    IllegalArgumentException - if the 'http' protocol is defined
    
    URISyntaxException - if the URI is not a valid URI
  - UaAddress
```
@Deprecated
public UaAddress(URI uri)
                       throws Exception
```
    Deprecated. use parse(URI) instead.
    
    Throws:
    
    Exception
  - UaAddress
```
@Deprecated
public UaAddress(URL uri)
                       throws Exception
```
    Deprecated. use parse(URL) instead.
    
    Throws:
    
    Exception
- Method Detail
  - formatUri
```
public static String formatUri(UaApplication.Protocol protocol,
                               String host,
                               int port,
                               String serverName)
```
    Compose a valid OPCUA connection address from the parts. The address will be in the format <protocol>://<host>:<port>/<serverName>, where the last slash ('/') is removed, if serverName is null or empty.
    
    Parameters:
    
    protocol - The OPC UA transport protocol.
    
    host - Host name or IP address of the computer.
    
    port - The TCP port number to connect to.
    
    serverName - An optional server name identifier.
    
    Returns:
    
    A string of the format <protocol>://<host>:<port>/<serverName>
  - fromComponents
```
public static UaAddress fromComponents(UaApplication.Protocol protocol,
                                       String host,
                                       int port)
```
    Creates UaAddress with the given components. The address will equal to the format defined by #formatUri(Protocol, String, int, String) where ServerName (the last String) is null.
  - fromComponents
```
public static UaAddress fromComponents(UaApplication.Protocol protocol,
                                       String host,
                                       int port,
                                       String serverName)
```
    Creates a new UaAddress with the given components. The address will equal to the format defined by #formatUri(Protocol, String, int, String)
  - getDefaultProtocol
```
public static UaApplication.Protocol getDefaultProtocol()
```
  - parse
```
public static UaAddress parse(String address)
```
    Create a new UaAddress from a string representation. Various elements of the expected string can be left undefined in which case predefined default values will be used instead. This can be very useful when prompting for the address from the user, for example.
    
    Parameters:
    
    address - The connection address. The address is expected to be in the format defined by #formatUri(Protocol, String, int, String) format <protocol>://<host>:<port>/<serverName>, where the last slash may be omitted, if serverName is empty.
    If <protocol>:// is missing, 'opc.tcp://' is used. If port number is missing, 4840 will be used for 'opc.tcp' and 4843 for 'opc.https'. 'http' is not accepted as a protocol, since it is a deprecated protocol and not supported.
    
    Throws:
    
    IllegalArgumentException - if address is not a valid OPC UA connection address.
  - parse
```
public static UaAddress parse(URI uri)
```
    Create a new UaAddress from an URI. Equals to calling parse(uri.toString()). See parse(String) for details.
    
    Throws:
    
    IllegalArgumentException - if address is not a valid OPC UA connection address.
  - parse
```
public static UaAddress parse(URL url)
```
    Create a new UaAddress from an URI. Equals to calling parse(uri.toString()). See parse(String) for details.
    
    Throws:
    
    IllegalArgumentException - if address is not a valid OPC UA connection address.
  - setDefaultProtocol
```
public static void setDefaultProtocol(UaApplication.Protocol defaultProtocol)
```
  - validate
```
public static void validate(String address)
                     throws URISyntaxException
```
    Validates that a string value is a valid OPC UA connection URI. Equals to calling parse(String), but raises URISyntaxException for invalid addresses.
    
    Parameters:
    
    address - the connection address to validate
    
    Throws:
    
    URISyntaxException - if the address is not a valid UaAddress
  - wildcardOpcTcp
```
public static UaAddress wildcardOpcTcp(int port)
```
    Returns a wildcard address for the given port using opc.tcp protocol. If running on Java 7 or later, this will return the same value as wildcardOpcTcpIPv6(int), otherwise returns wildcardOpcTcpIPv4(int).
  - wildcardOpcTcpIPv4
```
public static UaAddress wildcardOpcTcpIPv4(int port)
```
    Convenience factory method for creating an address opc.tcp://0.0.0.0:port where the port is the given port. This can be used for reverse connections to listen on all available network interfaces.
  - wildcardOpcTcpIPv6
```
public static UaAddress wildcardOpcTcpIPv6(int port)
```
    Convenience factory method for creating an address opc.tcp://[::]:port where the port is the given port. This can be used for reverse connections to listen on all available network interfaces. Unlike wildcardOpcTcpIPv4(int), this method will also bound on IPv6 address this machine has.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsAddress
```
public boolean equalsAddress(String uri)
```
  - getAddress
```
public String getAddress()
```
  - getHost
```
public String getHost()
```
    Returns:
    
    The IP address or hostname of the computer
  - getPort
```
public int getPort()
```
  - getProtocol
```
public UaApplication.Protocol getProtocol()
```
    Returns:
    
    The communication protocol
  - getServerName
```
public String getServerName()
```
    Returns:
    
    The server name part of the server URI
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class UaAddress

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UaAddress

UaAddress

UaAddress

UaAddress

UaAddress

Method Detail

formatUri

fromComponents

fromComponents

getDefaultProtocol

parse

parse

parse

setDefaultProtocol

validate

wildcardOpcTcp

wildcardOpcTcpIPv4

wildcardOpcTcpIPv6

equals

equalsAddress

getAddress

getHost

getPort

getProtocol

getServerName

hashCode

toString