This class exposes the Realm Servers interface management API so that the control and management of the interfaces can be performed by an authorised Administrator. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nInterfaceManager:

Public Member Functions
virtual void	addInterface (nInterface newInterface)
	Adds a new interface to the Realm Server. More...

virtual void	closed (nRealmNode node)
	Called when the nRealmNode is closed, for internal use only. More...

virtual void	delInterface (nInterface delInterface)
	Deletes an existing Interface from the Realm Server. More...

virtual nInterfaceStatus	findInterface (string name)
	Finds the nInterface object identified by the string supplied More...

virtual ArrayList	getInterfaces ()
	Returns an ArrayList of nInterfaceStatus objects that are currently configured on the Realm Server More...

virtual int	getNumberOfNHP ()
	Returns the number of NHP interfaces that are currently configured on the Realm Server More...

virtual int	getNumberOfNHPS ()
	Returns the number of NHPS interfaces that are currently configured on the Realm Server More...

virtual int	getNumberOfNSP ()
	Returns the number of NSP interfaces that are currently configured on the Realm Server More...

virtual int	getNumberOfNSPS ()
	Returns the number of NSPS interfaces that are currently configured on the Realm Server More...

virtual int	getNumberOfSHM ()
	Returns the number of SHM interfaces that are currently configured on the Realm Server More...

virtual ArrayList	getPluginConfiguration ()
	Returns an ArrayList of nInterfacePluginConfiguration objects More...

virtual void	modInterface (nInterface modInterface)
	Changes the existing interface so that it takes the new settings supplied. More...

virtual void	startInterface (nInterface inter)
	Starts the interface, specified in the nInterface object, on the Realm Server More...

virtual void	stopInterface (nInterface inter)
	Stops the specified interface on the Realm Server More...

Public Member Functions inherited from com.pcbsys.nirvana.client.Observable
void	addObserver (IObserver o)
	Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More...

int	countObservers ()
	Returns the number of observers of this `Observable` object. More...

void	deleteObserver (IObserver o)
	Deletes an observer from the set of observers of this object. More...

void	deleteObservers ()
	Clears the observer list so that this object no longer has any observers. More...

bool	hasChanged ()
	Tests if this object has changed. More...

void	notifyObservers ()
	If this object has changed, as indicated by the `hasChanged` method, then notify all of its observers and then call the `clearChanged` method to indicate that this object has no longer changed. More...

void	notifyObservers (Object arg)
	If this object has changed, as indicated by the More...

	Observable ()
	Construct an Observable with zero Observers. More...

Additional Inherited Members
Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable
void	clearChanged ()
	Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the `hasChanged` method will now return `false`. More...

void	setChanged ()
	Marks this `Observable` object as having been changed; the `hasChanged` method will now return `true`. More...

Detailed Description

This class exposes the Realm Servers interface management API so that the control and management of the interfaces can be performed by an authorised Administrator.

Member Function Documentation

virtual void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.addInterface ( nInterface newInterface )

virtual

Adds a new interface to the Realm Server.

If Autostart is set to true then the interface is also started

Parameters

newInterface The new interface configuration

Exceptions

nSessionNotConnectedException	is thrown if the underlying session to perform the AdminAPI request is not connected
nUnexpectedResponseException	is thrown if the server responds with an unexpected protocol response
nRequestTimedOutException	is thrown if the protocol request times out
nAdminIllegalArgumentException	is thrown if null is passed as the interface to be added

virtual void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.closed ( nRealmNode node )

virtual

Called when the nRealmNode is closed, for internal use only.

Parameters

node	The nRealmNode which has been closed

virtual void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.delInterface ( nInterface delInterface )

virtual

Deletes an existing Interface from the Realm Server.

All current connections on this interface are disconnected immediatly.

Parameters

delInterface The interface to delete

Exceptions

nSessionNotConnectedException	is thrown if the underlying session to perform the AdminAPI request is not connected
nUnexpectedResponseException	is thrown if the server responds with an unexpected protocol response
nRequestTimedOutException	is thrown if the protocol request times out
nAdminIllegalArgumentException	if null is passed as the interface to be added

virtual nInterfaceStatus com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.findInterface ( string name )

virtual

Finds the nInterface object identified by the string supplied

Parameters

name	null if the interface does not exist

Returns: an nInterface Status object for the nInterface found or null of none could be found.

Exceptions

nAdminIllegalArgumentException if null or a zero length string is passed as the name of the interface to be found

virtual ArrayList com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getInterfaces ( )

virtual

Returns an ArrayList of nInterfaceStatus objects that are currently configured on the Realm Server

nInterfaceStatus

Returns: ArrayList of nInterfaceStatus objects

virtual int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNHP ( )

virtual

Returns the number of NHP interfaces that are currently configured on the Realm Server

nInterfaceStatus

Returns: a count of NHP interfaces

virtual int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNHPS ( )

virtual

Returns the number of NHPS interfaces that are currently configured on the Realm Server

nInterfaceStatus

Returns: a count of NHPS interfaces

virtual int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNSP ( )

virtual

Returns the number of NSP interfaces that are currently configured on the Realm Server

nInterfaceStatus

Returns: a count of NSP interfaces

virtual int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNSPS ( )

virtual

Returns the number of NSPS interfaces that are currently configured on the Realm Server

nInterfaceStatus

Returns: a count of NSPS interfaces

virtual int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfSHM ( )

virtual

Returns the number of SHM interfaces that are currently configured on the Realm Server

nInterfaceStatus

Returns: a count of SHM interfaces

virtual ArrayList com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getPluginConfiguration ( )

virtual

Returns an ArrayList of nInterfacePluginConfiguration objects

nInterfacePluginConfiguration

Returns: ArrayList

virtual void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.modInterface ( nInterface modInterface )

virtual

Changes the existing interface so that it takes the new settings supplied.

This method will automatically start and stop the interface.

Note : When this method is called in the interface that you are connected to, the interface will drop your connection and you will be either reconnected and this method will return or an Exception will be thrown.

Parameters

modInterface Changed settings for the interface

Exceptions

nSessionNotConnectedException	is thrown if the underlying session to perform the AdminAPI request is not connected
nUnexpectedResponseException	is thrown if the server responds with an unexpected protocol response
nRequestTimedOutException	is thrown if the protocol request times out
nAdminIllegalArgumentException	if null is passed as the interface to be deleted

virtual void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.startInterface ( nInterface inter )

virtual

Starts the interface, specified in the nInterface object, on the Realm Server

Parameters

inter The interface to start

Exceptions

nSessionNotConnectedException	is thrown if the underlying session to perform the AdminAPI request is not connected
nRequestTimedOutException	is thrown if the protocol request times out
nAdminIllegalArgumentException	if null is passed as the interface to be started, or the interface specified can not be found

virtual void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.stopInterface ( nInterface inter )

virtual

Stops the specified interface on the Realm Server

Parameters

inter The interface to stop

Exceptions

nSessionNotConnectedException	is thrown if the underlying session to perform the AdminAPI request is not connected
nRequestTimedOutException	is thrown if the protocol request times out
nAdminIllegalArgumentException	if null is passed as the interface to be stopped, or the interface specified can not be found

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation