com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration Class Reference

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

Public Member Functions

virtual nPluginConfigEntry elementAt (int index)
 Get the Config Entry specified by the index. More...
 
virtual string getMountPoint ()
 Returns the URI where the Realm Server will pass the request off to this plugin. More...
 
 nPluginConfiguration (nInterfacePluginConfiguration config, string URI)
 Constructs an empty configuration object binding the specified nInterfacePluginConfiguration to the URI. More...
 
virtual int size ()
 Returns the total number of configuration entries for this plugin. More...
 
override string ToString ()
 Returns the name of the configuration More...
 

Properties

virtual string Name [get]
 Return the name of the plugin. 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 ( nInterfacePluginConfiguration  config,
string  URI 
)

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

Parameters
configto bind.
URIwhere to bind.

Member Function Documentation

virtual nPluginConfigEntry com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.elementAt ( int  index)
virtual

Get the Config Entry specified by the index.

Parameters
indexof the config entry to retreive
Returns
config entry.
virtual string com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.getMountPoint ( )
virtual

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

Returns
URI mount point.
virtual int com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.size ( )
virtual

Returns the total number of configuration entries for this plugin.

Returns
integer size.
override string com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.ToString ( )

Returns the name of the configuration

Returns
String name

Property Documentation

virtual string com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.Name
get

Return the name of the plugin.

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

Returns
string name.