SafEsmConfig Struct Reference

ESM Module Configuration. More...

Data Fields

mf_uns32 Version
 Structure version, SafESM_CFG_VER (1).
const char filler [4+sizeof(void *)+4]
 Reserved.
mf_uns32 Priority
mf_uns32 CacheTTL
 Time for cache objects to live in seconds.
mf_uns32 CacheLimit
 Cache size limit in KB.
char Name [256]
 Security Manager name in MFDS.
char Module [256]
 ESM module path in MFDS.
char EsmConn [256]
 ESM connection path.
char EsmUser [256]
 ESM user ID.
char EsmPass [256]
 ESM password.
const char * Config
void * Reserved
 Reserved.

Detailed Description

ESM Module Configuration.

The Init Procedure an ESM Module can expose to the ESF Manager is called when an ESM is initialized. One of the parameters is a pointer to this structure, which contains the module's configuration information from the Enterprise Server configuration repository (usually MFDS).

The use of most of these fields should be clear when the structure is compared with the Security Manager edit page in MFDS, but see the sample ESM module sources for more information.

Older versions of the interface specified a cas_esm_config_internal structure for this parameter. The two structures are equivalent; this version is more convenient for writing ESM Modules.


Field Documentation

mf_uns32 Priority

ESM priority in the list of ESMs configured for ESF in this process. The highest priority is 1.

const char* Config

A pointer to the text from the free-format configuration text area in the security manager definition. If your module uses this text, and specifies ini-file format (sections indicated by tag names in square brackets, followed by name=value pairs), you can use SafEsmApi::ParseConfig to parse it, then subsequently query the results with SafEsmApi::QueryConfig.


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