com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration Class Reference

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

Inherited by com.pcbsys.nirvana.nAdminAPI.nRealmXMLImport.nPluginConfig.

Public Member Functions

nPluginConfigEntry elementAt (int index)
 Get the Config Entry specified by the index. More...
 
String getMountPoint ()
 Returns the URI where the Realm Server will pass the request off to this plugin. More...
 
String getName ()
 Return the name of the plugin. More...
 
 nPluginConfiguration (nInterfacePluginConfiguration config, String URI)
 Constructs an empty configuration object binding the specified nInterfacePluginConfiguration to the URI. More...
 
int size ()
 Returns the total number of configuration entries for this plugin. More...
 
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 ( 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

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

Get the Config Entry specified by the index.

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

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

Returns
URI mount point.
String com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.getName ( )

Return the name of the plugin.

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

Returns
string name.
int com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.size ( )

Returns the total number of configuration entries for this plugin.

Returns
integer size.
String com.pcbsys.nirvana.nAdminAPI.nPluginConfiguration.toString ( )

Returns the name of the configuration.

Returns
String name