ContentAdapterManager

class kanzi::connect::ContentAdapterManager

Abstract class to manage connection adapters.

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

Subclassed by AbstractConnectDataSource, ContentAdapter

Public Types

typedef vector<ContentAdapterSharedPtr> AdapterContainer

Public Functions

explicit ContentAdapterManager(ContextSharedPtr context, DataSource *dataSource)

Constructor.

Parameters

  • context – Gateway to content server.

  • dataSource – The datasource instance which owns the ContentAdapterManager

explicit ContentAdapterManager(DataSource *dataSource)

Constructor.

Parameters

dataSource – The datasource instance which owns the ContentAdapterManager

virtual ~ContentAdapterManager() = default

dtor

void addAdapter(ContentAdapterSharedPtr adapter)

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

Parameters

adapter – Adapter to add.

virtual ContentAdapterSharedPtr createAdapter(const string &serverName, const ContentAdapterConfigurationSharedPtr config, Domain *domain)

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.

void destroyAllAdapters()

Stops and cleans up all adapters.

ContentAdapterSharedPtr 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.

ContentAdapterSharedPtr 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.

ContentAdapterManager::AdapterContainer getAdapters()

Retrieves all currently known adapters.

Returns

container full of adapters.

ContextSharedPtr getContext() const

Returns gateway to Kanzi Connect server.

Returns

Kanzi Connect Context.

void initializeAllAdapters(DataObjectSharedPtr root)

Initializes all adapters.

void removeAdapter(ContentAdapterSharedPtr adapter)

Removes adapter from list of adapters.

Parameters

adapter – Adapter to remove.

void setContext(ContextSharedPtr context)

Set gateway to Kanzi Connect server.

Parameters

context – The context instance to set

virtual ContentAdapterSharedPtr startAdapter(const string &serverName, DataObjectSharedPtr root, const ContentAdapterConfigurationSharedPtr config)

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.

void startAllAdapters()

Starts all adapters.

virtual void stopAdapter(ContentAdapterSharedPtr adapter)

Stops an existing adapter.

Parameters

adapter – Adapter to stop.

void stopAllAdapters()

Stops all existing adapters.