com.arunta.app.remote
Interface TRConfigurationServiceRI

All Superinterfaces:
java.rmi.Remote

public interface TRConfigurationServiceRI
extends java.rmi.Remote

Total Recall VR remote interface for system configuration.

This service provides for access to and update of system configuration.


Method Summary
 AgentConfiguration getAgentConfiguration(java.lang.String securityKey)
          Fetches the current active Agent Configuration.
 AutoArchiveSettings getAutoArchiveSettings(java.lang.String securityKey)
          Fetches the current active Auto-Archive Settings.
 ChannelConfiguration getChannelConfiguration(java.lang.String securityKey)
          Fetches the current active Channel Configuration.
 java.lang.String getDefaultGateway(java.lang.String securityKey)
          Fetches the current default network gateway.
 ExtensionConfiguration getExtensionConfiguration(java.lang.String securityKey)
          Fetches the current active Extension Configuration.
 GeneralSettings getGeneralSettings(java.lang.String securityKey)
          Fetches the current active General Settings.
 java.lang.String getHostName(java.lang.String securityKey)
          Fetches the current system host name.
 InetSettings getInetSettings(java.lang.String securityKey)
          Fetches the current active Inet Settings.
 InternalDialPlan getInternalDialPlan(java.lang.String securityKey)
          Fetches the current active Internal Dial Plan.
 ISDNProviderSettings getISDNProviderSettings(java.lang.String securityKey)
          Fetches the current active ISDN Provider Settings.
 java.lang.String getLicenseHardwareKey(java.lang.String securityKey)
          Fetches the unique hardware key of the system.
 LicenseSettings getLicenseSettings(java.lang.String securityKey)
          Fetches the current active License Settings.
 ManualArchiveSettings getManualArchiveSettings(java.lang.String securityKey)
          Fetches the current active Manual Archive Settings.
 java.lang.String[] getNameServers(java.lang.String securityKey)
          Fetches the current DNS servers.
 RecentCallsSettings getRecentCallsSettings(java.lang.String securityKey)
          Fetches the current active Recent Calls Settings.
 RemoteManagerSettings getRemoteManagerSettings(java.lang.String securityKey)
          Fetches the current active Remote Manager Settings.
 SearchArchiveSettings getSearchArchiveSettings(java.lang.String securityKey)
          Fetches the current active Search Archive Settings.
 SessionSettings getSessionSettings(java.lang.String securityKey)
          Fetches the current active Session Settings.
 SignallingIDMap getSignallingIDMap(java.lang.String securityKey)
          Fetches the current active Signalling ID Map.
 SMDRCollectorSettings getSMDRCollectorSettings(java.lang.String securityKey)
          Fetches the current active SMDR Collector Settings.
 SnifferProviderSettings getSnifferProviderSettings(java.lang.String securityKey)
          Fetches the current active VoIP Provider Settings.
 SNMPSettings getSNMPSettings(java.lang.String securityKey)
          Fetches the current active SNMP Settings.
 TimeDateSettings getTimeDateSettings(java.lang.String securityKey)
          Fetches the current active Time and Date Settings.
 void removeTemporySettingsFile(java.lang.String securityKey)
          Removes the /tmp/settings.trs file from the system, if any.
 void setAgentConfiguration(java.lang.String securityKey, AgentConfiguration cfg)
          Updates the Agent Configuration with the one specified.
 void setAnalogChannelConfiguration(java.lang.String securityKey, AnalogChannelSettings[] cfg)
          Updates the Channel Configuration for the analog channels with the one specified.
 void setAutoArchiveSettings(java.lang.String securityKey, AutoArchiveSettings cfg)
          Updates the Auto-Archive Settings with the one specified.
 void setDefaultGateway(java.lang.String securityKey, java.lang.String gatewayIpAddress)
          Changes the default network gateway.
 void setExtensionConfiguration(java.lang.String securityKey, ExtensionConfiguration cfg)
          Updates the Extension Configuration with the one specified.
 void setGeneralSettings(java.lang.String securityKey, GeneralSettings cfg)
          Updates the General Settings with the one specified.
 void setHostName(java.lang.String securityKey, java.lang.String hostName)
          Changes the system host name.
 void setInetInterface(java.lang.String securityKey, InetInterface cfg)
          Updates the Inet Interface configuration with the one specified.
 void setInetSettings(java.lang.String securityKey, InetSettings cfg)
          Updates the Inet Settings with the one specified.
 void setInetSettings(java.lang.String securityKey, InetSettings cfg, java.lang.String gatewayIpAddress)
          Updates the Inet Settings and default gateway with the ones specified.
 void setInternalDialPlan(java.lang.String securityKey, InternalDialPlan cfg)
          Updates the Internal Dial Plan with the one specified.
 void setISDNProviderSettings(java.lang.String securityKey, ISDNProviderSettings cfg)
          Updates the ISDN Provider Settings with the one specified.
 void setLicenseSettings(java.lang.String securityKey, LicenseSettings cfg)
          Updates the License Settings with the one specified.
 void setManualArchiveSettings(java.lang.String securityKey, ManualArchiveSettings cfg)
          Updates the Manual Archive Settings with the one specified.
 void setNameServer(java.lang.String securityKey, java.lang.String nameServer)
          Changes the name (DNS) server.
 void setRecentCallsSettings(java.lang.String securityKey, RecentCallsSettings cfg)
          Updates the Recent Calls Settings with the one specified.
 void setRemoteManagerSettings(java.lang.String securityKey, RemoteManagerSettings cfg)
          Updates the Remote Manager Settings with the one specified.
 void setSearchArchiveSettings(java.lang.String securityKey, SearchArchiveSettings cfg)
          Updates the Search Archive Settings with the one specified.
 void setSessionSettings(java.lang.String securityKey, SessionSettings cfg)
          Updates the Session Settings with the one specified.
 void setSignallingIDMap(java.lang.String securityKey, SignallingIDMap cfg)
          Updates the Signalling ID Map with the one specified.
 void setSMDRCollectorSettings(java.lang.String securityKey, SMDRCollectorSettings cfg)
          Updates the SMDR Collector Settings with the one specified.
 void setSnifferProviderSettings(java.lang.String securityKey, SnifferProviderSettings cfg)
          Updates the VoIP Provider Settings with the one specified.
 void setSNMPSettings(java.lang.String securityKey, SNMPSettings cfg)
          Updates the SNMP Settings with the one specified.
 void setTimeDateSettings(java.lang.String securityKey, TimeDateSettings cfg)
          Updates the Time and Date Settings with the one specified.
 void unzipAndLoadSettings(java.lang.String securityKey)
          Unzips system settings files from a ZIP file (/tmp/settings.trs) and applies the settings to the system.
 void zipSettings(java.lang.String securityKey)
          Creates a ZIP file (/tmp/settings.trs) which contains all system configuartion files.
 

