kanzi::connect::ConnectionConfigurationReadIf Class Reference

Interface to read connection configurations of a connect client application. More...

#include <connection_configuration_read_if.hpp>

Inheritance diagram for kanzi::connect::ConnectionConfigurationReadIf:

Classes
struct	Configuration
	Contains configuration for a single connection configuration from client to server. More...

Public Types
using	AttributeMap = map< string, string >

Public Member Functions
virtual size_t	countConfigurations () const
	return amount of configurations More...
virtual bool	getConfiguration (Configuration &configurationOut) const =0
	Get configuration parsed from a file. More...
virtual bool	getConfiguration (const string &serverName, Configuration &configurationOut) const =0
	Get the specified configuration parsed from a file. More...
virtual Configuration	getConfigurationAt (size_t position) const
	return configuration at given position More...
virtual Configuration	getConfigurationEx (const string &serverName) const =0
	Convenience function to get specified configuration in java classes. More...
virtual	~ConnectionConfigurationReadIf ()=default
	dtor More...

Static Public Attributes
static constexpr const char *const	ALT_ADDRESSES_ATTRIBUTE_NAME = "alt-addresses"
	Attribute which defines alternate addresses of a server. More...
static constexpr const char *const	BASEPATH_ATTRIBUTE_PREFIX = "basepath-"
	Prefix for all platform specific base path attributes. More...
static constexpr const char *const	CA_CERTIFICATE_ATTRIBUTE_NAME = "ca-certificate"
	Attribute which defines the file name of ca-certificate. More...
static constexpr const char *const	CERTIFICATE_ATTRIBUTE_NAME = "certificate"
	Attribute which defines the file name of certificate. More...
static constexpr const char *const	CONNECT_IDENTIFIER_ATTRIBUTE_NAME = "connect-identifier"
	Attribute which defines the connect identifier for non-ip peers like shared memory. More...
static constexpr const char *const	DEFAULT_BASEPATH_ATTRIBUTE_NAME = "basepath"
	Default attribute to define common base path. More...
static constexpr const char *const	HOST_IP_ATTRIBUTE_NAME = "host_ip"
	Attribute which defines the host ip address. More...
static constexpr const char *const	HOST_PORT_ATTRIBUTE_NAME = "host_port"
	Attribute which defines the host port. More...
static constexpr const char *const	IDENTITY_ATTRIBUTE_NAME = "identity"
	is this needed? More...
static constexpr const char *const	PRIVATEKEY_ATTRIBUTE_NAME = "privatekey"
	Attribute which defines the file name of client private key. More...
static constexpr const char *const	RESOURCE_PATH_ATTRIBUTE_NAME = "resource_path"
	Attribute which defines base directory path for resource files. More...
static constexpr const char *const	SERVERNAME_ATTRIBUTE_NAME = "servername"
	Attribute which defines the logical server name that client uses as identification. More...

Detailed Description

Interface to read connection configurations of a connect client application.

Member Typedef Documentation

AttributeMap

using kanzi::connect::ConnectionConfigurationReadIf::AttributeMap = map<string, string>

Constructor & Destructor Documentation

~ConnectionConfigurationReadIf()

virtual kanzi::connect::ConnectionConfigurationReadIf::~ConnectionConfigurationReadIf ( )

virtualdefault

dtor

Member Function Documentation

countConfigurations()

virtual size_t kanzi::connect::ConnectionConfigurationReadIf::countConfigurations ( ) const

inlinevirtual

return amount of configurations

Returns

amount of configurations

Reimplemented in kanzi::connect::ConnectionConfigurationParser.

getConfiguration() [1/2]

virtual bool kanzi::connect::ConnectionConfigurationReadIf::getConfiguration ( Configuration &  configurationOut ) const

pure virtual

Get configuration parsed from a file.

Parameters

configurationOut

[out] Output parameter where the configuration is saved

Returns

True if configuration was found

Implemented in kanzi::connect::ConnectionConfigurationParser.

getConfiguration() [2/2]

virtual bool kanzi::connect::ConnectionConfigurationReadIf::getConfiguration ( const string &  serverName, Configuration &  configurationOut  ) const

pure virtual

Get the specified configuration parsed from a file.

Parameters

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

Returns

True if configuration was found

Implemented in kanzi::connect::ConnectionConfigurationParser.

getConfigurationAt()

virtual Configuration kanzi::connect::ConnectionConfigurationReadIf::getConfigurationAt ( size_t  position ) const

inlinevirtual

return configuration at given position

Returns

configuration at specific position

Reimplemented in kanzi::connect::ConnectionConfigurationParser.

getConfigurationEx()

virtual Configuration kanzi::connect::ConnectionConfigurationReadIf::getConfigurationEx ( const string &  serverName ) const

pure virtual

Convenience function to get specified configuration in java classes.

Parameters

serverName

Identifies the configuration to get

Returns

The specified configuration, default constructed if configuration was not found

Implemented in kanzi::connect::ConnectionConfigurationParser.

Member Data Documentation

ALT_ADDRESSES_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::ALT_ADDRESSES_ATTRIBUTE_NAME = "alt-addresses"

static

Attribute which defines alternate addresses of a server.

BASEPATH_ATTRIBUTE_PREFIX

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::BASEPATH_ATTRIBUTE_PREFIX = "basepath-"

static

Prefix for all platform specific base path attributes.

CA_CERTIFICATE_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::CA_CERTIFICATE_ATTRIBUTE_NAME = "ca-certificate"

static

Attribute which defines the file name of ca-certificate.

CERTIFICATE_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::CERTIFICATE_ATTRIBUTE_NAME = "certificate"

static

Attribute which defines the file name of certificate.

CONNECT_IDENTIFIER_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::CONNECT_IDENTIFIER_ATTRIBUTE_NAME = "connect-identifier"

static

Attribute which defines the connect identifier for non-ip peers like shared memory.

DEFAULT_BASEPATH_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::DEFAULT_BASEPATH_ATTRIBUTE_NAME = "basepath"

static

Default attribute to define common base path.

HOST_IP_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::HOST_IP_ATTRIBUTE_NAME = "host_ip"

static

Attribute which defines the host ip address.

HOST_PORT_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::HOST_PORT_ATTRIBUTE_NAME = "host_port"

static

Attribute which defines the host port.

IDENTITY_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::IDENTITY_ATTRIBUTE_NAME = "identity"

static

is this needed?

PRIVATEKEY_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::PRIVATEKEY_ATTRIBUTE_NAME = "privatekey"

static

Attribute which defines the file name of client private key.

RESOURCE_PATH_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::RESOURCE_PATH_ATTRIBUTE_NAME = "resource_path"

static

Attribute which defines base directory path for resource files.

SERVERNAME_ATTRIBUTE_NAME

constexpr const char* const kanzi::connect::ConnectionConfigurationReadIf::SERVERNAME_ATTRIBUTE_NAME = "servername"

static

Attribute which defines the logical server name that client uses as identification.

---

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

• connect/configuration/connection_configuration_read_if.hpp