com::pcbsys::nirvana::nAdminAPI::nPluginConfiguration Class Reference

This class contains the configuration context for a single plugin on a single HTTP type interface. More...

#include <nPluginConfiguration.h>

Inherits CountableObject.

Public Member Functions
std::list< nPluginConfigEntry * > &	getConfiguration ()
	Get the list of config entries for this plugin. More...
virtual const std::string &	getMountPoint ()
	Returns the URI where the Realm Server will pass the request off to this plugin. More...
const std::string &	getName ()
	Return the name of the plugin. More...
	nPluginConfiguration (const std::string &name, const std::string &mount)
	Constructs an empty configuration object binding the specified nInterfacePluginConfiguration to the URI. More...
std::string	toString ()
	Returns the name of the configuration. More...

Detailed Description

This class contains the configuration context for a single plugin on a single HTTP type interface.

A single interface can have many nPluginConfiguration objects defined, each one specifying what type of processing is done within the URI of the request.

Constructor & Destructor Documentation

com::pcbsys::nirvana::nAdminAPI::nPluginConfiguration::nPluginConfiguration	(	const std::string &	name,
		const std::string &	mount
	)

Constructs an empty configuration object binding the specified nInterfacePluginConfiguration to the URI.

Parameters

name.
mount	where to bind.

Member Function Documentation

std::list<nPluginConfigEntry*>& com::pcbsys::nirvana::nAdminAPI::nPluginConfiguration::getConfiguration

(

)

Get the list of config entries for this plugin.

Returns

list of config entries.

virtual const std::string& com::pcbsys::nirvana::nAdminAPI::nPluginConfiguration::getMountPoint ( )

virtual

Returns the URI where the Realm Server will pass the request off to this plugin.

Returns

String mount point.

const std::string& com::pcbsys::nirvana::nAdminAPI::nPluginConfiguration::getName

(

)

Return the name of the plugin.

This would be the type of plugin, XML, SOAP, file etc.

Returns

string name.

std::string com::pcbsys::nirvana::nAdminAPI::nPluginConfiguration::toString

(

)

Returns the name of the configuration.

Returns

String name