AdventNet CLI 2.0 API Specification

com.adventnet.cli.rmi
Interface CLIResourceManager


public interface CLIResourceManager
extends java.rmi.Remote

This is the RMI interface implemented by the CLIResourceManagerImpl class. The interface provides methods which are normally available in the non RMI CLIResourceManager class.


Method Summary
 void closeAllConnections()
           
 int getKeepAliveTimeout()
          Gets the keepAlive time-out in seconds.
 int getMaxConnections()
          Gets the maximum no of CLI Connections that can exist for any session opened.
 int getSystemWideMaxConnections()
          Gets the maximum no of connections System Wide that can exist at any given instant.
 boolean isSetPooling()
          Gets the pooling Flag common to CLI sessions.
 void setKeepAliveTimeout(int timeout)
          Sets the Keep Alive time-out in seconds.
 void setMaxConnections(int connections)
          Sets the maximum no of CLI Connections that can exist per device for any session opened.
 void setPooling(boolean poolFlag)
          Enables/Disables the pooling of CLITransport Sessions.
 void setSystemWideMaxConnections(int connections)
          Sets the maximum no of connections System Wide that can exist at any given instant.
 

Method Detail

setSystemWideMaxConnections

public void setSystemWideMaxConnections(int connections)
                                 throws java.rmi.RemoteException
Sets the maximum no of connections System Wide that can exist at any given instant. Default is 3.
Parameters:
connections - number of maximum allowed connections System Wide.

getSystemWideMaxConnections

public int getSystemWideMaxConnections()
                                throws java.rmi.RemoteException
Gets the maximum no of connections System Wide that can exist at any given instant.
Returns:
the maximum no of connections allowed System Wide.

setKeepAliveTimeout

public void setKeepAliveTimeout(int timeout)
                         throws java.rmi.RemoteException
Sets the Keep Alive time-out in seconds. This is the time for which a Particular CLI connection can remain idle. This parameter is common to a group of connections with the same device. Setting it here makes it available globally (for all the sesssions opened). But this parameter when set on the CLISession will override the value set here.
Parameters:
timeout - the time-out value (in seconds).

getKeepAliveTimeout

public int getKeepAliveTimeout()
                        throws java.rmi.RemoteException
Gets the keepAlive time-out in seconds. This is the time for which a Particular CLI connection can remain idle. This parameter is common to a group of connections with the same device.
Returns:
the timeout value (in seconds).

setMaxConnections

public void setMaxConnections(int connections)
                       throws java.rmi.RemoteException
Sets the maximum no of CLI Connections that can exist per device for any session opened. Default is 1. Setting it here makes it available globally (for all the sesssions opened). But this parameter when set on the CLISession will override the value set here.
Parameters:
connections - number of maximum allowed connections.

getMaxConnections

public int getMaxConnections()
                      throws java.rmi.RemoteException
Gets the maximum no of CLI Connections that can exist for any session opened.
Returns:
the maxmimum no of connections allowed for this Session.

setPooling

public void setPooling(boolean poolFlag)
                throws java.rmi.RemoteException
Enables/Disables the pooling of CLITransport Sessions. Setting it here will enable Transport pooling for all the sessions opened. This can be overridden by setting it on the CLISession.
Parameters:
poolFlag - boolean to indicate whether pooling is enabled or disabled.

isSetPooling

public boolean isSetPooling()
                     throws java.rmi.RemoteException
Gets the pooling Flag common to CLI sessions.
Returns:
the pooling Flag.

closeAllConnections

public void closeAllConnections()
                         throws java.rmi.RemoteException

AdventNet CLI 2.0 API Specification