Method Detail

getAgentConfiguration

AgentConfiguration getAgentConfiguration(java.lang.String securityKey)
                                         throws SecurityException,
                                                java.rmi.RemoteException
Fetches the current active Agent Configuration.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Agent Configuration.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setAgentConfiguration

void setAgentConfiguration(java.lang.String securityKey,
                           AgentConfiguration cfg)
                           throws InvalidSettingsException,
                                  SecurityException,
                                  java.rmi.RemoteException
Updates the Agent Configuration with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Agent Configuration.
Throws:
InvalidSettingsException - On any problem with the new Agent Configuration parameters.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getAutoArchiveSettings

AutoArchiveSettings getAutoArchiveSettings(java.lang.String securityKey)
                                           throws SecurityException,
                                                  java.rmi.RemoteException
Fetches the current active Auto-Archive Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Auto-Archive Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setAutoArchiveSettings

void setAutoArchiveSettings(java.lang.String securityKey,
                            AutoArchiveSettings cfg)
                            throws InvalidSettingsException,
                                   SecurityException,
                                   BusyException,
                                   java.rmi.RemoteException
Updates the Auto-Archive Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Auto-Archive Settings.
Throws:
InvalidSettingsException - On any problem with the new Auto-Archive Settings. This includes problems with access to the network share, if one specified in the settings.
BusyException - If the system is in the process of auto-archiving at the time of the request.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getChannelConfiguration

