ConnectionConfigurationReadIf¶

class kanzi::connect::ConnectionConfigurationReadIf¶

Interface to read connection configurations of a connect client application.

Subclassed by ConnectionConfigurationParser

Public Types

using AttributeMap = map<string, string>¶

Public Functions

virtual ~ConnectionConfigurationReadIf() = default¶: dtor

inline virtual size_t countConfigurations() const¶

return amount of configurations

Return: amount of configurations

virtual bool getConfiguration(Configuration &configurationOut) const = 0¶

Get configuration parsed from a file.

Return

True if configuration was found

Parameters

configurationOut: [out] Output parameter where the configuration is saved

virtual bool getConfiguration(const string &serverName, Configuration &configurationOut) const = 0¶

Get the specified configuration parsed from a file.

Return

True if configuration was found

Parameters

serverName: [in] Identifies the configuration to get
configurationOut: [out] Output parameter where the configuration is saved

inline virtual Configuration getConfigurationAt(size_t position) const¶

return configuration at given position

Return: configuration at specific position

virtual Configuration getConfigurationEx(const string &serverName) const = 0¶

Convenience function to get specified configuration in java classes.

Return

The specified configuration, default constructed if configuration was not found

Parameters

serverName: Identifies the configuration to get

Public Static Attributes

static constexpr const char *const ALT_ADDRESSES_ATTRIBUTE_NAME = "alt-addresses"¶: Attribute which defines alternate addresses of a server.

static constexpr const char *const BASEPATH_ATTRIBUTE_PREFIX = "basepath-"¶: Prefix for all platform specific base path attributes.

static constexpr const char *const CA_CERTIFICATE_ATTRIBUTE_NAME = "ca-certificate"¶: Attribute which defines the file name of ca-certificate.

static constexpr const char *const CERTIFICATE_ATTRIBUTE_NAME = "certificate"¶: Attribute which defines the file name of certificate.

static constexpr const char *const CONNECT_IDENTIFIER_ATTRIBUTE_NAME = "connect-identifier"¶: Attribute which defines the connect identifier for non-ip peers like shared memory.

static constexpr const char *const DEFAULT_BASEPATH_ATTRIBUTE_NAME = "basepath"¶: Default attribute to define common base path.

static constexpr const char *const HOST_IP_ATTRIBUTE_NAME = "host_ip"¶: Attribute which defines the host ip address.

static constexpr const char *const HOST_PORT_ATTRIBUTE_NAME = "host_port"¶: Attribute which defines the host port.

static constexpr const char *const IDENTITY_ATTRIBUTE_NAME = "identity"¶: is this needed?

static constexpr const char *const PRIVATEKEY_ATTRIBUTE_NAME = "privatekey"¶: Attribute which defines the file name of client private key.

static constexpr const char *const RESOURCE_PATH_ATTRIBUTE_NAME = "resource_path"¶: Attribute which defines base directory path for resource files.

static constexpr const char *const SERVERNAME_ATTRIBUTE_NAME = "servername"¶: Attribute which defines the logical server name that client uses as identification.

struct Configuration¶

Contains configuration for a single connection configuration from client to server.

Public Functions

Configuration() = default¶

Configuration(Configuration &&other) = default¶

Configuration(const Configuration &other) = default¶

Configuration &operator=(Configuration &&other) = default¶

Configuration &operator=(const Configuration &other) = default¶

Public Members

AttributeMap attributes¶: Contains attributes specifying the connection specific details.

string bearer¶: Connection bearer to use.

string name¶: Name of the client application towards server.

string serverName¶: Logical name which identifies the configuration.