C++ Based OPC UA Client/Server SDK  1.5.5.355
OpcUa::ServerConfigurationType Class Reference

Class implementing the UaObject interface for the ServerConfigurationType. More...

#include <opcua_serverconfigurationtype.h>

Inherits OpcUa::ServerConfigurationTypeBase.

Public Member Functions

 ServerConfigurationType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class ServerConfigurationType. More...
 
 ServerConfigurationType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class ServerConfigurationType. More...
 
 ServerConfigurationType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class ServerConfigurationType with all components. More...
 
void initialize ()
 Initializes the object and its dependencies.
 
void setCertificateStoreConfiguration (const UaString &sServerRejectedList, const CertificateStoreConfigurationPArray &certificateStores, NodeAccessInfo *pAccessInfoSecurityAdmin, CertificateStoreConfiguration *pUserCertificateStore)
 Sets the certificate store configurations. More...
 
virtual UaStatus ApplyChanges (const ServiceContext &serviceContext)
 Used to tell the Server to apply any security changes. More...
 
virtual UaStatus CreateSigningRequest (const ServiceContext &serviceContext, const UaNodeId &CertificateGroupId, const UaNodeId &CertificateTypeId, const UaString &SubjectName, OpcUa_Boolean RegeneratePrivateKey, UaByteString &Nonce, UaByteString &CertificateRequest)
 Asks the Server to create a PKCS #10 DER encoded certificate request that is signed with the Server’s private key. More...
 
virtual UaStatus GetRejectedList (const ServiceContext &serviceContext, UaByteStringArray &Certificates)
 Returns the list of Certificates that have been rejected by the Server. More...
 
virtual UaStatus UpdateCertificate (const ServiceContext &serviceContext, const UaNodeId &CertificateGroupId, const UaNodeId &CertificateTypeId, UaByteString &Certificate, const UaByteStringArray &IssuerCertificates, const UaString &PrivateKeyFormat, UaByteString &PrivateKey, OpcUa_Boolean &ApplyChangesRequired)
 Used to update a certificate for a Server. More...
 
- Public Member Functions inherited from OpcUa::ServerConfigurationTypeBase
 ServerConfigurationTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an ServerConfigurationType object using an instance declaration node as base.
 
 ServerConfigurationTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an ServerConfigurationType object.
 
 ServerConfigurationTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class ServerConfigurationTypeBase with all components. More...
 
virtual UaNodeId typeDefinitionId () const
 Returns the type definition NodeId for the ServerConfigurationType.
 
virtual UaStatus beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments)
 Call method of an UA object. More...
 
virtual UaStatus call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag)
 Synchronous version of the MethodManager method call executed in a worker thread.
 
virtual void setMaxTrustListSize (OpcUa_UInt32 MaxTrustListSize)
 Sets the MaxTrustListSize value. More...
 
virtual OpcUa_UInt32 getMaxTrustListSize () const
 Returns the value of MaxTrustListSize. More...
 
virtual void setMulticastDnsEnabled (OpcUa_Boolean MulticastDnsEnabled)
 Sets the MulticastDnsEnabled value. More...
 
virtual OpcUa_Boolean getMulticastDnsEnabled () const
 Returns the value of MulticastDnsEnabled. More...
 
virtual void setServerCapabilities (const UaStringArray &ServerCapabilities)
 Sets the ServerCapabilities. More...
 
virtual void getServerCapabilities (UaStringArray &ServerCapabilities) const
 Gets the ServerCapabilities. More...
 
virtual void setSupportedPrivateKeyFormats (const UaStringArray &SupportedPrivateKeyFormats)
 Sets the SupportedPrivateKeyFormats. More...
 
virtual void getSupportedPrivateKeyFormats (UaStringArray &SupportedPrivateKeyFormats) const
 Gets the SupportedPrivateKeyFormats. More...
 
virtual
OpcUa::CertificateGroupFolderType
getCertificateGroups ()
 Returns the CertificateGroups node. More...
 
virtual OpcUa::PropertyTypegetMaxTrustListSizeNode ()
 Returns the MaxTrustListSize node. More...
 
