Kanzi Connect  1.1.10
Kanzi Connect C++ API
kanzi::connect::ContentProviderIntrospector Class Reference

Class that is capable of introspecting a provided service metaclass. More...

#include <contentproviderintrospector.hpp>

Static Public Member Functions

static void copyProvidersFromXML (const string &xml, kanzi::connect::tinyxml2::XMLDocument &document, const char *rootnodename="service")
 Parses a content providers from provided xml and adds corresponding objects to xml document. More...
 
static void introspect (kanzi::connect::tinyxml2::XMLDocument &document, const string &baseUri, ContentProvider &contentProvider, const char *rootelementname="service")
 Introspects a content provider and fills in a xml document describing the content provider. More...
 
static string introspect (const string &uri, ContentProvider &contentProvider)
 Introspects a content provider and returns an xml document describing the content provider. More...
 
static string introspect (const string &baseUri, ContentProviderDescriptionSharedPtr description)
 Introspects a sub content provider and returns xml document describing it. More...
 

Detailed Description

Class that is capable of introspecting a provided service metaclass.

Member Function Documentation

◆ copyProvidersFromXML()

static void kanzi::connect::ContentProviderIntrospector::copyProvidersFromXML ( const string &  xml,
kanzi::connect::tinyxml2::XMLDocument &  document,
const char *  rootnodename = "service" 
)
static

Parses a content providers from provided xml and adds corresponding objects to xml document.

Parameters
xml[in] the xml that has structure <data-sources><data-source>..</data-source></data-sources>
document[out] xml document where-to put the data.
rootnodename[in] name of the root element whom childs the content providers should be added. defaults to "service"

◆ introspect() [1/3]

static void kanzi::connect::ContentProviderIntrospector::introspect ( kanzi::connect::tinyxml2::XMLDocument &  document,
const string &  baseUri,
ContentProvider contentProvider,
const char *  rootelementname = "service" 
)
static

Introspects a content provider and fills in a xml document describing the content provider.

Parameters
documentxml document that is extended to include content provider details.
baseUribasic uri
contentProviderthe content provider
rootelementnamename of the root element whom childs the content providers should be added. defaults to "service"

◆ introspect() [2/3]

static string kanzi::connect::ContentProviderIntrospector::introspect ( const string &  uri,
ContentProvider contentProvider 
)
static

Introspects a content provider and returns an xml document describing the content provider.

Parameters
uriThe URI for the content provider.
contentProviderThe content provider.

◆ introspect() [3/3]

static string kanzi::connect::ContentProviderIntrospector::introspect ( const string &  baseUri,
ContentProviderDescriptionSharedPtr  description 
)
static

Introspects a sub content provider and returns xml document describing it.

Parameters
baseUriThe base URI where to append to subprovider specific path.
descriptionThe content provider description.

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