C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaEndpointXml Class Reference

This class represent an UaEndpoint configured by the XML configuration file. More...

#include <serverconfigxml.h>

Inherits UaEndpoint.

Public Member Functions

 UaEndpointXml ()
 construction. More...
 
virtual ~UaEndpointXml ()
 destruction
 
UaStatus setXmlConfig (UaXmlElement &xmlElement, const UaString &sApplicationPath, const UaString &sConfigPath, ServerConfigXml *pServerConfig, bool &updatedConfiguration, bool allowDeprecatedPolicies)
 Init Endpoint with XML configuration. More...
 
- Public Member Functions inherited from UaEndpoint
 UaEndpoint ()
 construction
 
 UaEndpoint (const UaEndpoint &other)
 construction More...
 
virtual ~UaEndpoint ()
 destruction
 
UaEndpointoperator= (const UaEndpoint &other)
 Implements the operator = for UaEndpoint. More...
 
UaStatus setSerializerType (OpcUa_Endpoint_SerializerType eSerializerType)
 Set the serializer type used for the endpoint. More...
 
OpcUa_Endpoint_SerializerType eSerializerType () const
 Get the serializer type used for the endpoint. More...
 
void setEndpointUrl (UaString sEndpointUrl, OpcUa_Boolean useAlsoAsStackUrl)
 Set the URL used for the endpoint. More...
 
UaString sEndpointUrl () const
 Get the URL used for the endpoint. More...
 
void setAlternativeEndpointUrls (const UaStringArray &alternativeEndpointUrls)
 Set alternative Endpoint URL for the endpoint. More...
 
UaStringArray alternativeEndpointUrls () const
 Get the alternative Endpoint URLs configured for the endpoint. More...
 
void setStackEndpointUrl (UaString sStackEndpointUrl)
 Set the URL for the Endpoint used for the stack. More...
 
UaStatus addSecuritySetting (const UaEndpointSecuritySetting &endpointSecuritySetting)
 Add a security setting to the endpoint. More...
 
const
UaEndpointSecuritySettingArray
securitySettings () const
 Get the list of security settings. More...
 
OpcUa_Handle hPKIConfig () const
 Get the handle to the PKI configuration. More...
 
UaPkiProviderpkiProvider () const
 Get the PKI provider. More...
 
void setEndpointHandle (OpcUa_Endpoint endpoint)
 Set the Endpoint handle for the Endpoint opened with the stack. More...
 
OpcUa_Endpoint endpointHandle () const
 Get the URL used for the endpoint. More...
 
void setIsVisible (OpcUa_Boolean isVisible)
 Set the flag that indicates if the endpoint is contained in GetEndpoints. More...
 
OpcUa_Boolean isVisible () const
 Get the flag that indicates if the endpoint is contained in GetEndpoints. More...
 
void setIsDiscoveryUrl (OpcUa_Boolean isDiscoveryUrl)
 Set the flag that indicates if the endpoint URL is provided as discovery URL. More...
 
OpcUa_Boolean isDiscoveryUrl () const
 Get the flag that indicates if the endpoint URL is provided as discovery URL. More...
 
void setReturnOnlyOnEndpointUrlMatch (OpcUa_Boolean returnOnlyOnEndpointUrlMatch)
 Set the flag indicating if the endpoint is returned in discovery depending on EndpointUrl match. More...
 
OpcUa_Boolean returnOnlyOnEndpointUrlMatch () const
 Get the flag indicating if the endpoint is returned in discovery depending on EndpointUrl match. More...
 
void setPassword (const UaString &sPassword)
 Set the password to load a protected private key. More...
 
UaString sPassword () const
 Get the password to load a protected private key. More...
 
void setAutomaticallyTrustAllClientCertificates (OpcUa_Boolean automaticTrust)
 Sets the endpoint to automatically trust all client certificates. More...
 
OpcUa_Boolean automaticallyTrustAllClientCertificates () const
 Get the flag that indicates if the endpoint automatically trusts all client certificates. More...
 
void setProvisioningModeActive (OpcUa_Boolean isActive)
 Sets the endpoint provisioning mode active flag.
 
OpcUa_Boolean provisioningModeActive () const
 Get the flag that indicates if the endpoint is in Provisioning mode.
 
void setCreateSignatureWithChain (OpcUa_Boolean createSignatureWithChain)
 Sets the endpoint to calculate the server signature using the certificate chain if available. More...
 
OpcUa_Boolean createSignatureWithChain () const
 Get the flag that indicates if the endpoint uses a certificate chain to calculate the server signature. More...
 
void setDisableApplicationUriCheck (OpcUa_Boolean disableApplicationUriCheck)
 Flag used to disable the ApplicationUri match check between client certificate and parameter in CreateSession. More...
 