ChannelConfiguration getChannelConfiguration(java.lang.String securityKey)
                                             throws SecurityException,
                                                    java.rmi.RemoteException
Fetches the current active Channel Configuration.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Channel Configuration.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setAnalogChannelConfiguration

void setAnalogChannelConfiguration(java.lang.String securityKey,
                                   AnalogChannelSettings[] cfg)
                                   throws InvalidSettingsException,
                                          SecurityException,
                                          java.rmi.RemoteException
Updates the Channel Configuration for the analog channels with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid analog Channel Configuration.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getExtensionConfiguration

ExtensionConfiguration getExtensionConfiguration(java.lang.String securityKey)
                                                 throws SecurityException,
                                                        java.rmi.RemoteException
Fetches the current active Extension Configuration.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Extension Configuration.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setExtensionConfiguration

void setExtensionConfiguration(java.lang.String securityKey,
                               ExtensionConfiguration cfg)
                               throws InvalidSettingsException,
                                      SecurityException,
                                      java.rmi.RemoteException
Updates the Extension Configuration with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Extension Configuration.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getGeneralSettings

GeneralSettings getGeneralSettings(java.lang.String securityKey)
                                   throws SecurityException,
                                          java.rmi.RemoteException
Fetches the current active General Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active General Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setGeneralSettings

void setGeneralSettings(java.lang.String securityKey,
                        GeneralSettings cfg)
                        throws InvalidSettingsException,
                               SecurityException,
                               java.rmi.RemoteException
Updates the General Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid General Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getDefaultGateway

java.lang.String getDefaultGateway(java.lang.String securityKey)
                                   throws SecurityException,
                                          java.rmi.RemoteException
Fetches the current default network gateway.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
The IP address, in dot separated form, of the default gateway, if any. null otherwise.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setDefaultGateway

void setDefaultGateway(java.lang.String securityKey,
                       java.lang.String gatewayIpAddress)
                       throws InvalidSettingsException,
                              SecurityException,
                              java.rmi.RemoteException
Changes the default network gateway.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
gatewayIpAddress - The IP address, in dot separated form. null to remove the gateway configuration.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getHostName

java.lang.String getHostName(java.lang.String securityKey)
                             throws SecurityException,
                                    java.rmi.RemoteException
Fetches the current system host name.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
The current hostname, if any. null otherwise.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setHostName

void setHostName(java.lang.String securityKey,
                 java.lang.String hostName)
                 throws InvalidSettingsException,
                        SecurityException,
                        java.rmi.RemoteException
Changes the system host name.

NOTE: host name change requires system restart to take effect. This method does not restart the system

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
hostName - The new host name. null to clear the host name.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getNameServers

java.lang.String[] getNameServers(java.lang.String securityKey)
                                  throws SecurityException,
                                         java.rmi.RemoteException
Fetches the current DNS servers.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
The IP addresses, in a dot separated form, of all configured DNS servers, if any. null otherwise.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setNameServer

void setNameServer(java.lang.String securityKey,
                   java.lang.String nameServer)
                   throws InvalidSettingsException,
                          SecurityException,
                          java.rmi.RemoteException
Changes the name (DNS) server.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
nameServer - The new name (DNS) server. null to clear the name server.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getInetSettings

InetSettings getInetSettings(java.lang.String securityKey)
                             throws SecurityException,
                                    java.rmi.RemoteException
Fetches the current active Inet Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Inet Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setInetSettings

void setInetSettings(java.lang.String securityKey,
                     InetSettings cfg)
                     throws InvalidSettingsException,
                            SecurityException,
                            java.rmi.RemoteException
Updates the Inet Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Inet Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setInetSettings

void setInetSettings(java.lang.String securityKey,
                     InetSettings cfg,
                     java.lang.String gatewayIpAddress)
                     throws InvalidSettingsException,
                            SecurityException,
                            java.rmi.RemoteException
Updates the Inet Settings and default gateway with the ones specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Inet Settings.
gatewayIpAddress - The IP address, in dot separated form. null to remove the gateway configuration.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setInetInterface

void setInetInterface(java.lang.String securityKey,
                      InetInterface cfg)
                      throws InvalidSettingsException,
                             SecurityException,
                             java.rmi.RemoteException
