[This is preliminary documentation and is subject to change.]
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class HttpsProperties : HttpProperties
<SerializableAttribute> _ Public Class HttpsProperties _ Inherits HttpProperties
[SerializableAttribute] public ref class HttpsProperties : public HttpProperties
Members| All Members | Constructors | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | HttpsPropertiesHttpsPropertiesNew()() | Constructor |
| HttpsPropertiesHttpsPropertiesNew(HttpProperties) | Constructs an HttpsProperties object that inherits values from a parent |
 | CertStore |
Gets the certificate store to open. Defaults to "My", which represents the "Personal" folder
in the Windows certificate manager
|
| CertStoreLocation |
Gets the certificate store location. Defaults to CurrentUser
|
| ClientAuthLevel |
Returns the SIF Authentication Level required by the agent for incoming https connections
|
| ClientCertName |
Gets the certificate that the agent should use for client authentication when connecting
to the ZIS. This is only done if the agent is already connecting using SSL If not specified,
the first applicable certificate in the store
that is valid for client authentication and not out of date will be used
|
| Protocol | Gets the name of the transport protocol associated with these properties (Overrides HttpProperties.Protocol.) |
| SSLCertFile |
Gets the filename of a certificate to use for SSL Authentication. The certificate must be
in the PFX/P12 format and have a ".pfx" extension.
|
| SSLCertFilePassword |
Gets and sets the password to use for the PFX/P12 certificate, if necessary
|
| SSLCertName |
Gets the certificate that should be used for SSL when the agent is running as a server
(Https PUSH mode). If not specified, the first applicable certificate in the store
that is valid for server authentication and not out of date will be used
|
RemarksTo set default HTTPS properties, call the Agent.DefaultHttpsProperties method to obtain the agent's default properties for this transport protocol. The defaults are used by all zones that do not explicitly set their own transport properties. Alternatively, you may set the default value of a property by modifying the appropriate setting in the "appSettings" section of the application config file. Property names follow the naming convention adk.transport.https.property (e.g. adk.transport.https.port).
No default HTTP or HTTPS port is assigned to push mode agents by the class framework. It is the developer's responsibility to assign a default port. To do so, use one of the following methods:
- Set the adk.transport.https.port system property prior to creating your agent's Zones and/or Topics. This property can be set programmatically by adding it to the "appSettings" node in the application's configuration file.
- Set the Port property on the default HttpProperties and/or HttpsProperties objects prior to creating and your agent's Zones instances.
- Use an agent configuration file that can be read by the AgentConfig class
Examples
CopyC#// Set transport properties for HTTP Agent myAgent = ... HttpProperties http = agent.DefaultHttpProperties; http.Port = 7081; // Set transport properties for HTTPS HttpsProperties https = agent.DefaultHttpsProperties; https.setPort( 7082 ); ...
Inheritance Hierarchy| Object | ||||
 | AdkProperties | |||
| TransportProperties | |||
| HttpProperties | |||
| HttpsProperties | |||