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

Configuration for the ear 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.
 
EarServerStatusReportConfiguration 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.
 
EarServerInternals 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 ear server.

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

Example:

Definition at line 11135 of file ConfigurationObjects.h.

Constructor & Destructor Documentation

◆ EarServerConfiguration()

AppConfigurationObjects::EarServerConfiguration::EarServerConfiguration ( )
inline

Definition at line 11184 of file ConfigurationObjects.h.

Member Function Documentation

◆ clear()

void AppConfigurationObjects::EarServerConfiguration::clear ( )
inline

Definition at line 11189 of file ConfigurationObjects.h.

Member Data Documentation

◆ certStoreFileName

std::string AppConfigurationObjects::EarServerConfiguration::certStoreFileName

Path to the certificate store.

Definition at line 11167 of file ConfigurationObjects.h.

◆ certStorePasswordHex

std::string AppConfigurationObjects::EarServerConfiguration::certStorePasswordHex

Hex password for the certificate store (if any)

Definition at line 11170 of file ConfigurationObjects.h.

◆ configurationCheckSignalName

std::string AppConfigurationObjects::EarServerConfiguration::configurationCheckSignalName

Name to use for signalling a configuration check.

Definition at line 11176 of file ConfigurationObjects.h.

◆ enginePolicy

EnginePolicy AppConfigurationObjects::EarServerConfiguration::enginePolicy

The policy to be used for the underlying Engage Engine.

Definition at line 11173 of file ConfigurationObjects.h.

◆ externalHealthCheckResponder

ExternalHealthCheckResponder AppConfigurationObjects::EarServerConfiguration::externalHealthCheckResponder

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

See also
ExternalHealthCheckResponder

Definition at line 11161 of file ConfigurationObjects.h.

◆ fipsCrypto

FipsCryptoSettings AppConfigurationObjects::EarServerConfiguration::fipsCrypto

[Optional] Settings for the FIPS crypto.

Definition at line 11179 of file ConfigurationObjects.h.

◆ groupsConfigurationFileCheckSecs

int AppConfigurationObjects::EarServerConfiguration::groupsConfigurationFileCheckSecs

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

Definition at line 11155 of file ConfigurationObjects.h.

◆ groupsConfigurationFileCommand

std::string AppConfigurationObjects::EarServerConfiguration::groupsConfigurationFileCommand

Command-line to execute that returns a configuration.

Definition at line 11152 of file ConfigurationObjects.h.

◆ groupsConfigurationFileName

std::string AppConfigurationObjects::EarServerConfiguration::groupsConfigurationFileName

Name of a file containing the ear configuration.

Definition at line 11149 of file ConfigurationObjects.h.

◆ id

std::string AppConfigurationObjects::EarServerConfiguration::id

A unqiue identifier for the EAR server.

Definition at line 11143 of file ConfigurationObjects.h.

◆ internals

EarServerInternals AppConfigurationObjects::EarServerConfiguration::internals

Internal settings.

Definition at line 11164 of file ConfigurationObjects.h.

◆ nsm

NsmConfiguration AppConfigurationObjects::EarServerConfiguration::nsm

[Optional] Settings for NSM.

Definition at line 11182 of file ConfigurationObjects.h.

◆ serviceConfigurationFileCheckSecs

int AppConfigurationObjects::EarServerConfiguration::serviceConfigurationFileCheckSecs

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

Definition at line 11146 of file ConfigurationObjects.h.

◆ statusReport

EarServerStatusReportConfiguration AppConfigurationObjects::EarServerConfiguration::statusReport

Details for producing a status report.

See also
EarServerStatusReportConfiguration

Definition at line 11158 of file ConfigurationObjects.h.


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