Updates the Inet Interface configuration with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Inet Interface configuration.
Throws:
InvalidSettingsException - On problems with applying the new Inet Interface configuration or re-starting the network interface with the new configuration.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getInternalDialPlan

InternalDialPlan getInternalDialPlan(java.lang.String securityKey)
                                     throws SecurityException,
                                            java.rmi.RemoteException
Fetches the current active Internal Dial Plan.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Internal Dial Plan.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setInternalDialPlan

void setInternalDialPlan(java.lang.String securityKey,
                         InternalDialPlan cfg)
                         throws InvalidSettingsException,
                                SecurityException,
                                java.rmi.RemoteException
Updates the Internal Dial Plan with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Internal Dial Plan.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getISDNProviderSettings

ISDNProviderSettings getISDNProviderSettings(java.lang.String securityKey)
                                             throws SecurityException,
                                                    java.rmi.RemoteException
Fetches the current active ISDN Provider Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active ISDN Provider Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setISDNProviderSettings

void setISDNProviderSettings(java.lang.String securityKey,
                             ISDNProviderSettings cfg)
                             throws InvalidSettingsException,
                                    SecurityException,
                                    java.rmi.RemoteException
Updates the ISDN Provider Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid ISDN Provider Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getLicenseSettings

LicenseSettings getLicenseSettings(java.lang.String securityKey)
                                   throws SecurityException,
                                          java.rmi.RemoteException
Fetches the current active License Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active License Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getLicenseHardwareKey

java.lang.String getLicenseHardwareKey(java.lang.String securityKey)
                                       throws SecurityException,
                                              java.rmi.RemoteException
Fetches the unique hardware key of the system.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A string that represents the unique hardware key of the system.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setLicenseSettings

void setLicenseSettings(java.lang.String securityKey,
                        LicenseSettings cfg)
                        throws InvalidSettingsException,
                               SecurityException,
                               java.rmi.RemoteException
Updates the License Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid License Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getManualArchiveSettings

ManualArchiveSettings getManualArchiveSettings(java.lang.String securityKey)
                                               throws SecurityException,
                                                      java.rmi.RemoteException
Fetches the current active Manual Archive Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Manual Archive Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setManualArchiveSettings

void setManualArchiveSettings(java.lang.String securityKey,
                              ManualArchiveSettings cfg)
                              throws InvalidSettingsException,
                                     SecurityException,
                                     java.rmi.RemoteException
Updates the Manual Archive Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Manual Archive Settings.
Throws:
InvalidSettingsException - On any problem with the new Manual Archive Settings. This includes problems with access to the network share, if one specified in the settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getRecentCallsSettings

RecentCallsSettings getRecentCallsSettings(java.lang.String securityKey)
                                           throws SecurityException,
                                                  java.rmi.RemoteException
Fetches the current active Recent Calls Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Recent Calls Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setRecentCallsSettings

void setRecentCallsSettings(java.lang.String securityKey,
                            RecentCallsSettings cfg)
                            throws InvalidSettingsException,
                                   SecurityException,
                                   java.rmi.RemoteException
Updates the Recent Calls Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Recent Calls Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getRemoteManagerSettings

RemoteManagerSettings getRemoteManagerSettings(java.lang.String securityKey)
                                               throws SecurityException,
                                                      java.rmi.RemoteException
Fetches the current active Remote Manager Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Remote Manager Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setRemoteManagerSettings

void setRemoteManagerSettings(java.lang.String securityKey,
                              RemoteManagerSettings cfg)
                              throws InvalidSettingsException,
                                     SecurityException,
                                     java.rmi.RemoteException
Updates the Remote Manager Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Remote Manager Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getSearchArchiveSettings

SearchArchiveSettings getSearchArchiveSettings(java.lang.String securityKey)
                                               throws SecurityException,
                                                      java.rmi.RemoteException
Fetches the current active Search Archive Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Search Archive Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setSearchArchiveSettings

void setSearchArchiveSettings(java.lang.String securityKey,
                              SearchArchiveSettings cfg)
                              throws InvalidSettingsException,
                                     SecurityException,
                                     java.rmi.RemoteException
Updates the Search Archive Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Search Archive Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getSessionSettings

