public interface TRSystemServiceRI
extends java.rmi.Remote
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.
Modifier and Type | Method and Description |
---|---|
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.
|
java.lang.String |
getTimeZoneID(java.lang.String securityKey)
Returns the ID of the default system Time Zone.
|
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.
|
void ping() throws java.rmi.RemoteException
A no-op which is used to test the status of the remote connection to the Total Recall VR system.
java.rmi.RemoteException
- On any problem that is associated with completing the request.
See cause for further details on the problem.SecurityKey logon(java.lang.String pin, java.lang.String userName) throws SecurityException, java.rmi.RemoteException
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.
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.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.SystemStatus getSystemStatus(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
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.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.ChannelStatus[] getChannelsStatus(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
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.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.int getRecorderID(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
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.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.java.lang.String getTimeZoneID(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
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.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.java.lang.String getTime(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
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.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.void shutdown(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
Note that it will be necessary to manually power up the Total Recall VR system after this request.
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.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.void restart(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
Note that it is not necessary to manually power up the Total Recall VR system after this request.
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.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.java.util.Vector getJLogEntries(java.lang.String securityKey, int logEntryCnt) throws java.io.IOException, SecurityException, java.rmi.RemoteException
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.
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.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.java.util.Vector getCLogEntries(java.lang.String securityKey, int logEntryCnt) throws java.io.IOException, SecurityException, java.rmi.RemoteException
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.
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.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.void removeSmdrParser(java.lang.String securityKey, java.lang.String parserName) throws SecurityException, java.rmi.RemoteException
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
.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-2019 Prolancer Pty Ltd, Sydney Australia.