Engage Engine API  1.244.9084
Loading...
Searching...
No Matches
AppConfigurationObjects::SecurityCertificate Class Reference

Configuration for a Security Certificate used in various configurations. More...

#include <ConfigurationObjects.h>

Inherits AppConfigurationObjects::ConfigurationObjectBase.

Public Member Functions

void clear ()
 
- Public Member Functions inherited from AppConfigurationObjects::ConfigurationObjectBase
virtual void initForDocumenting ()
 
virtual std::string toString ()
 
virtual bool isDocumenting () const
 

Public Attributes

std::string certificate
 Contains the PEM-formatted text of the certificate, OR, a reference to a PEM file denoted by "@file://" URI, OR a reference to named element in the currently active certificate store using the "@certstore://" URI.
 
std::string key
 As for above but for certificate's private key.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Configuration for a Security Certificate used in various configurations.

Helper C++ class to serialize and de-serialize SecurityCertificate JSON

Example:

{
"certificate": "",
"key": ""
}
See also
ConfigurationObjects::EnginePolicySecurity, ConfigurationObjects::RallypointServer

Definition at line 5790 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ SecurityCertificate()

AppConfigurationObjects::SecurityCertificate::SecurityCertificate ( )
inline

Definition at line 5807 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::SecurityCertificate::clear ( )
inline

Definition at line 5812 of file ConfigurationObjects.h.

Member Data Documentation

◆ certificate

std::string AppConfigurationObjects::SecurityCertificate::certificate

Contains the PEM-formatted text of the certificate, OR, a reference to a PEM file denoted by "@file://" URI, OR a reference to named element in the currently active certificate store using the "@certstore://" URI.

Definition at line 5802 of file ConfigurationObjects.h.

◆ key

std::string AppConfigurationObjects::SecurityCertificate::key

As for above but for certificate's private key.

Definition at line 5805 of file ConfigurationObjects.h.


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