OpcCertificateSettings Members

Initializes a new instance of the OpcCertificateSettings class using the name of the application its instance certificate information is to be represented by the settings.

C#

public OpcCertificateSettings(string applicationName)

Parameters

applicationName String

The name of the application its certificate information is to be maintained.

Exceptions

ArgumentException

The applicationName is an empty string.

ArgumentNullException

The applicationName is a null reference (Nothing in Visual Basic).

Represents the default value that is used by the OpcCertificateSettings as initial value of the KeySize property.

C#

public static readonly int DefaultKeySize

Field Value
Int32

Represents the default value that is used by the OpcCertificateSettings as initial value of the Lifetime property.

C#

public static readonly int DefaultLifetime

Field Value
Int32

Gets the name of the application its instance certificate is setup.

C#

public string ApplicationName { get; }

Property Value

String

The full qualified name of the application to identify by the certificate.

Gets or sets the uniform resource identifier of the application instance.

C#

public Uri ApplicationUri { get; set; }

Property Value

Uri

The full qualified Uri to the application instance resource identified by the certificate or a null reference (Nothing in Visual Basic). The default value is a null reference (Nothing in Visual Basic).

Gets a collection of domain names typically used by the application instance. In case of a server application the list have to contain the name of the machine used to access the server.

C#

public Collection<string> DomainNames { get; }

Property Value

Collection<String>

A Collection´1 of domain names used within the environment of the application instance (can be left empty). The default list of domain names is empty.

Remarks

In case there is no domain name defined the host name of the machine which creates the application instance certificate is used instead. In case of a server application the domain name have to be the name of the machine which is to be used by the clients to access the server.

Gets or sets the number of bits to use to create the key of the certificate.

C#

public int KeySize { get; set; }

Property Value

Int32

The number of bits (a multiple of eight) to use for the key.

Exceptions

ArgumentException

The value is not a multiple of eight.

ArgumentOutOfRangeException

The value is lower than eight.

Remarks

The default value is DefaultKeySize.

Gets or sets the number of months the certificate will be valid.

C#

public int Lifetime { get; set; }

Property Value

Int32

The number of months until the certificate will expire, starting at the month within the certificate has been created.

Exceptions

ArgumentOutOfRangeException

The value is lower than one.

Remarks

The default value is DefaultLifetime.

Gets or sets the subject name portion of the certificate.

C#

public string SubjectName { get; set; }

Property Value

String

The subject name (SN) portion of the application instance certificate or a null reference (Nothing in Visual Basic). The default value is a null reference (Nothing in Visual Basic).

Retrieves the best certificate setup for the application instance specified.

C#

[CLSCompliant(false)]
public static OpcCertificateSettings Of(IOpcApplicationInstance instance)

Parameters

instance IOpcApplicationInstance

The application instance for that the best certificate setup is to be retrieved.

Returns

OpcCertificateSettings

An instance of the OpcCertificateSettings setup using the application information provided the instance passed.

Exceptions

ArgumentNullException

The instance is a null reference (Nothing in Visual Basic).