UA Server SDK C++ Bundle  1.4.0.258
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UaEndpointXml Class Reference

This class represent an UaEntpoint 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, ServerConfig *pServerConfig, bool &updatedConfiguration)
 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 setStackEndpointUrl (UaString sStackEndpointUrl)
 Set the URL for the Endpoint used for the stack. More...
 
UaString sStackEndpointUrl () const
 
UaStatus addSecuritySetting (const UaEndpointSecuritySetting &endpointSecuritySetting)
 Add a security setting to the endpoint. More...
 
const
UaEndpointSecuritySettingArray
securitySettings () const
 Get the list of security settings. More...
 
void setPkiConfiguration (const UaByteString &serverCertificate, const UaByteString &serverPrivateKey, UaPkiProvider *pPkiProvider)
 Set PKI configuration and Endpoint certificate. 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 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 setDisableApplicationUriCheck (OpcUa_Boolean disableApplicationUriCheck)
 Flag used to disable the ApplicationUri match check between client certificate and parameter in CreateSession. More...
 
OpcUa_Boolean disableApplicationUriCheck () const
 
void setDisableNonceLengthCheck (OpcUa_Boolean disableNonceLengthCheck)
 Flag used to disable the client nonce length check in CreateSession. More...
 
OpcUa_Boolean disableNonceLengthCheck () const
 
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 setEndpointIndex (OpcUa_UInt32 index)
 
OpcUa_UInt32 endpointIndex () const
 
void setOpened (bool isOpened)
 
bool isOpened () const
 
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from UaEndpoint
static void openSSLStoreCreateDirectories (const UaString &sTrustListLocation, const UaString &sRevocationListLocation, const UaString &sIssuersCertificatesLocation, const UaString &sIssuersRevocationListLocation, const UaString &sServerCertificate, const UaString &sPrivateKey)
 
static void openSSLStoreCreateCertificate (const UaString &sHostName, const UaString &sServerUri, const UaString &sCommonName, const UaString &sOrganization, const UaString &sOrganizationUnit, const UaString &sLocality, const UaString &sState, const UaString &sCountry, OpcUa_Int32 yearsValid, OpcUa_Int32 keyLength, const UaString &sServerCertificate, const UaString &sPrivateKey)
 
- Public Attributes inherited from UaEndpoint
UaByteString m_serverCertificate
 
UaByteString m_serverPrivateKey
 
- Protected Attributes inherited from UaEndpoint
OpcUa_Endpoint_SerializerType m_eSerializerType
 
UaString m_sEndpointUrl
 
UaString m_sStackEndpointUrl
 
UaEndpointSecuritySettingArray m_securitySettings
 
OpcUa_Endpoint m_endpoint
 
UaPkiProviderm_pPkiProvider
 
OpcUa_Boolean m_isVisible
 
OpcUa_Boolean m_isDiscoveryUrl
 
OpcUa_Boolean m_automaticallyTrustAllClientCertificates
 
OpcUa_Boolean m_disableApplicationUriCheck
 
OpcUa_Boolean m_disableNonceLengthCheck
 
OpcUa_Boolean m_disableErrorCertificateTimeInvalid
 
OpcUa_Boolean m_disableErrorCertificateIssuerTimeInvalid
 
OpcUa_Boolean m_disableErrorCertificateRevocationUnknown
 
OpcUa_Boolean m_disableErrorCertificateIssuerRevocationUnknown
 
OpcUa_Boolean m_isTransparentRedundant
 
OpcUa_UInt32 m_index
 
bool m_isOpened
 

Detailed Description

This class represent an UaEntpoint 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,
ServerConfig pServerConfig,
bool &  updatedConfiguration 
)

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: