Abstract class to manage connection adapters. More...

#include <content_adapter_manager.hpp>

Inheritance diagram for kanzi::connect::ContentAdapterManager:

Public Types
typedef vector< ContentAdapterSharedPtr >	AdapterContainer

Public Member Functions
void	addAdapter (ContentAdapterSharedPtr adapter)
	Adds new adapter to list of adapters, but does not set up or start it.

	ContentAdapterManager (ContextSharedPtr context, DataSource *dataSource)
	Constructor.

	ContentAdapterManager (DataSource *dataSource)
	Constructor.

virtual ContentAdapterSharedPtr	createAdapter (const string &serverName, const ContentAdapterConfigurationSharedPtr config, Domain *domain)
	Creates a standard adapter.

void	destroyAllAdapters ()
	Stops and cleans up all adapters.

ContentAdapterSharedPtr	findDynamicSource (const string &name)
	Locates a dynamic source with given name.

ContentAdapterSharedPtr	findSource (const string &name)
	Locates a source with given name.

ContentAdapterManager::AdapterContainer	getAdapters ()
	Retrieves all currently known adapters.

ContextSharedPtr	getContext () const
	Returns gateway to Kanzi Connect server.

void	initializeAllAdapters (DataObjectSharedPtr root)
	Initializes all adapters.

void	removeAdapter (ContentAdapterSharedPtr adapter)
	Removes adapter from list of adapters.

void	setContext (ContextSharedPtr context)
	Set gateway to Kanzi Connect server.

virtual ContentAdapterSharedPtr	startAdapter (const string &serverName, DataObjectSharedPtr root, const ContentAdapterConfigurationSharedPtr config)
	Instantiates and starts new adapter according to given parameters.

void	startAllAdapters ()
	Starts all adapters.

virtual void	stopAdapter (ContentAdapterSharedPtr adapter)
	Stops an existing adapter.

void	stopAllAdapters ()
	Stops all existing adapters.

virtual	~ContentAdapterManager ()=default
	dtor

Protected Attributes
DataSource *	m_dataSource
	The instance which owns the data objects managed by content adapters.

Detailed Description

Abstract class to manage connection adapters.

Allows to start & stop new adapters and abstracts their lifetime management.

Member Typedef Documentation

◆ AdapterContainer

typedef vector<ContentAdapterSharedPtr> kanzi::connect::ContentAdapterManager::AdapterContainer

Constructor & Destructor Documentation

◆ ContentAdapterManager() [1/2]

kanzi::connect::ContentAdapterManager::ContentAdapterManager	(	ContextSharedPtr	context,
		DataSource *	dataSource )

explicit

Constructor.

Parameters

context	Gateway to content server.
dataSource	The datasource instance which owns the ContentAdapterManager

◆ ContentAdapterManager() [2/2]

kanzi::connect::ContentAdapterManager::ContentAdapterManager ( DataSource * dataSource )

explicit

Constructor.

Parameters

dataSource The datasource instance which owns the ContentAdapterManager

◆ ~ContentAdapterManager()

virtual kanzi::connect::ContentAdapterManager::~ContentAdapterManager ( )

virtualdefault

dtor

Member Function Documentation

◆ addAdapter()

void kanzi::connect::ContentAdapterManager::addAdapter ( ContentAdapterSharedPtr adapter )

Adds new adapter to list of adapters, but does not set up or start it.

Parameters

adapter Adapter to add.

◆ createAdapter()

virtual ContentAdapterSharedPtr kanzi::connect::ContentAdapterManager::createAdapter	(	const string &	serverName,
		const ContentAdapterConfigurationSharedPtr	config,
		Domain *	domain )

virtual

Creates a standard adapter.

Parameters

serverName	Identification of the server connection this content adapter belongs to
config	Configuration for the new adapter.
domain	UI domain.

Returns: New adapter instance.

◆ destroyAllAdapters()

void kanzi::connect::ContentAdapterManager::destroyAllAdapters ( )

Stops and cleans up all adapters.

◆ findDynamicSource()

ContentAdapterSharedPtr kanzi::connect::ContentAdapterManager::findDynamicSource ( const string & name )

Locates a dynamic source with given name.

Parameters

name	name used to lookup

Returns: pointer to content adapter. Empty pointer if not found.

◆ findSource()

ContentAdapterSharedPtr kanzi::connect::ContentAdapterManager::findSource ( const string & name )

Locates a source with given name.

Parameters

name	name/uri used to lookup

Returns: pointer to content adapter. Empty pointer if not found.

◆ getAdapters()

ContentAdapterManager::AdapterContainer kanzi::connect::ContentAdapterManager::getAdapters ( )

Retrieves all currently known adapters.

Returns: container full of adapters.

◆ getContext()

ContextSharedPtr kanzi::connect::ContentAdapterManager::getContext ( ) const

Returns gateway to Kanzi Connect server.

Returns: Kanzi Connect Context.

◆ initializeAllAdapters()

void kanzi::connect::ContentAdapterManager::initializeAllAdapters ( DataObjectSharedPtr root )

Initializes all adapters.

◆ removeAdapter()

void kanzi::connect::ContentAdapterManager::removeAdapter ( ContentAdapterSharedPtr adapter )

Removes adapter from list of adapters.

Parameters

adapter Adapter to remove.

◆ setContext()

void kanzi::connect::ContentAdapterManager::setContext ( ContextSharedPtr context )

Set gateway to Kanzi Connect server.

Parameters

context The context instance to set

◆ startAdapter()

virtual ContentAdapterSharedPtr kanzi::connect::ContentAdapterManager::startAdapter	(	const string &	serverName,
		DataObjectSharedPtr	root,
		const ContentAdapterConfigurationSharedPtr	config )

virtual

Instantiates and starts new adapter according to given parameters.

Parameters

serverName	Identifies the server connection the adapter to start belongs to
root	Root of the data object tree where adapter is set up.
config	Configuration for new adapter.

Returns: New adapter instance that is up and running.

◆ startAllAdapters()

void kanzi::connect::ContentAdapterManager::startAllAdapters ( )

Starts all adapters.

◆ stopAdapter()

virtual void kanzi::connect::ContentAdapterManager::stopAdapter ( ContentAdapterSharedPtr adapter )

virtual

Stops an existing adapter.

Parameters

adapter Adapter to stop.

◆ stopAllAdapters()

void kanzi::connect::ContentAdapterManager::stopAllAdapters ( )

Stops all existing adapters.

Member Data Documentation

◆ m_dataSource

DataSource* kanzi::connect::ContentAdapterManager::m_dataSource

protected

The instance which owns the data objects managed by content adapters.

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

connect/kanzi_adaptation/datasource/content_adapter_manager.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ AdapterContainer

Constructor & Destructor Documentation

◆ ContentAdapterManager() [1/2]

◆ ContentAdapterManager() [2/2]

◆ ~ContentAdapterManager()

Member Function Documentation

◆ addAdapter()

◆ createAdapter()

◆ destroyAllAdapters()

◆ findDynamicSource()

◆ findSource()

◆ getAdapters()

◆ getContext()

◆ initializeAllAdapters()

◆ removeAdapter()

◆ setContext()

◆ startAdapter()

◆ startAllAdapters()

◆ stopAdapter()

◆ stopAllAdapters()

Member Data Documentation

◆ m_dataSource