.NET Based OPC UA Client/Server SDK  2.6.1.422
UnifiedAutomation.UaBase.EndpointDescription Class Reference

Describes an Endpoint for a Server More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 EndpointDescription ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 
 EndpointDescription (string endpointUrl)
 Initializes a new instance of the EndpointDescription class. More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Returns a System.String that represents this instance. More...
 
UserTokenPolicy FindUserTokenPolicy (string policyId)
 Finds the user token policy with the specified id. More...
 
UserTokenPolicy FindUserTokenPolicy (UserTokenType tokenType, XmlQualifiedName issuedTokenType)
 Finds a token policy that matches the user identity specified. More...
 
UserTokenPolicy FindUserTokenPolicy (UserTokenType tokenType, string issuedTokenType)
 Finds a token policy that matches the user identity specified. More...
 

Properties

string EndpointUrl [get, set]
 The URL for the Endpoint described. More...
 
ApplicationDescription Server [get, set]
 The description for the Server that the Endpoint belongs to. More...
 
byte[] ServerCertificate [get, set]
 The application instance certificate issued to the Server. More...
 
MessageSecurityMode SecurityMode [get, set]
 The type of security to apply to the messages. More...
 
string SecurityPolicyUri [get, set]
 The URI for SecurityPolicy to use when securing messages. More...
 
UserTokenPolicyCollection UserIdentityTokens [get, set]
 The user identity tokens that the Server will accept. More...
 
string TransportProfileUri [get, set]
 The URI of the Transport Profile supported by the Endpoint. More...
 
byte SecurityLevel [get, set]
 A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
object UserData [get, set]
 Gets or sets the user data. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

Describes an Endpoint for a Server

The description for an endpoint.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.EndpointDescription.EndpointDescription ( )
inline

The default constructor.

UnifiedAutomation.UaBase.EndpointDescription.EndpointDescription ( string  endpointUrl)
inline

Initializes a new instance of the EndpointDescription class.

Parameters
endpointUrlThe endpoint URL.

Member Function Documentation

UserTokenPolicy UnifiedAutomation.UaBase.EndpointDescription.FindUserTokenPolicy ( string  policyId)
inline

Finds the user token policy with the specified id.

UserTokenPolicy UnifiedAutomation.UaBase.EndpointDescription.FindUserTokenPolicy ( UserTokenType  tokenType,
XmlQualifiedName  issuedTokenType 
)
inline

Finds a token policy that matches the user identity specified.

UserTokenPolicy UnifiedAutomation.UaBase.EndpointDescription.FindUserTokenPolicy ( UserTokenType  tokenType,
string  issuedTokenType 
)
inline

Finds a token policy that matches the user identity specified.

virtual bool UnifiedAutomation.UaBase.EndpointDescription.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

override string UnifiedAutomation.UaBase.EndpointDescription.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.
string UnifiedAutomation.UaBase.EndpointDescription.ToString ( string  format,
IFormatProvider  formatProvider 
)
inline

Returns a System.String that represents this instance.

Parameters
formatThe format.
formatProviderThe format provider.
Returns
A System.String that represents this instance.

Property Documentation

string UnifiedAutomation.UaBase.EndpointDescription.EndpointUrl
getset

The URL for the Endpoint described.

byte UnifiedAutomation.UaBase.EndpointDescription.SecurityLevel
getset

A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server.

A value of 0 indicates that the EndpointDescription is not recommended and is only supported for backward compatibility.

A higher value indicates better security.

MessageSecurityMode UnifiedAutomation.UaBase.EndpointDescription.SecurityMode
getset

The type of security to apply to the messages.

A SecureChannel may have to be created even if the securityMode is NONE.

string UnifiedAutomation.UaBase.EndpointDescription.SecurityPolicyUri
getset

The URI for SecurityPolicy to use when securing messages.

ApplicationDescription UnifiedAutomation.UaBase.EndpointDescription.Server
getset

The description for the Server that the Endpoint belongs to.

byte [] UnifiedAutomation.UaBase.EndpointDescription.ServerCertificate
getset

The application instance certificate issued to the Server.

string UnifiedAutomation.UaBase.EndpointDescription.TransportProfileUri
getset

The URI of the Transport Profile supported by the Endpoint.

object UnifiedAutomation.UaBase.EndpointDescription.UserData
getset

Gets or sets the user data.

The user data.

UserTokenPolicyCollection UnifiedAutomation.UaBase.EndpointDescription.UserIdentityTokens
getset

The user identity tokens that the Server will accept.

The Client shall pass one of the UserIdentityTokens in the ActivateSession request.


The documentation for this class was generated from the following files: