com.prosysopc.ua.stack.utils

Class EndpointUtil

java.lang.Object

com.prosysopc.ua.stack.utils.EndpointUtil

public class EndpointUtil
extends Object

Discovery client enumerates endpoints. Current version supports only opc.tcp protocol.

Constructor Summary

Constructors

Constructor and Description
EndpointUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	containsSecureUserTokenPolicy(UserTokenPolicy[] userIdentityTokens) containsSecureUserTokenPolicy.
static UserIdentityToken	createAnonymousIdentityToken(EndpointDescription ep) Create anonymous user identity token
static UserIdentityToken	createIssuedIdentityToken(EndpointDescription ep, ByteString senderNonce, byte[] issuedIdentityToken) Create user identity token based on an issued token.
static UserIdentityToken	createUserNameIdentityToken(EndpointDescription ep, ByteString senderNonce, String username, String password) Create user identity token based on username and password
static X509IdentityToken	createX509IdentityToken(EndpointDescription ep, ByteString serverNonce, Cert certificate, PrivateKey key, SignatureData signatureData) createX509IdentityToken.
static UserTokenPolicy	findUserTokenPolicy(EndpointDescription endpointDescription, String policyId) Finds the user token policy with the specified id in the given EndpointDescription.
static UserTokenPolicy	findUserTokenPolicy(EndpointDescription endpointDescription, UserTokenType type) Finds UserTokenPolicy of given type that this stack can encrypt in the given EndpointDescription.
static String	getHostname() Figure out some random hostname for this computer
static Set<InetAddress>	getInetAddresses() Get all Internet addresses of this computer.
static Set<InetAddress>	getInetAddresses(boolean enableIPv6) Get all Internet addresses of this computer.
static Set<String>	getInetAddressNames() Get all internet address names of this computer.
static String	inetAddressToName(InetAddress addr) inetAddressToName.
static boolean	needsCertificate(EndpointDescription endpointDescription) Returns true if the given EndpointDescription indicates it needs a Certificate to work.
static void	reverse(Object array) Reverse elements of an array
static EndpointDescription	select(EndpointDescription[] endpoints) Select an endpoint that is supported by the stack and has the highest security level.
static EndpointDescription[]	select(EndpointDescription[] searchSet, int minKeySize, int maxKeySize) select.
static EndpointDescription	select(EndpointDescription[] endpoints, String url) select.
static EndpointDescription[]	select(EndpointDescription[] searchSet, String url, String protocol, MessageSecurityMode mode, SecurityPolicy policy, byte[] serverCertificate) Filter endpoints by various criteria
static EndpointDescription[]	selectByMessageSecurityMode(EndpointDescription[] searchSet, MessageSecurityMode mode) Selects all endpoints that conform to given message security mode
static EndpointDescription[]	selectByProtocol(EndpointDescription[] searchSet, String protocol) Selects all endpoints that conform to given protcol
static EndpointDescription[]	selectBySecurityPolicy(EndpointDescription[] searchSet, SecurityPolicy policy) Selects all endpoints that conform to given message security mode
static EndpointDescription[]	selectByUrl(EndpointDescription[] searchSet, String url) Selects all endpoints with the given url.
static EndpointDescription	selectEndpoint(EndpointDescription[] endpoints) Select the most suitable endpoint.
static EndpointDescription[]	sortBySecurityLevel(EndpointDescription[] set) Sorts endpoints by their security level.
static boolean	supportsUserTokenType(EndpointDescription endpoint, UserTokenType type) Tests whether the stack and the given EndpointDescription supports given token type.
static List<SocketAddress>	toSocketAddresses(String endpointUrl) Convert endpoint url to socket addresses.
static List<SocketAddress>	toSocketAddresses(String endpointUrl, boolean enableIPv6) Convert endpoint url to socket addresses.
static boolean	urlEqualsHostIgnoreCase(String endpointUrl, String url) Returns true only if both are valid OPC UA addresses and are the same address, ignoring host part and using equalsIgnoreCase for the server name.
static boolean	urlEqualsHostIgnoreCase(URI uri, URI requestedUri) Deprecated. use urlEqualsHostIgnoreCase(String, String) instead, URI has known issues (at the time of writing this) and cannot parse an IPv6 address that has a scope id that has a hyphen.
static boolean	urlEqualsProtocolAndServerNameIgnoringCase(String endpointUrl, String url) Returns true only if both are valid OPC UA addresses and are the same address, ignoring host and port part and using equalsIgnoreCase for the server name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EndpointUtil

public EndpointUtil()

Method Detail

containsSecureUserTokenPolicy

public static boolean containsSecureUserTokenPolicy(UserTokenPolicy[] userIdentityTokens)

containsSecureUserTokenPolicy.

Parameters:

userIdentityTokens - an array of UserTokenPolicy objects.

Returns:

a boolean.

