- com
- pcbsys
- nirvana
- nAdminAPI
- nInterfaceManager
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 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. More... | |
void | closed (nRealmNode node) |
Called when the nRealmNode is closed, �for internal use only. More... | |
void | delInterface (nInterface delInterface) throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException, nAdminSecurityException |
Deletes an existing Interface from the Realm Server. More... | |
nInterfaceStatus | findInterface (String name) throws nAdminIllegalArgumentException |
Finds the nInterface object identified by the string supplied. More... | |
Vector | getInterfaces () |
Returns a vector of nInterfaceStatus objects that are currently configured on the Realm Server. More... | |
int | getNumberOfNHP () |
Returns the number of NHP interfaces that are currently configured on the Realm Server. More... | |
int | getNumberOfNHPS () |
Returns the number of NHPS interfaces that are currently configured on the Realm Server. More... | |
int | getNumberOfNSP () |
Returns the number of NSP interfaces that are currently configured on the Realm Server. More... | |
int | getNumberOfNSPS () |
Returns the number of NSPS interfaces that are currently configured on the Realm Server. More... | |
int | getNumberOfSHM () |
Returns the number of SHM interfaces that are currently configured on the Realm Server. More... | |
Vector | getPluginConfiguration () |
Returns a Vector of nInterfacePluginConfiguration objects. More... | |
void | modInterface (nInterface modInterface) throws nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException, nUnexpectedResponseException, nAdminIllegalArgumentException |
Changes the existing interface so that it takes the new settings supplied. More... | |
void | startInterface (nInterface inter) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nAdminIllegalArgumentException |
Starts the interface, specified in the nInterface object, on the Realm Server. More... | |
void | stopInterface (nInterface inter) throws nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nAdminIllegalArgumentException |
Stops the specified interface on the Realm Server. More... | |
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.
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
newInterface | The new interface configuration |
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 |
nSessionPausedException | is thrown if session paused |
void com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.closed | ( | nRealmNode | node | ) |
Called when the nRealmNode is closed, �for internal use only.
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.
delInterface | The interface to delete |
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 removed |
nAdminSecurityException | is thrown if used on a virtual realm |
nSessionPausedException | is thrown if session paused |
nInterfaceStatus com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.findInterface | ( | String | name | ) | throws nAdminIllegalArgumentException |
Finds the nInterface object identified by the string supplied.
name | null if the interface does not exist |
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.
int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNHP | ( | ) |
Returns the number of NHP interfaces that are currently configured on the Realm Server.
int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNHPS | ( | ) |
Returns the number of NHPS interfaces that are currently configured on the Realm Server.
int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNSP | ( | ) |
Returns the number of NSP interfaces that are currently configured on the Realm Server.
int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfNSPS | ( | ) |
Returns the number of NSPS interfaces that are currently configured on the Realm Server.
int com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getNumberOfSHM | ( | ) |
Returns the number of SHM interfaces that are currently configured on the Realm Server.
Vector com.pcbsys.nirvana.nAdminAPI.nInterfaceManager.getPluginConfiguration | ( | ) |
Returns a Vector of nInterfacePluginConfiguration objects.
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.
modInterface | Changed settings for the interface |
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 modified or the buffer size is too low |
nSessionPausedException | is thrown if session paused |
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.
inter | The interface to start |
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.
inter | The interface to stop |
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 |