SessionSettings getSessionSettings(java.lang.String securityKey)
                                   throws SecurityException,
                                          java.rmi.RemoteException
Fetches the current active Session Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Session Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setSessionSettings

void setSessionSettings(java.lang.String securityKey,
                        SessionSettings cfg)
                        throws InvalidSettingsException,
                               SecurityException,
                               java.rmi.RemoteException
Updates the Session Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Session Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getSignallingIDMap

SignallingIDMap getSignallingIDMap(java.lang.String securityKey)
                                   throws SecurityException,
                                          java.rmi.RemoteException
Fetches the current active Signalling ID Map.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Signalling ID Map.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setSignallingIDMap

void setSignallingIDMap(java.lang.String securityKey,
                        SignallingIDMap cfg)
                        throws InvalidSettingsException,
                               SecurityException,
                               java.rmi.RemoteException
Updates the Signalling ID Map with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Signalling ID Map.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getSMDRCollectorSettings

SMDRCollectorSettings getSMDRCollectorSettings(java.lang.String securityKey)
                                               throws SecurityException,
                                                      java.rmi.RemoteException
Fetches the current active SMDR Collector Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active SMDR Collector Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setSMDRCollectorSettings

void setSMDRCollectorSettings(java.lang.String securityKey,
                              SMDRCollectorSettings cfg)
                              throws InvalidSettingsException,
                                     SecurityException,
                                     java.rmi.RemoteException
Updates the SMDR Collector Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid SMDR Collector Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getSnifferProviderSettings

SnifferProviderSettings getSnifferProviderSettings(java.lang.String securityKey)
                                                   throws SecurityException,
                                                          java.rmi.RemoteException
Fetches the current active VoIP Provider Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active VoIP Provider Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setSnifferProviderSettings

void setSnifferProviderSettings(java.lang.String securityKey,
                                SnifferProviderSettings cfg)
                                throws InvalidSettingsException,
                                       SecurityException,
                                       java.rmi.RemoteException
Updates the VoIP Provider Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid VoIP Provider Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getSNMPSettings

SNMPSettings getSNMPSettings(java.lang.String securityKey)
                             throws SecurityException,
                                    java.rmi.RemoteException
Fetches the current active SNMP Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active SNMP Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setSNMPSettings

void setSNMPSettings(java.lang.String securityKey,
                     SNMPSettings cfg)
                     throws InvalidSettingsException,
                            SecurityException,
                            java.rmi.RemoteException
Updates the SNMP Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid SNMP Settings.
Throws:
InvalidSettingsException - On any problem with the supplied settings.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getTimeDateSettings

TimeDateSettings getTimeDateSettings(java.lang.String securityKey)
                                     throws SecurityException,
                                            java.rmi.RemoteException
Fetches the current active Time and Date Settings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Returns:
A bean that captures the current active Time and Date Settings.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

setTimeDateSettings

void setTimeDateSettings(java.lang.String securityKey,
                         TimeDateSettings cfg)
                         throws InvalidSettingsException,
                                SecurityException,
                                java.rmi.RemoteException
Updates the Time and Date Settings with the one specified.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
cfg - Valid Time and Date Settings.
Throws:
InvalidSettingsException - On any problem with setting the time and date on the system including synchonising the time and date with NTP, if specified.
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

zipSettings

void zipSettings(java.lang.String securityKey)
                 throws SecurityException,
                        java.rmi.RemoteException
Creates a ZIP file (/tmp/settings.trs) which contains all system configuartion files.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

unzipAndLoadSettings

void unzipAndLoadSettings(java.lang.String securityKey)
                          throws SecurityException,
                                 java.rmi.RemoteException
Unzips system settings files from a ZIP file (/tmp/settings.trs) and applies the settings to the system.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

removeTemporySettingsFile

void removeTemporySettingsFile(java.lang.String securityKey)
                               throws SecurityException,
                                      java.rmi.RemoteException
Removes the /tmp/settings.trs file from the system, if any.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with administrator level privileges.
Throws:
SecurityException - On invalid security key, or if the user that is associated with the security key is not authorised to perform this request.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.


Copyright ©, 2005-2012 Prolancer Pty Ltd, Sydney Australia.