org.opcfoundation.ua.core
Class EndpointDescription

java.lang.Object
  extended by org.opcfoundation.ua.utils.AbstractStructure
      extended by org.opcfoundation.ua.core.EndpointDescription
All Implemented Interfaces:
Cloneable, Structure, IEncodeable

public class EndpointDescription
extends AbstractStructure
implements Structure, Cloneable

Endpoint Description

See Also:
for utility methods

Field Summary
static ExpandedNodeId BINARY
           
protected  String EndpointUrl
           
static ExpandedNodeId ID
           
protected  UnsignedByte SecurityLevel
           
protected  MessageSecurityMode SecurityMode
           
protected  String SecurityPolicyUri
           
protected  ApplicationDescription Server
           
protected  ByteString ServerCertificate
           
protected  String TransportProfileUri
           
protected  UserTokenPolicy[] UserIdentityTokens
           
static ExpandedNodeId XML
           
 
Constructor Summary
EndpointDescription()
           
EndpointDescription(String EndpointUrl, ApplicationDescription Server, ByteString ServerCertificate, MessageSecurityMode SecurityMode, String SecurityPolicyUri, UserTokenPolicy[] UserIdentityTokens, String TransportProfileUri, UnsignedByte SecurityLevel)
           
 
Method Summary
 EndpointDescription clone()
          Deep clone
 boolean equals(Object obj)
           
 UserTokenPolicy findUserTokenPolicy(String policyId)
          Finds the user token policy with the specified id.
 UserTokenPolicy findUserTokenPolicy(UserTokenType type)
          Finds UserTokenPolicy of given type that this stack can encrypt
 ExpandedNodeId getBinaryEncodeId()
          getBinaryEncodeId.
 String getEndpointUrl()
           
 UnsignedByte getSecurityLevel()
           
 MessageSecurityMode getSecurityMode()
           
 String getSecurityPolicyUri()
           
 ApplicationDescription getServer()
           
 ByteString getServerCertificate()
           
 String getTransportProfileUri()
           
 ExpandedNodeId getTypeId()
          getTypeId.
 UserTokenPolicy[] getUserIdentityTokens()
           
 ExpandedNodeId getXmlEncodeId()
          getXmlEncodeId.
 int hashCode()
           
 boolean needsCertificate()
           
 void setEndpointUrl(String EndpointUrl)
           
 void setSecurityLevel(UnsignedByte SecurityLevel)
           
 void setSecurityMode(MessageSecurityMode SecurityMode)
           
 void setSecurityPolicyUri(String SecurityPolicyUri)
           
 void setServer(ApplicationDescription Server)
           
 void setServerCertificate(ByteString ServerCertificate)
           
 void setTransportProfileUri(String TransportProfileUri)
           
 void setUserIdentityTokens(UserTokenPolicy[] UserIdentityTokens)
           
 boolean supportsUserTokenType(EndpointDescription endpoint, UserTokenType type)
          Tests whether the stack and the endpoint supports given token type.
 String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final ExpandedNodeId ID

BINARY

public static final ExpandedNodeId BINARY

XML

public static final ExpandedNodeId XML

EndpointUrl

protected String EndpointUrl

Server

protected ApplicationDescription Server

ServerCertificate

protected ByteString ServerCertificate

SecurityMode

protected MessageSecurityMode SecurityMode

SecurityPolicyUri

protected String SecurityPolicyUri

UserIdentityTokens

protected UserTokenPolicy[] UserIdentityTokens

TransportProfileUri

protected String TransportProfileUri

SecurityLevel

protected UnsignedByte SecurityLevel
Constructor Detail

EndpointDescription

public EndpointDescription()

EndpointDescription

public EndpointDescription(String EndpointUrl,
                           ApplicationDescription Server,
                           ByteString ServerCertificate,
                           MessageSecurityMode SecurityMode,
                           String SecurityPolicyUri,
                           UserTokenPolicy[] UserIdentityTokens,
                           String TransportProfileUri,
                           UnsignedByte SecurityLevel)
Method Detail

getEndpointUrl

public String getEndpointUrl()

setEndpointUrl

public void setEndpointUrl(String EndpointUrl)

getServer

public ApplicationDescription getServer()

setServer

public void setServer(ApplicationDescription Server)

getServerCertificate

public ByteString getServerCertificate()

setServerCertificate

public void setServerCertificate(ByteString ServerCertificate)

getSecurityMode

public MessageSecurityMode getSecurityMode()

setSecurityMode

public void setSecurityMode(MessageSecurityMode SecurityMode)

getSecurityPolicyUri

public String getSecurityPolicyUri()

setSecurityPolicyUri

public void setSecurityPolicyUri(String SecurityPolicyUri)

getUserIdentityTokens

public UserTokenPolicy[] getUserIdentityTokens()

setUserIdentityTokens

public void setUserIdentityTokens(UserTokenPolicy[] UserIdentityTokens)

getTransportProfileUri

public String getTransportProfileUri()

setTransportProfileUri

public void setTransportProfileUri(String TransportProfileUri)

getSecurityLevel

public UnsignedByte getSecurityLevel()

setSecurityLevel

public void setSecurityLevel(UnsignedByte SecurityLevel)

clone

public EndpointDescription clone()
Deep clone

Specified by:
clone in interface Structure
Overrides:
clone in class AbstractStructure
Returns:
cloned EndpointDescription

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

supportsUserTokenType

public boolean supportsUserTokenType(EndpointDescription endpoint,
                                     UserTokenType type)
Tests whether the stack and the endpoint supports given token type. This verifies that the stack knows the encryption algorithms of the token type.

Parameters:
endpoint -
type -
Returns:
true, if token type is supported

findUserTokenPolicy

public UserTokenPolicy findUserTokenPolicy(UserTokenType type)
Finds UserTokenPolicy of given type that this stack can encrypt

Parameters:
type -
Returns:
user token policy or null

findUserTokenPolicy

public UserTokenPolicy findUserTokenPolicy(String policyId)
Finds the user token policy with the specified id.

Parameters:
policyId - policy id
Returns:
user token policy or null

getTypeId

public ExpandedNodeId getTypeId()
Description copied from interface: Structure

getTypeId.

Specified by:
getTypeId in interface Structure
Returns:
a ExpandedNodeId object.

getXmlEncodeId

public ExpandedNodeId getXmlEncodeId()
Description copied from interface: Structure

getXmlEncodeId.

Specified by:
getXmlEncodeId in interface Structure
Returns:
a ExpandedNodeId object.

getBinaryEncodeId

public ExpandedNodeId getBinaryEncodeId()
Description copied from interface: Structure

getBinaryEncodeId.

Specified by:
getBinaryEncodeId in interface Structure
Returns:
a ExpandedNodeId object.

toString

public String toString()
Overrides:
toString in class Object

needsCertificate

public boolean needsCertificate()


Copyright © 2018. All rights reserved.