Engage Engine API  1.251.9091
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
AppConfigurationObjects::EngateServerConfiguration Class Reference

Configuration for the engate server. 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 id
 A unqiue identifier for the EAR server.
 
int serviceConfigurationFileCheckSecs
 Number of seconds between checks to see if the service configuration has been updated. Default is 60.
 
std::string groupsConfigurationFileName
 Name of a file containing the ear configuration.
 
std::string groupsConfigurationFileCommand
 Command-line to execute that returns a configuration.
 
int groupsConfigurationFileCheckSecs
 Number of seconds between checks to see if the configuration has been updated. Default is 60.
 
EngateServerStatusReportConfiguration statusReport
 Details for producing a status report.
 
ExternalHealthCheckResponder externalHealthCheckResponder
 Details concerning the server's interaction with an external health-checker such as a load-balancer.
 
EngateServerInternals internals
 Internal settings.
 
std::string certStoreFileName
 Path to the certificate store.
 
std::string certStorePasswordHex
 Hex password for the certificate store (if any)
 
EnginePolicy enginePolicy
 The policy to be used for the underlying Engage Engine.
 
std::string configurationCheckSignalName
 Name to use for signalling a configuration check.
 
FipsCryptoSettings fipsCrypto
 [Optional] Settings for the FIPS crypto.
 
NsmConfiguration nsm
 [Optional] Settings for NSM.
 
- Public Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
nlohmann::json _attached
 

Additional Inherited Members

- Protected Attributes inherited from AppConfigurationObjects::ConfigurationObjectBase
bool _documenting
 

Detailed Description

Configuration for the engate server.

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

Example:

Definition at line 12213 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EngateServerConfiguration()

AppConfigurationObjects::EngateServerConfiguration::EngateServerConfiguration ( )
inline

Definition at line 12262 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EngateServerConfiguration::clear ( )
inline

Definition at line 12267 of file ConfigurationObjects.h.

Member Data Documentation

◆ certStoreFileName

std::string AppConfigurationObjects::EngateServerConfiguration::certStoreFileName

Path to the certificate store.

Definition at line 12245 of file ConfigurationObjects.h.

◆ certStorePasswordHex

std::string AppConfigurationObjects::EngateServerConfiguration::certStorePasswordHex

Hex password for the certificate store (if any)

Definition at line 12248 of file ConfigurationObjects.h.

◆ configurationCheckSignalName

std::string AppConfigurationObjects::EngateServerConfiguration::configurationCheckSignalName

Name to use for signalling a configuration check.

Definition at line 12254 of file ConfigurationObjects.h.

◆ enginePolicy

EnginePolicy AppConfigurationObjects::EngateServerConfiguration::enginePolicy

The policy to be used for the underlying Engage Engine.

Definition at line 12251 of file ConfigurationObjects.h.

◆ externalHealthCheckResponder

ExternalHealthCheckResponder AppConfigurationObjects::EngateServerConfiguration::externalHealthCheckResponder

Details concerning the server's interaction with an external health-checker such as a load-balancer.

See also
ExternalHealthCheckResponder

Definition at line 12239 of file ConfigurationObjects.h.

◆ fipsCrypto

FipsCryptoSettings AppConfigurationObjects::EngateServerConfiguration::fipsCrypto

[Optional] Settings for the FIPS crypto.

Definition at line 12257 of file ConfigurationObjects.h.

◆ groupsConfigurationFileCheckSecs

int AppConfigurationObjects::EngateServerConfiguration::groupsConfigurationFileCheckSecs

Number of seconds between checks to see if the configuration has been updated. Default is 60.

Definition at line 12233 of file ConfigurationObjects.h.

◆ groupsConfigurationFileCommand

std::string AppConfigurationObjects::EngateServerConfiguration::groupsConfigurationFileCommand

Command-line to execute that returns a configuration.

Definition at line 12230 of file ConfigurationObjects.h.

◆ groupsConfigurationFileName

std::string AppConfigurationObjects::EngateServerConfiguration::groupsConfigurationFileName

Name of a file containing the ear configuration.

Definition at line 12227 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::EngateServerConfiguration::id

A unqiue identifier for the EAR server.

Definition at line 12221 of file ConfigurationObjects.h.

◆ internals

EngateServerInternals AppConfigurationObjects::EngateServerConfiguration::internals

Internal settings.

Definition at line 12242 of file ConfigurationObjects.h.

◆ nsm

NsmConfiguration AppConfigurationObjects::EngateServerConfiguration::nsm

[Optional] Settings for NSM.

Definition at line 12260 of file ConfigurationObjects.h.

◆ serviceConfigurationFileCheckSecs

int AppConfigurationObjects::EngateServerConfiguration::serviceConfigurationFileCheckSecs

Number of seconds between checks to see if the service configuration has been updated. Default is 60.

Definition at line 12224 of file ConfigurationObjects.h.

◆ statusReport

EngateServerStatusReportConfiguration AppConfigurationObjects::EngateServerConfiguration::statusReport

Details for producing a status report.

See also
EngateServerStatusReportConfiguration

Definition at line 12236 of file ConfigurationObjects.h.


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