createAnonymousIdentityToken

public static UserIdentityToken createAnonymousIdentityToken(EndpointDescription ep)
                                                      throws ServiceResultException

Create anonymous user identity token

Parameters:

ep - a EndpointDescription object.

Returns:

user identity token

Throws:

ServiceResultException - if endpoint or the stack doesn't support Anonymous token policy

createIssuedIdentityToken

public static UserIdentityToken createIssuedIdentityToken(EndpointDescription ep,
                                                          ByteString senderNonce,
                                                          byte[] issuedIdentityToken)
                                                   throws ServiceResultException

Create user identity token based on an issued token.

Parameters:

ep - a EndpointDescription object.

senderNonce - an array of byte.

issuedIdentityToken - an array of byte.

Returns:

user identity token

Throws:

ServiceResultException - if endpoint or the stack doesn't support UserName token policy

createUserNameIdentityToken

public static UserIdentityToken createUserNameIdentityToken(EndpointDescription ep,
                                                            ByteString senderNonce,
                                                            String username,
                                                            String password)
                                                     throws ServiceResultException

Create user identity token based on username and password

Parameters:

ep - a EndpointDescription object.

username - a String object.

password - a String object.

senderNonce - an array of byte.

Returns:

user identity token

Throws:

ServiceResultException - if endpoint or the stack doesn't support UserName token policy

createX509IdentityToken

public static X509IdentityToken createX509IdentityToken(EndpointDescription ep,
                                                        ByteString serverNonce,
                                                        Cert certificate,
                                                        PrivateKey key,
                                                        SignatureData signatureData)
                                                 throws ServiceResultException

createX509IdentityToken.

Parameters:

ep - a EndpointDescription object.

serverNonce - an array of byte.

certificate - a Cert object.

key - a PrivateKey object.

signatureData - a SignatureData object.

Returns:

a X509IdentityToken object.

Throws:

ServiceResultException - if any.

findUserTokenPolicy

public static UserTokenPolicy findUserTokenPolicy(EndpointDescription endpointDescription,
                                                  String policyId)

Finds the user token policy with the specified id in the given EndpointDescription.

Parameters:

endpointDescription - the EndpointDescription.

policyId - policy id to find

Returns:

user token policy or null if not found

findUserTokenPolicy

public static UserTokenPolicy findUserTokenPolicy(EndpointDescription endpointDescription,
                                                  UserTokenType type)

Finds UserTokenPolicy of given type that this stack can encrypt in the given EndpointDescription.

Parameters:

the - EndpointDescription.

type - to find

Returns:

user token policy or null

getHostname

public static String getHostname()
                          throws SocketException

Figure out some random hostname for this computer

Returns:

a String object.

Throws:

SocketException - if any.

getInetAddresses

public static Set<InetAddress> getInetAddresses()
                                         throws SocketException

Get all Internet addresses of this computer. Excludes IPv6 addresses.

Returns:

all Internet addresses of this computer.

Throws:

SocketException - if any.

getInetAddresses

public static Set<InetAddress> getInetAddresses(boolean enableIPv6)
                                         throws SocketException

Get all Internet addresses of this computer.

Parameters:

enableIPv6 - Set true to enable IPv6 addressing. Requires Java 7 or later on Windows platforms.

Returns:

all Internet addresses of this computer

Throws:

SocketException - if any.

getInetAddressNames

public static Set<String> getInetAddressNames()
                                       throws SocketException

Get all internet address names of this computer.

Returns:

all internet address names of this computer in URL compatible format

Throws:

SocketException - if any.

inetAddressToName

public static String inetAddressToName(InetAddress addr)

inetAddressToName.

Parameters:

addr - a InetAddress object.

Returns:

a String object.

needsCertificate

public static boolean needsCertificate(EndpointDescription endpointDescription)

Returns true if the given EndpointDescription indicates it needs a Certificate to work.

reverse

public static void reverse(Object array)

Reverse elements of an array

Parameters:

array - a Object object.

select

public static EndpointDescription select(EndpointDescription[] endpoints)
                                  throws ServiceResultException

Select an endpoint that is supported by the stack and has the highest security level.

Parameters:

endpoints - an array of EndpointDescription objects.

Returns:

encrypted endpoint

Throws:

ServiceResultException - error

select

public static EndpointDescription[] select(EndpointDescription[] searchSet,
                                           int minKeySize,
                                           int maxKeySize)

select.

Parameters:

searchSet - an array of EndpointDescription objects.

minKeySize - a int.

maxKeySize - a int.

Returns:

an array of EndpointDescription objects.

select

public static EndpointDescription select(EndpointDescription[] endpoints,
                                         String url)
                                  throws ServiceResultException

select.

Parameters:

endpoints - an array of EndpointDescription objects.

url - a String object.

Returns:

a EndpointDescription object.

Throws:

ServiceResultException - if any.

