com.pcbsys.nirvana.nAdminAPI.nInterfaceManager Class Reference

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...

Inherits java::util::Observable, and com::pcbsys::nirvana::nAdminAPI::nPkgCloseListener.


Public Member Functions

void addInterface (nInterface newInterface) throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException, nAdminSecurityException
 Adds a new interface to the Realm Server.
void closed (nRealmNode node)
     * Called when the nRealmNode is closed,  for internal use only.
void delInterface (nInterface delInterface) throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException, nAdminSecurityException
 Deletes an existing Interface from the Realm Server.
nInterfaceStatus findInterface (String name) throws nAdminIllegalArgumentException
 Finds the nInterface object identified by the string supplied.
Vector getInterfaces ()
 Returns a vector of nInterfaceStatus objects that are currently configured on the Realm Server.
int getNumberOfNHP ()
 Returns the number of NHP interfaces that are currently configured on the Realm Server.
int getNumberOfNHPS ()
 Returns the number of NHPS interfaces that are currently configured on the Realm Server.
int getNumberOfNSP ()
 Returns the number of NSP interfaces that are currently configured on the Realm Server.
int getNumberOfNSPS ()
 Returns the number of NSPS interfaces that are currently configured on the Realm Server.
Vector getPluginConfiguration ()
 Returns a Vector of nInterfacePluginConfiguration objects.
void modInterface (nInterface modInterface) throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException
 Changes the existing interface so that it takes the new settings supplied.
void startInterface (nInterface inter) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nAdminIllegalArgumentException
 Starts the interface, specified in the nInterface object, on the Realm Server.
void stopInterface (nInterface inter) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nAdminIllegalArgumentException
 Stops the specified interface on the Realm Server.

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

void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.addInterface ( nInterface  newInterface  )  throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException, nAdminSecurityException

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
nAdminSecurityException is thrown if used on a virtual realm

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

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

    *

Parameters:
node The nRealmNode which has been closed.     *

void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.delInterface ( nInterface  delInterface  )  throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException, nAdminSecurityException

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
nAdminSecurityException is thrown if used on a virtual realm

nInterfaceStatus com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.findInterface ( String  name  )  throws nAdminIllegalArgumentException

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

Vector com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getInterfaces (  ) 

Returns a vector of nInterfaceStatus objects that are currently configured on the Realm Server.

Returns:
a Vector of nInterfaceStatus objects
See also:
nInterfaceStatus

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

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

Returns:
a count of NHP interfaces

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

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

Returns:
a count of NHPS interfaces

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

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

Returns:
a count of NSP interfaces

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

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

Returns:
a count of NSPS interfaces

Vector com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getPluginConfiguration (  ) 

Returns a Vector of nInterfacePluginConfiguration objects.

Returns:
Vector
See also:
nInterfacePluginConfiguration

void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.modInterface ( nInterface  modInterface  )  throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException

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

void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.startInterface ( nInterface  inter  )  throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nAdminIllegalArgumentException

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

void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.stopInterface ( nInterface  inter  )  throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nAdminIllegalArgumentException

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