.NET Based OPC UA Client/Server SDK  3.3.0.530
UnifiedAutomation.UaServer.ServerConfigurationModel Class Reference

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

Inherits UnifiedAutomation.UaServer.BaseObjectModel, and UnifiedAutomation.UaServer.IMethodDispatcher.

Inherited by UnifiedAutomation.UaServer.ApplicationConfigurationModel.

Public Member Functions

 ServerConfigurationModel ()
 Initializes a new instance of the ServerConfigurationModel class. More...
 
 ServerConfigurationModel (ServerConfigurationModel template, DummyArgument dummy=null)
 Initializes a new instance of the ServerConfigurationModel class. More...
 
virtual CallMethodEventHandler GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId)
 Gets the method dispatcher. More...
 
virtual StatusCode DispatchMethod (RequestContext context, MethodHandle methodHandle, IList< Variant > inputArguments, List< StatusCode > inputArgumentResults, List< Variant > outputArguments)
 Dispatches the method. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseObjectModel
 BaseObjectModel ()
 Initializes a new instance of the BaseObjectModel class. More...
 
 BaseObjectModel (BaseObjectModel template, DummyArgument dummy=null)
 Initializes a new instance of the BaseObjectModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
virtual ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
virtual DataValue GetValue (IMapperContext context, ModelMapping mapping)
 Gets the value associated with the mapping. More...
 
virtual bool SetValue (IMapperContext context, ModelMapping mapping, DataValue value)
 Sets the value associated with the mapping. More...
 
StatusCode GetStatusCode (string propertyName)
 Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned.
Parameters
propertyNameThe property name.
Returns
The status code of the property.

 
void SetStatusCode (string propertyName, StatusCode statusCode)
 Sets the status code of the given property. More...
 

Properties

ApplicationType ApplicationType [get, set]
 Gets or sets the ApplicationType More...
 
string ApplicationUri [get, set]
 Gets or sets the ApplicationUri More...
 
CertificateGroupFolderModel CertificateGroups [get, set]
 The CertificateGroups object organizes the certificate groups supported by the Server. More...
 
bool HasSecureElement [get, set]
 Gets or sets the HasSecureElement More...
 
uint MaxTrustListSize [get, set]
 The maximum size of the trust list in bytes. More...
 
bool MulticastDnsEnabled [get, set]
 If TRUE, the Server announces itself using multicast DNS. More...
 
string ProductUri [get, set]
 Gets or sets the ProductUri More...
 
string[] ServerCapabilities [get, set]
 Specifies the capabilities which the Server supports. More...
 
string[] SupportedPrivateKeyFormats [get, set]
 Specifies the PrivateKey formats supported by the Server. More...
 
TransactionDiagnosticsModel TransactionDiagnostics [get, set]
 Gets or sets the TransactionDiagnostics More...
 
IServerConfigurationMethods ServerConfigurationMethods [get, set]
 Gets or sets the ServerConfiguration methods. More...
 
- Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle ModelHandle [get, set]
 Gets or sets the metadata handle. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 
- Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool HasStatusCodes [get]
 true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...
 

Additional Inherited Members

- Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0
 
- Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
void RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null)
 Raises an property change event. More...
 
void RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null)
 Called when the value of a property is supposed to be changed. More...
 
bool SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null)
 Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...
 
- Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler PropertyChanged
 Occurs when a property value changes. More...
 
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...
 
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 
- Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler
< PropertyChangeRequestedEventArgs
PropertyChangeRequested
 The property change request event. More...
 
- Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler
< StatusCodeChangedEventArgs
StatusCodeChanged
 Occurs if the status code of a property was changed. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.ServerConfigurationModel.ServerConfigurationModel ( )

Initializes a new instance of the ServerConfigurationModel class.

UnifiedAutomation.UaServer.ServerConfigurationModel.ServerConfigurationModel ( ServerConfigurationModel  template,
DummyArgument  dummy = null 
)

Initializes a new instance of the ServerConfigurationModel class.

Parameters
templateThe template.
dummyDummy argument to enable writing own constructors that are called by the generated code.

Member Function Documentation

virtual StatusCode UnifiedAutomation.UaServer.ServerConfigurationModel.DispatchMethod ( RequestContext  context,
MethodHandle  methodHandle,
IList< Variant inputArguments,
List< StatusCode inputArgumentResults,
List< Variant outputArguments 
)
virtual

Dispatches the method.

Parameters
contextThe context.
methodHandleThe method handle.
inputArgumentsThe input arguments.
inputArgumentResultsThe input argument results.
outputArgumentsThe output arguments.
Returns
virtual CallMethodEventHandler UnifiedAutomation.UaServer.ServerConfigurationModel.GetMethodDispatcher ( RequestContext  context,
NodeId  objectId,
NodeId  methodId 
)
virtual

Gets the method dispatcher.

Parameters
contextThe context.
objectIdThe object id.
methodIdThe method id.
Returns

Implements UnifiedAutomation.UaServer.IMethodDispatcher.

Property Documentation

ApplicationType UnifiedAutomation.UaServer.ServerConfigurationModel.ApplicationType
getset

Gets or sets the ApplicationType

string UnifiedAutomation.UaServer.ServerConfigurationModel.ApplicationUri
getset

Gets or sets the ApplicationUri

CertificateGroupFolderModel UnifiedAutomation.UaServer.ServerConfigurationModel.CertificateGroups
getset

The CertificateGroups object organizes the certificate groups supported by the Server.

It is described in UnifiedAutomation.UaServer.CertificateGroupFolderModel.

Servers shall support the UnifiedAutomation.UaServer.CertificateGroupFolderModel.DefaultApplicationGroup and may support the UnifiedAutomation.UaServer.CertificateGroupFolderModel.DefaultHttpsGroup or the UnifiedAutomation.UaServer.CertificateGroupFolderModel.DefaultUserTokenGroup . Servers may support additional certificate groups depending on their requirements. For example, a Server with two network interfaces may need a different trust list for each interface. The second trust list would be represented as a new CertificateGroupType object organized by CertificateGroups Folder.

bool UnifiedAutomation.UaServer.ServerConfigurationModel.HasSecureElement
getset

Gets or sets the HasSecureElement

uint UnifiedAutomation.UaServer.ServerConfigurationModel.MaxTrustListSize
getset

The maximum size of the trust list in bytes.

0 means no limit.

bool UnifiedAutomation.UaServer.ServerConfigurationModel.MulticastDnsEnabled
getset

If TRUE, the Server announces itself using multicast DNS.

It can be changed by writing to the variable.

string UnifiedAutomation.UaServer.ServerConfigurationModel.ProductUri
getset

Gets or sets the ProductUri

string [] UnifiedAutomation.UaServer.ServerConfigurationModel.ServerCapabilities
getset

Specifies the capabilities which the Server supports.

The value is the same as the value reported to the LocalDiscoveryServer when the Server calls the RegisterServer2 Service.

IServerConfigurationMethods UnifiedAutomation.UaServer.ServerConfigurationModel.ServerConfigurationMethods
getset

Gets or sets the ServerConfiguration methods.

The ServerConfiguration methods.

string [] UnifiedAutomation.UaServer.ServerConfigurationModel.SupportedPrivateKeyFormats
getset

Specifies the PrivateKey formats supported by the Server.

Possible values include “PEM” (see RFC 5958, txt file) or “PFX” (see PKCS #12, pdf file). The array is empty if the Server does not allow external Clients to update the PrivateKey.

TransactionDiagnosticsModel UnifiedAutomation.UaServer.ServerConfigurationModel.TransactionDiagnostics
getset

Gets or sets the TransactionDiagnostics


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