virtual OpcUa::PropertyTypegetMulticastDnsEnabledNode ()
 Returns the MulticastDnsEnabled node. More...
 
virtual OpcUa::PropertyTypegetServerCapabilitiesNode ()
 Returns the ServerCapabilities node. More...
 
virtual OpcUa::PropertyTypegetSupportedPrivateKeyFormatsNode ()
 Returns the SupportedPrivateKeyFormats node. More...
 
virtual OpcUa::BaseMethodgetApplyChanges ()
 Returns the ApplyChanges node.
 
virtual OpcUa::BaseMethodgetCreateSigningRequest ()
 Returns the CreateSigningRequest node.
 
virtual OpcUa::BaseMethodgetGetRejectedList ()
 Returns the GetRejectedList node.
 
virtual OpcUa::BaseMethodgetUpdateCertificate ()
 Returns the UpdateCertificate node.
 
virtual void useAccessInfoFromType ()
 Applys the NodeAccessInfo set at the ServerConfigurationTypeBase and its children. More...
 
void useAccessInfoFromInstance (ServerConfigurationTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- Public Member Functions inherited from OpcUa::BaseObjectType
 BaseObjectType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
 BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
UaReferenceListsgetUaReferenceLists () const
 Get the UaReferenceLists interface for the node. More...
 
virtual UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
UaNodeId nodeId () const
 Get the NodeId of the current Node. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName of the current Node. More...
 
virtual UaLocalizedText displayName (Session *pSession) const
 Get the displayName as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isDescriptionSupported () const
 Check if Node is DescriptionSupported. More...
 
virtual UaLocalizedText description (Session *pSession) const
 Get the description as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isWriteMaskSupported () const
 Check if Node is WriteMaskSupported. More...
 
virtual OpcUa_UInt32 writeMask () const
 Get the writeMask of the current Node. More...
 
virtual OpcUa_Boolean isUserWriteMaskSupported () const
 Check if Node is UserWriteMaskSupported. More...
 
virtual OpcUa_UInt32 userWriteMask (Session *pSession) const
 Check if Node has a userWriteMask. More...
 
UaNodegetUaNode () const
 Get the UaNode interface pointer of this node. More...
 
virtual OpcUa_Byte eventNotifier () const
 Returns the EventNotifier for the BaseObjectType. More...
 
virtual MethodManagergetMethodManager (UaMethod *pMethod) const
 Returns the method manager interface for the BaseObjectType instance. More...
 
virtual void setUserData (UserDataBase *pUserData)
 Method to set user data stored in this class. More...
 
virtual UserDataBasegetUserData () const
 Method to get the user data stored in this class. More...
 
virtual void setBrowseName (const UaQualifiedName &browseName)
 Sets the browse name attribute value. More...
 
virtual void setDisplayName (const UaLocalizedText &displayName)
 Sets the display name attribute value. More...
 
virtual void setDescription (const UaLocalizedText &description)
 Sets the description attribute value. More...
 
virtual void setWriteMask (OpcUa_UInt32 writeMask)
 Sets the write mask attribute value. More...
 
virtual void setEventNotifier (OpcUa_Byte eventNotifier)
 Sets the eventNotifier attribute value. More...
 
virtual void setModellingRuleId (const UaNodeId &modellingRuleId)
 Set NodeId of the modeling rule for this node. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
void setMethodManager (MethodManager *pMethodManager)
 Allows a class aggregating the object to implement the MethodManager for this object. More...
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from MethodManager
 MethodManager ()
 construction
 
virtual ~MethodManager ()
 destruction
 
- Public Member Functions inherited from UaObject
 UaObject ()
 Construction of the UaObject. More...
 
OpcUa_NodeClass nodeClass () const
 Get the node class of the Node. More...
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode ()
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
const NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
- Public Member Functions inherited from ChainEntry
 ChainEntry ()
 construction
 
ChainEntryfind (const UaNodeId &key, ChainEntry **ppPrevious)
 finds the right entry in the chain. More...
 
void add (ChainEntry *pNewEntry)
 adds a new entry to the list. More...
 
void prepend (ChainEntry *pNewEntry)
 prepends a new entry to the list. More...
 
ChainEntryremove (const UaNodeId &key, ChainEntry **ppNext)
 removes an entry from the list. More...
 
ChainEntrygetNext () const
 Check if there is a chain. More...
 
virtual void setInvalid ()
 Set the entry to invalid. More...
 
void clearChain ()
 Clear the chain when the hashtable is cleared.
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 
- Public Member Functions inherited from UaReferenceLists
 UaReferenceLists ()
 Constructs the reference lists object.
 
virtual ~UaReferenceLists ()
 Destroys the reference lists object.
 
virtual UaStatus browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaStatus translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
 Find a node based on an element of an relative path. More...
 
virtual const UaReferencepTargetNodes () const
 Returns the list of references to target nodes. More...
 
virtual const UaReferencepSourceNodes () const
 Returns the list of references to source nodes. More...
 
virtual UaNodegetTargetNodeByBrowseName (const UaQualifiedName &browseName) const
 Searches a target node with the passed browse name and returns the UaNode interface if found. More...
 
virtual void addTargetNode (UaReference *pReference)
 Add a reference to a target node where this node is the source node. More...
 
virtual void addSourceNode (UaReference *pReference)
 Adds a reference to a source node where this node is the target node. More...
 
virtual UaStatus removeSourceNode (UaReference *pReferenceToRemove)
 Remove a reference to a source node where this node is the target node. More...
 
virtual bool removeSourceReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a source node. More...
 
virtual UaStatus removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual UaStatus removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual bool removeTargetReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a target node. More...
 
virtual UaStatus removeCrossNodeManagerRef (NodeManager *pNodeManager)
 Remove references to another NodeManager. More...
 
virtual UaStatus invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
 Set all references from SourceNodes to this Node invalid. More...
 
virtual UaStatus invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
 Set all references to TargetNode of this node invalid. More...
 
virtual UaStatus deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
 Deletes all child nodes. More...
 

Static Public Member Functions

static void createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::ServerConfigurationTypeBase
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::BaseObjectType
static void clearStaticMembers ()
 Clear the static members of the class.
 

Protected Member Functions

virtual ~ServerConfigurationType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::ServerConfigurationTypeBase
virtual ~ServerConfigurationTypeBase ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::BaseObjectType
virtual ~BaseObjectType ()
 Destruction of the BaseObjectType. More...
 
- Protected Member Functions inherited from UaObject
virtual ~UaObject ()
 Destruction of the UaObject. More...
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 

Additional Inherited Members

- Protected Attributes inherited from UaReferenceLists
UaReferencem_pTargetNodes
 List of references to target nodes where this node is the source node. More...
 
UaReferencem_pLastTargetNode
 Last references in the list of references to the target nodes. More...
 
UaReferencem_pSourceNodes
 List of references to source nodes where this node is the target node. More...
 

Detailed Description

Class implementing the UaObject interface for the ServerConfigurationType.

OPC UA Objects are used to represent systems, system components, real-world objects and software objects. They have the NodeClass Object. The detailed description of Objects and their attributes can be found in the general description of the Object node class.

Object members of the ServerConfigurationType:

Browse Name TypeDefinition Modelling Rule See Also
CertificateGroups CertificateGroupFolderType Mandatory getCertificateGroups

Variable members of the ServerConfigurationType:

Browse Name DataType TypeDefinition Modelling Rule See Also
MaxTrustListSize UInt32 PropertyType Mandatory getMaxTrustListSize, setMaxTrustListSize
MulticastDnsEnabled Boolean PropertyType Mandatory getMulticastDnsEnabled, setMulticastDnsEnabled
ServerCapabilities String PropertyType Mandatory getServerCapabilities, setServerCapabilities
SupportedPrivateKeyFormats String PropertyType Mandatory getSupportedPrivateKeyFormats, setSupportedPrivateKeyFormats

Method members of the ServerConfigurationType:

Browse Name Modelling Rule
ApplyChanges Mandatory
CreateSigningRequest Mandatory
GetRejectedList Mandatory
UpdateCertificate Mandatory

This type defines an ObjectType which represents the configuration of a Server which supports Push Management.

There is always exactly one instance in the Server address space.

See also ServerConfigurationType for a documentation of the complete Information Model.

Constructor & Destructor Documentation

OpcUa::ServerConfigurationType::ServerConfigurationType ( const UaNodeId nodeId,
UaObject pInstanceDeclarationObject,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class ServerConfigurationType.

This constructor is used if the object is created based on an instance declaration of an object type. Since the only difference between the instance declaration object and the instance object are the node id, the pointer to the instance declaration node is used to get the attribute values other than NodeId from the instance declaration node.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]pInstanceDeclarationObjectUaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::ServerConfigurationType::ServerConfigurationType ( const UaNodeId nodeId,
const UaString name,
OpcUa_UInt16  browseNameNameSpaceIndex,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class ServerConfigurationType.

This constructor is used if the object is not created based on an instance declaration. It defines the name and node id of the object. Additional language specific names and other attribute values can be set with set methods provided by the class.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]nameName of the new object. Used as browse name and also as display name if no additional language specific names are set.
[in]browseNameNameSpaceIndexNamespace index used for the browse name
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::ServerConfigurationType::ServerConfigurationType ( UaBase::Object pBaseNode,
XmlUaNodeFactoryManager pFactory,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Constructs an instance of the class ServerConfigurationType with all components.

Parameters
[in]pBaseNodeThe "tree" of nodes that specifies the attributes of the instance and its children
[in]pFactoryThe factory to create the children
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

Member Function Documentation

UaStatus OpcUa::ServerConfigurationType::ApplyChanges ( const ServiceContext serviceContext)
virtual

Used to tell the Server to apply any security changes.

This method should only be called if a previous call to a method that changed the configuration returns ApplyChangesRequired=true (see UpdateCertificate).

ApplyChanges can have different meanings depending on the Server architecture. In the ideal case it would only require the endpoints to be closed and reopened. However, it could require a complete Server shutdown and restart.

This Method requires an encrypted channel and that the Client provides credentials with administrative rights on the Server.

Method Result Codes

Result Code Description
Bad_UserAccessDenied The current user does not have the rights required.
Parameters
[in]serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implements OpcUa::ServerConfigurationTypeBase.

UaStatus OpcUa::ServerConfigurationType::CreateSigningRequest ( const ServiceContext serviceContext,
const UaNodeId CertificateGroupId,
const UaNodeId CertificateTypeId,
const UaString SubjectName,
OpcUa_Boolean  RegeneratePrivateKey,
UaByteString Nonce,
UaByteString CertificateRequest 
)
virtual

Asks the Server to create a PKCS #10 DER encoded certificate request that is signed with the Server’s private key.

This request can be then used to request a certificate from a CA that expects requests in this format. See RFC 2986 (txt file) for a description of PKCS #10.

This method requires an encrypted channel and that the Client provides credentials with administrative rights on the Server.

Method Result Codes

Result Code Description
Bad_InvalidArgument The CertificateTypeId, certificateGroupId or SubjectName is not valid.
Bad_UserAccessDenied The current user does not have the rights required.
Parameters
[in]serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]CertificateGroupIdThe NodeId of the Certificate Group Object which is affected by the request.
If null, the DefaultApplicationGroup is used.
[in]CertificateTypeIdThe type of certificate being requested.
The set of permitted types is specified by the CertificateTypes property belonging to the certificate group.
[in]SubjectNameThe subject name to use in the certificate request.
If not specified, the SubjectName from the current certificate is used.
[in]RegeneratePrivateKeyFlag indicating whether to create a new private key.
If TRUE, the Server shall create a new private key which it stores until the matching signed certificate is uploaded with the UpdateCertificate method. Previously created private keys may be discarded if UpdateCertificate was not called before calling this method again. If FALSE, the Server uses its existing private key.
[in]NonceAdditional entropy which the caller shall provide if RegeneratePrivateKey is TRUE.
It shall be at least 32 bytes long.
[out]CertificateRequestThe PKCS #10 DER encoded certificate request.

Implements OpcUa::ServerConfigurationTypeBase.

UaStatus OpcUa::ServerConfigurationType::GetRejectedList ( const ServiceContext serviceContext,
UaByteStringArray Certificates 
)
virtual

Returns the list of Certificates that have been rejected by the Server.

No rules are defined for how the Server updates this list or how long a certificate is kept in the list. It is recommended that every valid but untrusted certificate be added to the rejected list as long as storage is available. Servers should omit older entries from the list returned if the maximum message size is not large enough to allow the entire list to be returned.

This method requires an encrypted channel and that the Client provides credentials with administrative rights on the Server.

Method Result Codes

Result Code Description
Bad_UserAccessDenied The current user does not have the rights required.
Parameters
[in]serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[out]CertificatesThe DER encoded form of the Certificates rejected by the Server.

Implements OpcUa::ServerConfigurationTypeBase.

void OpcUa::ServerConfigurationType::setCertificateStoreConfiguration ( const UaString sServerRejectedList,
const CertificateStoreConfigurationPArray &  certificateStores,
NodeAccessInfo pAccessInfoSecurityAdmin,
CertificateStoreConfiguration pUserCertificateStore 
)

Sets the certificate store configurations.

Parameters
[in]sServerRejectedListServer rejected list directory
[in]certificateStoresList of certificate store configurations
[in]pAccessInfoSecurityAdminSecurity configuration for nodes
[in]pUserCertificateStoreUser certificate store configuration
UaStatus OpcUa::ServerConfigurationType::UpdateCertificate ( const ServiceContext serviceContext,
const UaNodeId CertificateGroupId,
const UaNodeId CertificateTypeId,
UaByteString Certificate,
const UaByteStringArray IssuerCertificates,
const UaString PrivateKeyFormat,
UaByteString PrivateKey,
OpcUa_Boolean &  ApplyChangesRequired 
)
virtual

Used to update a certificate for a Server.

There are the following three use cases for this Method.

  • The new Certificate was created based on a signing request created with the method CreateSigningRequest. In this case, there is no PrivateKey provided.
  • A new PrivateKey and Certificate were created outside the Server and both are updated with this method.
  • A new Certificate was created and signed with the information from the old Certificate. In this case, there is no PrivateKey provided.

The Server shall do all normal integrity checks on the certificate and all of the issuer certificates. If errors occur, the Bad_SecurityChecksFailed error is returned.

The Server shall report an error if the public key does not match the existing certificate and PrivateKey was not provided.

This method requires an encrypted channel and that the Client provides credentials with administrative rights on the Server.

This method may require the ApplyChanges method to be called.

Method Result Codes

Result Code Description
Bad_InvalidArgument The CertificateTypeId or certificateGroupId is not valid.
Bad_CertificateInvalid The certificate is invalid or the format is not supported.
Bad_NotSupported The PrivateKey is invalid or the format is not supported.
Bad_UserAccessDenied The current user does not have the rights required.
Bad_SecurityChecksFailed Some failure occurred verifying the integrity of the certificate.
Parameters
[in]serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]CertificateGroupIdThe NodeId of the Certificate Group Object which is affected by the update.
If null the DefaultApplicationGroup is used.
[in]CertificateTypeIdThe type of certificate being updated.
The set of permitted types is specified by the CertificateTypes property belonging to the certificate group.
[in]CertificateThe DER encoded certificate which replaces the existing certificate.
[in]IssuerCertificatesThe issuer certificates needed to verify the signature on the new certificate.
[in]PrivateKeyFormatThe format of the private key (PEM or PFX).
If the privateKey is not specified the privateKeyFormat is null or empty.
[in]PrivateKeyThe private key encoded in the PrivateKeyFormat.
[out]ApplyChangesRequiredIndicates that the ApplyChanges method must be called before the new certificate will be used.

Implements OpcUa::ServerConfigurationTypeBase.


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