com.arunta.app.remote
Interface TRSystemServiceRI

All Superinterfaces:
java.rmi.Remote

public interface TRSystemServiceRI
extends java.rmi.Remote

Total Recall VR system remote interface.

This service provides for system level functions. Of those, the log-on function is probably the most important as it is used to establish a trust relationship, in a from of a security key, between a remote client and a Total Recall VR system. Clients must obtain a security key before making requests on any of the Total Recall VR remote interfaces.


Method Summary
 ChannelStatus[] getChannelsStatus(java.lang.String securityKey)
          Returns a summary of the status of all recording channels on the Total Recall system.
 java.util.Vector getCLogEntries(java.lang.String securityKey, int logEntryCnt)
          Fetches the specified number of log entries from the Total Recall VR C application log.
 java.util.Vector getJLogEntries(java.lang.String securityKey, int logEntryCnt)
          Fetches the specified number of log entries from the Total Recall VR J application log.
 int getRecorderID(java.lang.String securityKey)
          Returns the ID assigned to the Total Recall VR system.
 SystemStatus getSystemStatus(java.lang.String securityKey)
          Returns a summary of the Total Recall VR system status.
 java.lang.String getTime(java.lang.String securityKey)
          Returns the system time in the "yyyy.MM.dd HH:mm:ss zZ" format.
 SecurityKey logon(java.lang.String pin, java.lang.String userName)
          Remote client log-on.
 void ping()
          Connection ping.
 void removeSmdrParser(java.lang.String securityKey, java.lang.String parserName)
          Removes the specified SMDR parser from the set of parsers that are installed on the Total Recall VR system.
 void restart(java.lang.String securityKey)
          Restarts the Total Recall VR system.
 void shutdown(java.lang.String securityKey)
          Shuts down the Total Recall VR system.
 

Method Detail

ping

void ping()
          throws java.rmi.RemoteException
Connection ping.

A no-op which is used to test the status of the remote connection to the Total Recall VR system.

Throws:
java.rmi.RemoteException

logon

SecurityKey logon(java.lang.String pin,
                  java.lang.String userName)
                  throws SecurityException,
                         java.rmi.RemoteException
Remote client log-on.

This method is used to establish a trust relationship between the remote client and the Total Recall VR system. The client needs to provide a pin which must match either the administrator or the user password (pin) on the Total Recall VR system. If the pin matches one of the passwords on the Total Recall VR system, then the Total Recall VR system will provide the client with a security key which is a combination of the user name and the privileges that the client has on the system. This security key must be used by the client in all future requests.

The Total Recall VR Installation and Administration documentation contains information on how to set the administrator and user level passwords on the system.

Parameters:
pin - A pin which should match the administrator or the user password (pin) on the Total Recall VR system.
userName - A user name which the client wishes to use to identify itself to the Total Recall VR system.
Returns:
A security key which must be used in all other requests.
Throws:
SecurityException - If the Total Recall VR system can not grant administrator or user level privileges to the client because the pin provided is incorrect.
java.rmi.RemoteException - On any problem that is associated with completing the request. See cause for further details on the problem.

getSystemStatus

SystemStatus getSystemStatus(java.lang.String securityKey)
                             throws SecurityException,
                                    java.rmi.RemoteException
Returns a summary of the Total Recall VR system status.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
Returns:
A instance of a bean that describes the status of the Total Recall VR 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.

getChannelsStatus

ChannelStatus[] getChannelsStatus(java.lang.String securityKey)
                                  throws SecurityException,
                                         java.rmi.RemoteException
Returns a summary of the status of all recording channels on the Total Recall system.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
Returns:
An array of beans which describe the status of the recording channels on the Total Recall VR system. The bean instance in position 0 in the array corresponds to recording channel 1 and so on.
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.

getRecorderID

int getRecorderID(java.lang.String securityKey)
                  throws SecurityException,
                         java.rmi.RemoteException
Returns the ID assigned to the Total Recall VR system.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
Returns:
The ID that is assigned to the Total Recall VR 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.

getTime

java.lang.String getTime(java.lang.String securityKey)
                         throws SecurityException,
                                java.rmi.RemoteException
Returns the system time in the "yyyy.MM.dd HH:mm:ss zZ" format.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
Returns:
Current system time.
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.

shutdown

void shutdown(java.lang.String securityKey)
              throws SecurityException,
                     java.rmi.RemoteException
Shuts down the Total Recall VR system.

Note that it will be necessary to manually power up the Total Recall VR system after this request.

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.

restart

void restart(java.lang.String securityKey)
             throws SecurityException,
                    java.rmi.RemoteException
Restarts the Total Recall VR system.

Note that it is not necessary to manually power up the Total Recall VR system after this request.

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.

getJLogEntries

java.util.Vector getJLogEntries(java.lang.String securityKey,
                                int logEntryCnt)
                                throws java.io.IOException,
                                       SecurityException,
                                       java.rmi.RemoteException
Fetches the specified number of log entries from the Total Recall VR J application log.

This request fetches the specified number of entries from the end (tail) of the Total Recall VR J application log and returns them as a set of strings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
logEntryCnt - The number of log entries (lines) to fetch.
Returns:
A vector of strings.
Throws:
java.io.IOException - On problems with access to the Total Recall VR system application log file(s).
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.

getCLogEntries

java.util.Vector getCLogEntries(java.lang.String securityKey,
                                int logEntryCnt)
                                throws java.io.IOException,
                                       SecurityException,
                                       java.rmi.RemoteException
Fetches the specified number of log entries from the Total Recall VR C application log.

This request fetches the specified number of entries from the end (tail) of the Total Recall VR C application log and returns them as a set of strings.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
logEntryCnt - The number of log entries (lines) to fetch.
Returns:
A vector of strings.
Throws:
java.io.IOException - On problems with access to the Total Recall VR system application log file(s).
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.

removeSmdrParser

void removeSmdrParser(java.lang.String securityKey,
                      java.lang.String parserName)
                      throws SecurityException,
                             java.rmi.RemoteException
Removes the specified SMDR parser from the set of parsers that are installed on the Total Recall VR system.

Parameters:
securityKey - The security key that was obtained from the Total Recall VR system at login time. This operation requires a key with user level privileges.
parserName - The name of the SMDR parsers to remove. Valid names are stored in the SMDR Collector 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.


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