OpcUa_Boolean disableApplicationUriCheck () const
 Returns the flag used to disable the ApplicationUri match check between client certificate and parameter in CreateSession.
 
void setDisableUserTokenPolicyIdCheck (OpcUa_Boolean disableUserTokenPolicyIdCheck)
 Flag used to disable the UserToken PolicyId check in ActivateSession. More...
 
OpcUa_Boolean disableUserTokenPolicyIdCheck () const
 Returns the flag used to disable the UserToken PolicyId check in ActivateSession.
 
void setDisableNonceLengthCheck (OpcUa_Boolean disableNonceLengthCheck)
 Flag used to disable the client nonce length check in CreateSession. More...
 
void setDisableCertificateSignatureAlgorithmCheck (OpcUa_Boolean disableCertificateSignatureAlgorithmCheck)
 Flag used to disable the client certificate validation error BadSignatureAlgorithmNotAllowed. More...
 
void setDisableErrorCertificateKeyTooShort (OpcUa_Boolean disableErrorCertificateKeyTooShort)
 Flag used to disable the client certificate validation error BadCryptoKeyTooShort. More...
 
void setDisableErrorCertificateKeyTooLong (OpcUa_Boolean disableErrorCertificateKeyTooLong)
 Flag used to disable the client certificate validation error BadCryptoKeyTooLong. More...
 
void setDisableCertificateUsageCheck (OpcUa_Boolean disableCertificateUsageCheck)
 Flag used to disable the client certificate validation error BadCertificateUseNotAllowed. More...
 
void setDisableErrorCertificateTimeInvalid (OpcUa_Boolean disableErrorCertificateTimeInvalid)
 Flag used to disable the client certificate validation error BadCertificateTimeInvalid. More...
 
void setDisableErrorCertificateIssuerTimeInvalid (OpcUa_Boolean disableErrorCertificateIssuerTimeInvalid)
 Flag used to disable the client certificate validation error BadCertificateIssuerTimeInvalid. More...
 
void setDisableErrorCertificateRevocationUnknown (OpcUa_Boolean disableErrorCertificateRevocationUnknown)
 Flag used to disable the client certificate validation error BadCertificateRevocationUnknown. More...
 
void setDisableErrorCertificateIssuerRevocationUnknown (OpcUa_Boolean disableErrorCertificateIssuerRevocationUnknown)
 Flag used to disable the client certificate validation error BadCertificateIssuerRevocationUnknown. More...
 
void setIsTransparentRedundant (OpcUa_Boolean isTransparentRedundant)
 Set the flag that indicates if the endpoint support transparent redundancy. More...
 
OpcUa_Boolean isTransparentRedundant () const
 Get the flag that indicates if the endpoint support transparent redundancy. More...
 
void setReverseConnectUrls (const UaStringArray &arrayReverseConnectUrls)
 Sets the array of URLs used to create reverse connections to clients. More...
 
void addReverseConnectUrl (const UaString &reverseConnectUrl)
 Adds a reverse connection to the list of reverse connections to clients.
 
void getReverseConnectUrls (UaStringArray &arrayReverseConnectUrls) const
 Get the array of URLs used to create reverse connections to clients.
 
OpcUa_UInt32 endpointCertificateStoreIndex () const
 Returns the index of the CertificateSore used for the endpoint.
 
CertificateStoreConfigurationpEndpointCertificateStore () const
 Returns the CertificateStoreConfiguration object for the endpoint.
 
CertificateConfigurationpEndpointCertificateSettings () const
 Returns the CertificateConfiguration object for the endpoint.
 
UaStatus loadCertificate ()
 Load the configured certificate. More...
 
virtual bool certificateVerificationError (OpcUa_Void *pvVerifyContext, const UaByteString &certificateChain, OpcUa_StatusCode uVerificationResult, OpcUa_UInt32 uDepth)
 Callback method to inform about errors during certificate validation. More...
 

Detailed Description

This class represent an UaEndpoint configured by the XML configuration file.

Constructor & Destructor Documentation

UaEndpointXml::UaEndpointXml ( )
inline

construction.

Member Function Documentation

UaStatus UaEndpointXml::setXmlConfig ( UaXmlElement xmlElement,
const UaString sApplicationPath,
const UaString sConfigPath,
ServerConfigXml pServerConfig,
bool &  updatedConfiguration,
bool  allowDeprecatedPolicies 
)

Init Endpoint with XML configuration.

Parameters
xmlElementa reference to the xml Element.
sApplicationPaththe path to the application.
sConfigPaththe path to the configuration files.
pServerConfiga pointer to the server config struct.
updatedConfigurationindicates if the thumbprint is updated in the ServerConfig.xml
Returns
the OPC UA Status code.

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