C++ UA Server SDK
1.5.1.326
|
Server Configuration Interface definition. More...
#include <serverconfig.h>
Inherited by ServerConfigData.
Public Types | |
enum | ComDaTimestampSource { INTERNAL, SOURCE_TIMESTAMP, SERVER_TIMESTAMP } |
ComDaTimestampSource enumeration. More... | |
enum | ComAeEventType { SIMPLE_EVENT, TRACKING_EVENT, CONDITION_EVENT } |
ComAeEventType enumeration. More... | |
Public Member Functions | |
ServerConfig () | |
construction. More... | |
virtual | ~ServerConfig () |
destruction | |
virtual UaStatus | loadConfiguration ()=0 |
Load the configuration from the config file. More... | |
virtual UaStatus | startUp (ServerManager *pServerManager)=0 |
Start up OPC ServerConfig. More... | |
virtual UaStatus | shutDown ()=0 |
Shut down OPC ServerConfig. More... | |
virtual UaStatus | saveConfiguration ()=0 |
Save the configuration to the config file. More... | |
virtual UaStatus | getEndpointConfiguration (UaString &sRejectedCertificateDirectory, OpcUa_UInt32 &nRejectedCertificatesCount, UaEndpointArray &uaEndpointArray)=0 |
Get Endpoint Configuration. More... | |
virtual void | endpointOpened (OpcUa_UInt32 index) |
Set state of successfully opened endpoint. | |
virtual UaStatus | getCertificateStoreConfigurations (CertificateStoreConfigurationPArray &certificateStores)=0 |
Get the configurations for server certificate stores. More... | |
virtual UaStatus | getUserIdentityTokenConfig (OpcUa_Boolean &bEnableAnonymous, OpcUa_Boolean &bEnableUserPw, OpcUa_Boolean &bEnableCertificate, OpcUa_Boolean &bEnableKerberosTicket)=0 |
Get the enabled settings for the different user identity tokens supported by the server. More... | |
virtual UaStatus | getUserIdentityTokenSecurityPolicy (UaString &sSecurityPolicyUri) |
Get the security policy to use when encrypting or signing the UserIdentityToken when it is passed to the server. More... | |
virtual UaStatus | getDefaultUserCertificateStore (CertificateStoreConfiguration **ppCertificateStore, UaString &sRejectedCertificateDirectory, OpcUa_UInt32 &nRejectedCertificatesCount, OpcUa_Boolean &bCertificateTokenConfigured) |
Get the configurations for the trust list and rejected folder for user certificates. More... | |
virtual UaStatus | getIdsForDefaultRoles (OpcUa_UInt16 &nRootUserId, OpcUa_UInt16 &nSecurityAdminGroupId, OpcUa_UInt16 &nConfigAdminGroupId) |
Get Ids for roles defined in the SDK. More... | |
virtual UaStatus | getDiscoveryRegistrationConfig (OpcUa_UInt32 &nRegistrationInterval, UaStringArray &discoveryUrlArray)=0 |
Get settings for registration with discovery servers. More... | |
virtual UaStatus | getWindowsDiscoveryRegistrationSecuritySetup (OpcUa_Boolean &bAutomaticCertificateExchange, UaString &sDiscoveryServerTrustListLocation, UaString &sDiscoveryServerStoreName, UaString &sDiscoveryServerCertificateName) |
Get settings for exchanging certificates with local discovery server on a windows computer for registration with local windows discovery server. More... | |
virtual UaStatus | getSerializerConfiguration (OpcUa_Int32 &iMaxAlloc, OpcUa_Int32 &iMaxStringLength, OpcUa_Int32 &iMaxByteStringLength, OpcUa_Int32 &iMaxArrayLength, OpcUa_Int32 &iMaxMessageSize) const =0 |
Get Serializer Configuration. More... | |
virtual UaStatus | getStackThreadPoolSettings (OpcUa_Boolean &bEnabled, OpcUa_Int32 &iMinThreads, OpcUa_Int32 &iMaxThreads, OpcUa_Int32 &iMaxJobs, OpcUa_Boolean &bBlockOnAdd, OpcUa_UInt32 &nTimeout) const =0 |
Returns the settings for the thread pool used in the OPC UA Stack. More... | |
virtual UaStatus | getStackTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel) const =0 |
Get UA Stack trace settings. More... | |
virtual UaStatus | getServerTraceSettings (OpcUa_Boolean &bTraceEnabled, OpcUa_UInt32 &uTraceLevel, OpcUa_UInt32 &uMaxTraceEntries, OpcUa_UInt32 &uMaxBackupFiles, UaString &sTraceFile, OpcUa_Boolean &bDisableFlush) const =0 |
Get UA Server SDK trace settings. More... | |
virtual UaStatus | getTraceEventSettings (OpcUa_UInt32 &uTraceEventLevel) const |
Get UA Server SDK trace event settings. More... | |
virtual OpcUa_Int32 | getMaxRequestAge () const =0 |
Returns the maximum age of a request the server allows. More... | |
virtual UaStatus | getSessionSettings (OpcUa_Int32 &iMaxSessionCount, OpcUa_Int32 &iMaxSessionsPerClient, OpcUa_Int32 &iMinSessionTimeout, OpcUa_Int32 &iMaxSessionTimeout) const =0 |
Get the setting parameters for session creation. More... | |
virtual UaStatus | getServerSettings (OpcUa_Double &minSupportedSampleRate, UaStringArray &localeIdArray, UaStringArray &serverProfileArray, UaByteStringArray &softwareCertificateArray) const =0 |
Get the general setting parameters for the server. More... | |
virtual OpcUa_Int32 | getMaxBrowseContinuationPoints () const =0 |
Returns the maximum number of Browse Continuation Points managed by the server. More... | |
virtual OpcUa_Int32 | getMaxBrowseResults () const |
Returns the maximum number of Browse results for one browse operation. More... | |
virtual OpcUa_Int32 | getMaxNodesToBrowse () const |
Returns the maximum number of nodes to browse the server will accept. More... | |
virtual UaStatus | getMaxNodesPerHistoryService (OpcUa_UInt32 &iMaxNodesPerHistoryReadData, OpcUa_UInt32 &iMaxNodesPerHistoryReadEvents, OpcUa_UInt32 &iMaxNodesPerHistoryUpdateData, OpcUa_UInt32 &iMaxNodesPerHistoryUpdateEvents) const |
Get the operation limit setting parameters for historical access. More... | |
virtual OpcUa_Int32 | getMaxHistoryContinuationPoints () const =0 |
Returns the maximum number of History Continuation Points managed by the server. More... | |
virtual UaStatus | getSubscriptionSettings (OpcUa_UInt32 &iMinPublishingInterval, OpcUa_UInt32 &iMaxPublishingInterval, OpcUa_UInt32 &iMinKeepAliveInterval, OpcUa_UInt32 &iMinSubscriptionLifetime, OpcUa_UInt32 &iMaxSubscriptionLifetime, OpcUa_UInt32 &iMaxRetransmissionQueueSize, OpcUa_UInt32 &iMaxNotificationsPerPublish) const =0 |
Get the setting parameters for a subscription. More... | |
virtual UaStatus | getMonitoredItemSettings (OpcUa_UInt32 &iMaxDataQueueSize, OpcUa_UInt32 &iMaxEventQueueSize) const =0 |
Get the setting parameters for a MonitoreItem. More... | |
virtual UaStatus | getSubscriptionMaxCountSettings (OpcUa_UInt32 &iMaxSubscriptionCount, OpcUa_UInt32 &iMaxSubscriptionsPerSession, OpcUa_UInt32 &iMaxMonitoredItemCount, OpcUa_UInt32 &iMaxMonitoredItemPerSubscriptionCount, OpcUa_UInt32 &iMaxMonitoredItemPerSessionCount) const |
Get the max object count parameters for Subscriptions. More... | |
virtual UaStatus | getAvailableSamplingRates (UaUInt32Array &availableSamplingRates) const =0 |
Returns the sampling rates provided by the OPC server. More... | |
virtual OpcUa_StatusCode | getBuildInfo (UaString &ProductUri, UaString &ManufacturerName, UaString &ProductName, UaString &sSoftwareVersion, UaString &sBuildNumber, OpcUa_DateTime &BuildDate) const =0 |
Returns the build information for the OPC server. More... | |
virtual OpcUa_StatusCode | getServerInstanceInfo (UaString &ServerUri, UaLocalizedTextArray &ServerName) const =0 |
Returns the server instance information for the OPC server. More... | |
virtual UaString | getServerId () const |
Returns the ServerId used for audit events. More... | |
virtual UaStatus | getThreadPoolSettings (OpcUa_UInt32 &minSizeTransactionManager, OpcUa_UInt32 &maxSizeTransactionManager, OpcUa_UInt32 &minSizeSubscriptionManager, OpcUa_UInt32 &maxSizeSubscriptionManager) const =0 |
Returns the settings for the thread pools used in the OPC server. More... | |
virtual Session * | createSession (OpcUa_Int32 sessionID, const UaNodeId &authenticationToken)=0 |
Creates a session object for the OPC server. More... | |
virtual UaStatus | logonSessionUser (Session *pSession, UaUserIdentityToken *pUserIdentityToken)=0 |
Validates the user identity token and sets the user for a session. More... | |
virtual OpcUa_Boolean | isAuditActivated () |
Flag indicating if audit events are activated. More... | |
virtual UaStatus | getRedundancySettings (OpcUa_RedundancySupport &redundancySupport, UaStringArray &serverUriArray) |
Provides the redundancy settings for the server. More... | |
virtual UaStatus | getAdditionalServerEntries (UaApplicationDescriptions &serverDescriptions) |
Provides capability to configure additional servers to be returned in FindServers. More... | |
virtual UaStatus | getConfiguredNamespaces (UaUInt16Array &namespaceIndexArray, UaStringArray &namespaceUriArray, UaBoolArray &allowRenameUriArray, UaStringArray &uniqueIdArray, UaStringArray &comAliasArray) |
Provides configuration option for namespaces other than index 0 and 1 (OPC UA and local server). More... | |
virtual UaStatus | addConfiguredNamespace (OpcUa_UInt16 namespaceIndex, const UaString &namespaceUri, OpcUa_Boolean allowRenameUri, const UaString &uniqueId) |
Adds a namespaces configuration entry for preconfigured namespaces. More... | |
virtual UaStatus | removeConfiguredNamespace (OpcUa_UInt16 namespaceIndex) |
Removes a namespaces configuration entry for preconfigured namespaces. More... | |
virtual UaStatus | getTagFileConfiguration (UaString &defaultTagFileName, UaString &tagFileLocation, UaString &tagFileEnding, UaString &defaultFileUpdatePolicy) |
Provides information about tagfile name, path und file ending used in the NodeManagerTagFile. More... | |
virtual UaStatus | setTagFileConfiguration (const UaString &defaultTagFileName, const UaString &tagFileLocation, const UaString &tagFileEnding, const UaString &defaultFileUpdatePolicy) |
Set information about tagfile name, path und file ending used in the NodeManagerTagFile. More... | |
virtual UaStatus | setServerCertificateThumbprint (const UaString &thumbprint) |
virtual UaStatus | getHttpFileAccess (OpcUa_Boolean &active, UaString &filePath) |
Provides settings for HTTP file access capability. More... | |
virtual UaStatus | getComDaPropertyMapping (UaStringArray &propertyNames, UaStringArray &propertyNameSpaces, UaUInt32Array &propertyIds) |
Provides a mapping list of OPC UA property names to COM Data Access property Ids. More... | |
virtual UaStatus | addComDaPropertyMapping (const UaString &propertyName, const UaString &propertyNameSpaceUri, OpcUa_UInt32 propertyId) |
Adds an entry to the mapping list of OPC UA property names to COM Data Access property Ids. More... | |
virtual UaStatus | getComDaNamespaceInformation (UaString &defaultNamespace, UaUShort &namespaceDelimiter, OpcUa_Boolean &useComAlias) |
Provides additional namespace related information for COM DA Server module. More... | |
virtual ComDaTimestampSource | getComDaTimestampSource () |
Provides the timestamp source for COM Data Access items. More... | |
virtual ComDaTimestampSource | getComHdaTimestampSource () |
Provides the timestamp source for COM Historical Data Access items. More... | |
virtual OpcUa_Boolean | getBrowseNextLevelForVariables () |
When browsing for COM DA items this option causes the server to internally browse one additional level to see if there are any children. | |
virtual UaStatus | getComAeNamespaceInformation (UaString &defaultNamespace) |
Provides additional namespace related information for COM A&E Server module. More... | |
virtual UaStatus | getComAeEventCategoryMapping (ComAeEventType eventType, UaUInt32Array &categoryIDs, UaStringArray &categoryNames, UaNodeIdArray &eventTypeIds, UaStringArray &namespaceUris, UaBoolArray &visbilityFlags) |
Provides a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs. More... | |
virtual UaStatus | addComAeEventCategoryMapping (ComAeEventType eventType, const UaUInt32Array &categoryIDs, const UaStringArray &categoryNames, const UaNodeIdArray &eventTypeIds, const UaStringArray &namespaceUris) |
Adds a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs. More... | |
virtual UaStatus | getComAeAttributeMapping (ComAeAttributeMappingArray &comAeAttributeMappingArray) |
Get the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs. More... | |
virtual UaStatus | addComAeAttributeMapping (OpcUa_UInt32 attributeID, const UaString &attributeName, OpcUa_BuiltInType dataType, OpcUa_Boolean isArray, const UaStringArray &eventFieldPathNames, const UaStringArray &eventFieldPathNamespaceUris) |
Adds an entry to the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs. More... | |
virtual void | lockConfigFile () |
Lock snchronization object for configuratin changes. | |
virtual void | unlockConfigFile () |
Unlock snchronization object for configuratin changes. | |
Server Configuration Interface definition.
This class is responsible for the start up and shut down of the Server. Also all necessary configuration options can be configured with this class. Services like discovery and getEndpointConfiguration are defined here. This Interface configures the Server and all needed parts of it.
|
inline |
construction.
|
virtual |
Adds an entry to the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs.
The event type hirarchy and its event fields are managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event fields are identified by a path of QualifiedNames starting from the EventType. These QualifiedNames are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, attribute IDs are DWORDS. This method adds an entrie to the mapping table of OPC UA event fields to classic OPC Alarms & Events attribute IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface.
[in] | attributeID | Attribute ID |
[in] | attributeName | Attribute Name |
[in] | dataType | Data type of the attribute |
[in] | isArray | Array flag for the data type of the attribute |
[in] | eventFieldPathNames | List of event field path names |
[in] | eventFieldPathNamespaceUris | List of event field path namespace URIs |
Reimplemented in ServerConfigData, and ServerConfigXml.
|
virtual |
Adds a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs.
The event type hirarchy managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event types are identified by NodeIds. These NodeIds are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, event category IDs are DWORDS. This method provides the mapping table of OPC UA event type NodeIds to classic OPC Alarms & Events category IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface. The default implementation does not store the list
[in] | eventType | Event type for the categories to add |
[in] | categoryIDs | List of OPC A&E category names |
[in] | categoryNames | List of OPC A&E category names |
[in] | eventTypeIds | List of OPC UA event type NodeIds |
[in] | namespaceUris | List of namespace URIs for the event type id. The string is empty for namespace 0 |
Reimplemented in ServerConfigData, and ServerConfigXml.
|
virtual |
Adds an entry to the mapping list of OPC UA property names to COM Data Access property Ids.
The address space managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, properties are identified by qualified names. These names are defined by standardization bodies like the OPC Foundation for the standard OPC UA properties or by vendors or users. In classic OPC Data Access, properties are defined by integer IDs defined by the OPC Foundation or by vendors. This method adds an entry to the mapping table of OPC UA porperty names to classic OPC Data Access property IDs. This mapping table is only needed for servers providing a classic OPC Data Access interface in addition to the OPC UA interface. The default implementation is empty and is not storing the added entry
[in] | propertyName | OPC UA Property name |
[in] | propertyNameSpaceUri | OPC UA Property name space URI |
[in] | propertyId | Classic OPC Data Access Property Id |
Reimplemented in ServerConfigData, and ServerConfigXml.
|
virtual |
Adds a namespaces configuration entry for preconfigured namespaces.
[in] | namespaceIndex | Index for the namespace in the namespace table |
[in] | namespaceUri | Namespace URI in the namespace table |
[in] | allowRenameUri | Flag indicating if module responsible for the namespace supports a change of the namespace URI in the configuration |
[in] | uniqueId | Unique ID required to identify the namespace if the module allows to change the namespace URI in the configuration |
Reimplemented in ServerConfigData, and ServerConfigXml.
|
pure virtual |
Creates a session object for the OPC server.
This could be an instance of the default Session class provided by the SDK or a derived class that contains application specific functionality and vendor specific data related to the underlying system.
[out] | sessionID | Session Id created by the server application. |
[out] | authenticationToken | Secret session Id created by the server application. |
|
virtual |
Provides capability to configure additional servers to be returned in FindServers.
Every server must implement FindServers and must return its own application description. This can also be used to run the server on the default port 4840 if only one server is installed on the system. This configuration option allows to run this server on port 4840 but to return also additional servers for a fixed configuration e.g. two servers from the same vendor on one network node.
[out] | serverDescriptions | List of application descriptions containing the information for the additional servers to return. |
Reimplemented in ServerConfigData.
|
pure virtual |
Returns the sampling rates provided by the OPC server.
[out] | availableSamplingRates | Array of sampling rates provided by the OPC server. |
Implemented in ServerConfigData.
|
pure virtual |
Returns the build information for the OPC server.
[out] | ProductUri | Returns the URI that identifies the software containing the OPC server. |
[out] | ManufacturerName | Returns the name of the software manufacturer. |
[out] | ProductName | Returns the name of the software containing the OPC server. |
[out] | sSoftwareVersion | Returns the software version. |
[out] | sBuildNumber | Returns the build number. |
[out] | BuildDate | Returns the date and time of the build. |
Implemented in ServerConfigData.
|
pure virtual |
Get the configurations for server certificate stores.
[out] | certificateStores | List of certificate store configurations |
Implemented in ServerConfigData.
|
virtual |
Get the mapping list of OPC UA event fields to COM Alarms and Events attribute IDs.
The event type hirarchy and its event fields are managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event fields are identified by a path of QualifiedNames starting from the EventType. These QualifiedNames are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, attribute IDs are DWORDS. This method adds an entrie to the mapping table of OPC UA event fields to classic OPC Alarms & Events attribute IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface.
[out] | comAeAttributeMappingArray | Array of configured mappings between OPC UA event fields and COM Alarms and Events attribute IDs. |
Reimplemented in ServerConfigData.
|
virtual |
Provides a mapping list of OPC UA event type NodeIds to COM Alarms and Events category IDs.
The event type hirarchy managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, event types are identified by NodeIds. These NodeIds are defined by standardization bodies like the OPC Foundation for the standard OPC UA event types or by vendors or users. In classic OPC Alarms & Events, event category IDs are DWORDS. This method provides the mapping table of OPC UA event type NodeIds to classic OPC Alarms & Events category IDs. This mapping table is only needed for servers providing a classic OPC Alarms & Events interface in addition to the OPC UA interface. The default implementation returns empty lists
[in] | eventType | Event type for the categories to return |
[out] | categoryIDs | List of OPC A&E category names |
[out] | categoryNames | List of OPC A&E category names |
[out] | eventTypeIds | List of OPC UA event type NodeIds |
[out] | namespaceUris | List of namespace URIs for the event type id. The string is empty for namespace 0 |
[out] | visbilityFlags | List of flags indicating if the category is visible |
Reimplemented in ServerConfigData.
Provides additional namespace related information for COM A&E Server module.
The default implementation returns empty strings and lists.
[out] | defaultNamespace | Default namespace URI used to create fully qualified names without namespace URI |
Reimplemented in ServerConfigData.
|
virtual |
Provides additional namespace related information for COM DA Server module.
The default implementation returns empty strings and lists.
[out] | defaultNamespace | Default namespace URI used to create ItemIds without namespace URI |
[out] | namespaceDelimiter | Delimiter used in ItemIDs between Namespace URI and Identifier |
[out] | useComAlias | Flag indicating if the COM alias for namespaces is used in ItemIDs |
Reimplemented in ServerConfigData.
|
virtual |
Provides a mapping list of OPC UA property names to COM Data Access property Ids.
The address space managed by the SDK or custom NodeManager implementations is created based on the OPC UA model. In OPC UA, properties are identified by qualified names. These names are defined by standardization bodies like the OPC Foundation for the standard OPC UA properties or by vendors or users. In classic OPC Data Access, properties are defined by integer IDs defined by the OPC Foundation or by vendors. This method provides the mapping table of OPC UA porperty names to classic OPC Data Access property IDs. This mapping table is only needed for servers providing a classic OPC Data Access interface in addition to the OPC UA interface. The default implementation returns empty lists
[out] | propertyNames | List of OPC UA Property names |
[out] | propertyNameSpaces | List of OPC UA Property name spaces |
[out] | propertyIds | List of classic OPC Data Access Property Ids |
Reimplemented in ServerConfigData.
|
virtual |
Provides the timestamp source for COM Data Access items.
Reimplemented in ServerConfigData.
|
virtual |
Provides the timestamp source for COM Historical Data Access items.
Reimplemented in ServerConfigData.
|
virtual |
Provides configuration option for namespaces other than index 0 and 1 (OPC UA and local server).
This allows the assignment of namespace URIs to a specific index independent of the loading sequence of NodeManagers.
[out] | namespaceIndexArray | List of indices for the namespaces in the namespace table |
[out] | namespaceUriArray | List of namespace URIs in the namespace table |
[out] | allowRenameUriArray | List of flags indicating if module responsible for the namespace supports a change of the namespace URI in the configuration. If this flag is set to true, the optional parameter UniqueId must be provided. |
[out] | uniqueIdArray | List of unique IDs required to identify the namespace if the module allows to change the namespace URI in the configuration |
[out] | comAliasArray | List of aliases used to create COM ItemIds or other COM identifiers |
Reimplemented in ServerConfigData.
|
virtual |
Get the configurations for the trust list and rejected folder for user certificates.
[out] | ppCertificateStore | Certificate store configuration for user certificates |
[out] | sRejectedCertificateDirectory | The directory to store rejected user certificates. |
[out] | nRejectedCertificatesCount | The maximum number of rejected user certificates in the directory |
[out] | bCertificateTokenConfigured | Returns true if the user identity token certificate is enabled in the configuration |
Reimplemented in ServerConfigData.
|
pure virtual |
Get settings for registration with discovery servers.
[out] | nRegistrationInterval | Interval in milliseconds used to register with the discovery servers. |
[out] | discoveryUrlArray | UaString array of discovery server URLs to register with. |
Implemented in ServerConfigData.
|
pure virtual |
Get Endpoint Configuration.
This method provides the settings necessary for the SDK to open the endpoints for OPC UA communication in the UA stack and to implement the GetEndpoints service in the UA Module.
[out] | sRejectedCertificateDirectory | The directory to store rejected client certificates. |
[out] | nRejectedCertificatesCount | The maximum number of rejected certificates in the directory |
[out] | uaEndpointArray | UaEndpoint array of configured endpoints for the server. |
Implemented in ServerConfigData.
Provides settings for HTTP file access capability.
The default implementation returns inactive.
[out] | active | Flag indicating if the file access is active. |
[out] | filePath | The path to the directory with the HTML files. |
Reimplemented in ServerConfigData.
|
virtual |
Get Ids for roles defined in the SDK.
These roles are needed to control access to certificate configuration and trace configuration.
[out] | nRootUserId | Id of the root user. This user has all rights. Default is 0. |
[out] | nSecurityAdminGroupId | Id of the security admin group. Members of this group have acceess to administrate certificates. Default is 0. |
[out] | nConfigAdminGroupId | Id of the configuration admin group. Members of this group can configure the trace. Default is 0. |
Reimplemented in ServerConfigData.
|
pure virtual |
Returns the maximum number of Browse Continuation Points managed by the server.
Implemented in ServerConfigData.
|
virtual |
Returns the maximum number of Browse results for one browse operation.
Reimplemented in ServerConfigData.
|
pure virtual |
Returns the maximum number of History Continuation Points managed by the server.
Implemented in ServerConfigData.
|
virtual |
Get the operation limit setting parameters for historical access.
[out] | iMaxNodesPerHistoryReadData | Maximum number of nodes for HistoryRead service for Raw, Modified, Processed and AtTime |
[out] | iMaxNodesPerHistoryReadEvents | Maximum number of nodes for HistoryRead service for Events |
[out] | iMaxNodesPerHistoryUpdateData | Maximum number of nodes for HistoryUpdate service for Data |
[out] | iMaxNodesPerHistoryUpdateEvents | Maximum number of nodes for HistoryUpdate service for Events |
Reimplemented in ServerConfigData.
|
virtual |
Returns the maximum number of nodes to browse the server will accept.
Reimplemented in ServerConfigData.
|
pure virtual |
Returns the maximum age of a request the server allows.
Implemented in ServerConfigData.
|
pure virtual |
Get the setting parameters for a MonitoreItem.
[out] | iMaxDataQueueSize | Maximum queue size for a data monitored item |
[out] | iMaxEventQueueSize | Maximum queue size for an event monitored item |
Implemented in ServerConfigData.
|
virtual |
Provides the redundancy settings for the server.
There are three main options available, None, NonTransparent (with cold, warm and hot) and Transparent redundancy. This configuration covers the options None and NonTransparent. The option Transparent requires an additional SDK module. This redundancy module is also providing the required settings and creates the corresponding diagnostic and capability object.
[out] | redundancySupport | Redundancy support options
|
[out] | serverUriArray | List of server URIs for the servers in the NonTransparent redundant set |
Reimplemented in ServerConfigData.
|
pure virtual |
Get Serializer Configuration.
These are the Security constraints for the serializer. Set these values carefully.
[out] | iMaxAlloc | The largest size for a memory block the serializer can do when deserializing a message |
[out] | iMaxStringLength | The largest string accepted by the serializer |
[out] | iMaxByteStringLength | The largest byte string accepted by the serializer |
[out] | iMaxArrayLength | Maximum number of elements in an array accepted by the serializer |
[out] | iMaxMessageSize | The maximum number of bytes per message in total |
Implemented in ServerConfigData.
|
virtual |
Returns the ServerId used for audit events.
The default implementation returns the ServerUri. Transparent redundant servers must extend the ServerUri with a unique identifier for the server in the redundant set.
Reimplemented in ServerConfigData.
|
pure virtual |
Returns the server instance information for the OPC server.
[out] | ServerUri | Returns the URI that identifies the application instance containing the OPC server. |
[out] | ServerName | Returns the name of the software instance containing the OPC server. |
Implemented in ServerConfigData.
|
pure virtual |
Get the general setting parameters for the server.
[out] | minSupportedSampleRate | Minimum supported sample rate by the server provided as capability information to the client |
[out] | localeIdArray | Array of LocaleIds that are known to be supported by the server. |
[out] | serverProfileArray | Array of conformance profile URIs indicating the features supported by the server. |
[out] | softwareCertificateArray | Array of software certificates containing all certificates supported by the server. |
Implemented in ServerConfigData.
|
pure virtual |
Get UA Server SDK trace settings.
[out] | bTraceEnabled | Globally enable/disable trace output from the SDK |
[out] | uTraceLevel | Configures the level of messages traced
|
[out] | uMaxTraceEntries | Maximum number of trace entries in one trace file |
[out] | uMaxBackupFiles | Maximum number of backup files |
[out] | sTraceFile | Name and path of the trace file |
[out] | bDisableFlush | Disable flushing the trace file after each trace entry |
Implemented in ServerConfigData.
|
pure virtual |
Get the setting parameters for session creation.
[out] | iMaxSessionCount | Maximum number of sessions the server allows to create |
[out] | iMaxSessionsPerClient | Maximum number of sessions the server allows per Client, 0 is no limitation |
[out] | iMinSessionTimeout | Minimum timeout in ms for a sessions the server allows to set |
[out] | iMaxSessionTimeout | Maximum timeout in ms for a sessions the server allows to set |
Implemented in ServerConfigData.
|
pure virtual |
Returns the settings for the thread pool used in the OPC UA Stack.
[out] | bEnabled | Controls wether the secure listener uses a thread pool to dispatch received requests |
[out] | iMinThreads | The minimum number of threads in the thread pool |
[out] | iMaxThreads | The maximum number of threads in the thread pool |
[out] | iMaxJobs | The length of the queue with jobs waiting for a free thread |
[out] | bBlockOnAdd | If MaxJobs is reached the add operation can block or return an error |
[out] | nTimeout | If the add operation blocks on a full job queue, this value sets the max waiting time |
Implemented in ServerConfigData.
|
pure virtual |
Get UA Stack trace settings.
[out] | bTraceEnabled | Globally enable/disable trace output from the stack (exclude platformlayer) |
[out] | uTraceLevel | Configures the level of messages traced
|
Implemented in ServerConfigData.
|
virtual |
Get the max object count parameters for Subscriptions.
[out] | iMaxSubscriptionCount | Maximum number of subscriptions the server allows to create. Default value 0 is unlimited |
[out] | iMaxSubscriptionsPerSession | Maximum number of subscriptions the server allows to create per session. Default value 0 is unlimited |
[out] | iMaxMonitoredItemCount | Maximum number of monitored items the server allows to create. Default value 0 is unlimited |
[out] | iMaxMonitoredItemPerSubscriptionCount | Maximum number of monitored items per subscriptions the server allows to create. Default value 0 is unlimited |
[out] | iMaxMonitoredItemPerSessionCount | Maximum number of monitored items per session the server allows to create. Default value 0 is unlimited |
Reimplemented in ServerConfigData.
|
pure virtual |
Get the setting parameters for a subscription.
[out] | iMinPublishingInterval | Minimum publishing interval in milliseconds the server allows |
[out] | iMaxPublishingInterval | Maximum publishing interval in milliseconds the server allows |
[out] | iMinKeepAliveInterval | Minimum KeepAlive interval in milliseconds the server allows |
[out] | iMinSubscriptionLifetime | Minimum Subscription lifetime in milliseconds the server allows |
[out] | iMaxSubscriptionLifetime | Maximum Subscription lifetime in milliseconds the server allows |
[out] | iMaxRetransmissionQueueSize | Maximum number of messages in the republish queue the server allows per Subscription |
[out] | iMaxNotificationsPerPublish | Maximum number of notifications per Publish the server allows |
Implemented in ServerConfigData.
|
virtual |
Provides information about tagfile name, path und file ending used in the NodeManagerTagFile.
The default implementation returns empty strings.
[out] | defaultTagFileName | Name of the tagfile to load on server startup. |
[out] | tagFileLocation | The folder where all tagfiles are stored. |
[out] | tagFileEnding | The file ending used for new tagfiles. |
[out] | defaultFileUpdatePolicy | How the Default file gets updated (Auto, Manual). |
Reimplemented in ServerConfigData.
|
pure virtual |
Returns the settings for the thread pools used in the OPC server.
[out] | minSizeTransactionManager | Returns the number of threads that are created when the thread pool for the UaTransactionManager is created. |
[out] | maxSizeTransactionManager | Returns the maximum number of threads allowed for the thread pool in the UaTransactionManager. |
[out] | minSizeSubscriptionManager | Returns the number of threads that are created when the thread pool for the UaSubscriptionManager is created. |
[out] | maxSizeSubscriptionManager | Returns the maximum number of threads allowed for the thread pool in the UaSubscriptionManager. |
Implemented in ServerConfigData.
|
virtual |
Get UA Server SDK trace event settings.
This configuration option allows clients to get the SDK trace outputs for trace levels Errors
, Warning
and Info
via HistoryRead for Events and/or Events from the server.
Possible values are:
Disabled
History
(default) HistoryAndEvents
Traces are only sent as events or stored for historical access if the trace is active, i.e. UaAppTraceEnabled is set to true
, and UaAppTraceLevel (i.e. the server application trace level) is set at least to Errors
.
[out] | uTraceEventLevel | Configures the level of messages traced; possible values are
|
Reimplemented in ServerConfigData.
|
pure virtual |
Get the enabled settings for the different user identity tokens supported by the server.
Activating other user identity tokens than anonymous requires a user management and the implementation of ServerConfig::logonSessionUser.
[out] | bEnableAnonymous | Indicates if Anonymous login is allowed. |
[out] | bEnableUserPw | Indicates if login with user and password is activated. |
[out] | bEnableCertificate | Indicates if login with user certificate is activated. |
[out] | bEnableKerberosTicket | Indicates if login with Kerberos token is activated. |
Implemented in ServerConfigData.
Get the security policy to use when encrypting or signing the UserIdentityToken when it is passed to the server.
[out] | sSecurityPolicyUri | The SecurityPolicyUri to use when encrypting or signing the UserIdentityToken. |
Reimplemented in ServerConfigData.
|
virtual |
Get settings for exchanging certificates with local discovery server on a windows computer for registration with local windows discovery server.
[out] | bAutomaticCertificateExchange | Flag indicating if the certificates should be exchanged |
[out] | sDiscoveryServerTrustListLocation | Path of the local discovery server trust list. This is where the server copies it's certificate to. |
[out] | sDiscoveryServerStoreName | Store name used for the local discovery server in the windows certificate store |
[out] | sDiscoveryServerCertificateName | Certificate name of the local discovery server in the windows certificate store |
Reimplemented in ServerConfigData.
|
virtual |
Flag indicating if audit events are activated.
Reimplemented in ServerConfigData.
|
pure virtual |
Load the configuration from the config file.
This is the first method called after the creation of ServerConfig. This method must load all configuration options and must create all NodeManagers before the method startUp is called. The configuration can be loaded from a file, a data base or any other source to overwrite default settings defined in the constructor of the implementation class.
Implemented in ServerConfigXml, and ServerConfigIni.
|
pure virtual |
Validates the user identity token and sets the user for a session.
[out] | pSession | Interface pointer of the Session |
[out] | pUserIdentityToken | User identity token contained in an ExtensionObject used to handle different types of user identity tokens like user/password or an X509 certificate. It provides the credentials of the user associated with the Client application. The implementation of this method must use these credentials to determine whether the Client should be allowed to activate a Session and what resources the Client has access to during this Session.If the method is not able to validate the user or if the user has no right to access the server, the method must return the status code OpcUa_BadUserAccessDenied. |
|
virtual |
Removes a namespaces configuration entry for preconfigured namespaces.
[in] | namespaceIndex | Index for the namespace in the namespace table |
Reimplemented in ServerConfigData, and ServerConfigXml.
|
pure virtual |
Save the configuration to the config file.
Implemented in ServerConfigXml, and ServerConfigIni.
[in] | thumbprint | Thumbprint of the server certificate used for windows store. |
|
virtual |
Set information about tagfile name, path und file ending used in the NodeManagerTagFile.
The default implementation does nothing.
[in] | defaultTagFileName | Name of the tagfile to load on server startup. |
[in] | tagFileLocation | The folder where all tagfiles are stored. |
[in] | tagFileEnding | The file ending used for new tagfiles. |
[in] | defaultFileUpdatePolicy | How the Default file gets updated (Auto, Manual). |
Reimplemented in ServerConfigData, and ServerConfigXml.
|
pure virtual |
Shut down OPC ServerConfig.
|
pure virtual |
Start up OPC ServerConfig.
[in] | pServerManager | Interface to the central ServerManager object. This interface pointer should be stored in the NodeManager instance to have access to core module objects like the root NodeManager or the ServerConfig. |