select

public static EndpointDescription[] select(EndpointDescription[] searchSet,
                                           String url,
                                           String protocol,
                                           MessageSecurityMode mode,
                                           SecurityPolicy policy,
                                           byte[] serverCertificate)

Filter endpoints by various criteria

Parameters:

searchSet - set of endpoints

url - filter by url (inclusive, case insensitive) or null

protocol - filter by protocol (inclusive) or null

mode - filter by mode or null

policy - filter by policy or null

serverCertificate - an array of byte.

Returns:

filtered endpoints

selectByMessageSecurityMode

public static EndpointDescription[] selectByMessageSecurityMode(EndpointDescription[] searchSet,
                                                                MessageSecurityMode mode)

Selects all endpoints that conform to given message security mode

Parameters:

searchSet - an array of EndpointDescription objects.

mode - a MessageSecurityMode object.

Returns:

A subset of searchSet whose elements use given message security mode

selectByProtocol

public static EndpointDescription[] selectByProtocol(EndpointDescription[] searchSet,
                                                     String protocol)

Selects all endpoints that conform to given protcol

Parameters:

searchSet - an array of EndpointDescription objects.

protocol - a String object.

Returns:

A subset of searchSet whose elements use given protocol

selectBySecurityPolicy

public static EndpointDescription[] selectBySecurityPolicy(EndpointDescription[] searchSet,
                                                           SecurityPolicy policy)

Selects all endpoints that conform to given message security mode

Parameters:

searchSet - an array of EndpointDescription objects.

policy - a SecurityPolicy object.

Returns:

A subset of searchSet whose elements use given message security mode

selectByUrl

public static EndpointDescription[] selectByUrl(EndpointDescription[] searchSet,
                                                String url)

Selects all endpoints with the given url. Compare is case-insensitive.

Parameters:

searchSet - an array of urls

url - a String object.

Returns:

A subset of searchSet whose elements use given message security mode

selectEndpoint

public static EndpointDescription selectEndpoint(EndpointDescription[] endpoints)

Select the most suitable endpoint.

Selection uses the following precedence: 1) Protocol must be opc.tcp (as http is not implemented) 2) Security uses sign and encrypt 3) Select highest security level (determined by the server) 4) Prefer hostname over localhost

Parameters:

endpoints - an array of EndpointDescription objects.

Returns:

compatible endpoint or null

sortBySecurityLevel

public static EndpointDescription[] sortBySecurityLevel(EndpointDescription[] set)

Sorts endpoints by their security level. The highest security level last.

Parameters:

set - set of endpoints

Returns:

sorted array of endpoints

supportsUserTokenType

public static boolean supportsUserTokenType(EndpointDescription endpoint,
                                            UserTokenType type)

Tests whether the stack and the given EndpointDescription supports given token type. This verifies that the stack knows the encryption algorithms of the token type.

Parameters:

endpoint - the EndpointDescription

type - the type

Returns:

true, if token type is supported

toSocketAddresses

public static List<SocketAddress> toSocketAddresses(String endpointUrl)
                                             throws IllegalArgumentException

Convert endpoint url to socket addresses.

Parameters:

endpointUrl - a String object.

Returns:

a collection of bind addresses

Throws:

IllegalArgumentException - endpointUrl is problematic some way

toSocketAddresses

public static List<SocketAddress> toSocketAddresses(String endpointUrl,
                                                    boolean enableIPv6)
                                             throws IllegalArgumentException

Convert endpoint url to socket addresses.

Parameters:

endpointUrl - a String object.

enableIPv6 - Set true to enable IPv6 addressing. Requires Java 7 or later on Windows platforms.

Returns:

a collection of bind addresses

Throws:

IllegalArgumentException - endpointUrl is problematic some way

urlEqualsHostIgnoreCase

public static boolean urlEqualsHostIgnoreCase(String endpointUrl,
                                              String url)

Returns true only if both are valid OPC UA addresses and are the same address, ignoring host part and using equalsIgnoreCase for the server name. Otherwise returns false.

urlEqualsHostIgnoreCase

@Deprecated
public static boolean urlEqualsHostIgnoreCase(URI uri,
                                                           URI requestedUri)

Deprecated. use urlEqualsHostIgnoreCase(String, String) instead, URI has known issues (at the time of writing this) and cannot parse an IPv6 address that has a scope id that has a hyphen.

Check if the endpointUrl matches the url, except for the hostname part.

Parameters:

uri - a URI object.

requestedUri - a URI object.

Returns:

a boolean.

urlEqualsProtocolAndServerNameIgnoringCase

public static boolean urlEqualsProtocolAndServerNameIgnoringCase(String endpointUrl,
                                                                 String url)

Returns true only if both are valid OPC UA addresses and are the same address, ignoring host and port part and using equalsIgnoreCase for the server name. Otherwise returns false.