com.arunta.app.remote
Interface TRArchiveServiceRI

All Superinterfaces:
java.rmi.Remote

public interface TRArchiveServiceRI
extends java.rmi.Remote

Total Recall VR remote interface for archiving.

The service can be used to archive a set of, or all, recordings which exist on the Total Recall VR system to a CD/DVD/BD disc, a USB device or a network drive.

In addition, this service can be used by external archivers to safely initiate and terminate archiving sessions on the system.


Method Summary
 void cancelArchive(java.lang.String securityKey)
          Cancels an on-going archiving session.
 void endExternalArchive(java.lang.String securityKey)
          Informs the Total Recall VR that an external archiver completed an archive session on it.
 java.lang.String getArchiveStatus(java.lang.String securityKey)
          Returns an message that describes the status of the on-going archiving session.
 boolean startArchive(java.lang.String securityKey, ArchiveCallsType archiveType, ArchiveDeviceType deviceType, boolean deleteRecordings, boolean markRecordings, SearchCriteria searchCriteria)
          Initaites archiving of recordings to a CD/DVD/BD disc, USB device or network drive.
 void startExternalArchive(java.lang.String securityKey)
          Informs the Total Recall VR that an external archiver wants to start and archive session on it.
 

Method Detail

startArchive

boolean startArchive(java.lang.String securityKey,
                     ArchiveCallsType archiveType,
                     ArchiveDeviceType deviceType,
                     boolean deleteRecordings,
                     boolean markRecordings,
                     SearchCriteria searchCriteria)
                     throws SecurityException,
                            java.rmi.RemoteException
Initaites archiving of recordings to a CD/DVD/BD disc, USB device or network drive.

Note that this request will fail if the Total Recall VR system is the process of archiving, house-keeping, transcoding or rebuilding its database at the time of the request.

To archive to a disc, a compatible disc must be inserted in the drive on the Total Recall VR system before this request. Note, the system may need more than one disc when archiving to disc as not all recordings may fit on one disc. If this is the case, then a person will have to physically insert new disc(s) in the drive of the Total Recall VR system during the archive operation.

To archive to a network drive, the Total Recall VR system must be configured with a share location and credentials. Consult the Total Recall VR documentation on how to configure a network share and its credentials.

To archive to a USB device, a USB device must be attached to the Total Recall VR system.

The archive can include:

In addition, it is possible to delete the recordings, and their meta data, which the system puts in the archive at the end of the archive operation. However, to do so this request requires a security key with administrator level privileges.

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 if the deleteRecordings parameter is set to false . Otherwise, this operation requires a key with administrator level privileges.
archiveType - Specifies which recordings to archive. If you specify ArchiveCallsType.FOUND_CALLS, then you must also specify a valid searchCriteria. Otherwise, set searchCriteria to null .
deviceType - Specifies the type of archive to create.
deleteRecordings - Set this parameter to true if you wish to delete the archived recordings, and their meta data, when the archive operation completes. Set this parameter to false if you wish to leave the recordings, and their meta data, on the system.
markRecordings - Set this parameter to true if you wish to mark the archived recordings, and their meta data, as archived when the archive operation completes. This will exclude the recordings from the next auto-archive session. Set this parameter to false otherwise.
searchCriteria - If the archiveType parameter is set to ArchiveCallsType.FOUND_CALLS, then this parameter must be set to a valid search criteria which identifies the recordings that should be archived. Otherwise, this parameter can be set to null.
Returns:
true if the archive operation completes without problems. false 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.

cancelArchive

void cancelArchive(java.lang.String securityKey)
                   throws SecurityException,
                          java.rmi.RemoteException
Cancels an on-going archiving session.

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.
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.

getArchiveStatus

java.lang.String getArchiveStatus(java.lang.String securityKey)
                                  throws SecurityException,
                                         java.rmi.RemoteException
Returns an message that describes the status of the on-going archiving session.

The message is in the current language as configured on the Total Recall VR system. This message is suitable to display to the user of the remote client making this request.

Consult the Total Recall VR Administration and Installation documentation on how to configure the language on a 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:
A message which describes the status of the on-going archive operation. For example: Archiving completed.
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.

startExternalArchive

void startExternalArchive(java.lang.String securityKey)
                          throws SecurityException,
                                 java.rmi.RemoteException
Informs the Total Recall VR that an external archiver wants to start and archive session on it.

Note that this request will fail if the Total Recall VR system is the process of archiving, house-keeping, transcoding or rebuilding its database at the time of the request.

If the method fails, then external archivers should not start an archive session until a subsequent request is successful.

External archivers should use this method when they want to start an archive session on the Total Recall VR system. This ensures that the external archiver has exclusive access to the system for the purpose of archiving and prevents other system processes to interfere with the archive session.

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.
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.

endExternalArchive

void endExternalArchive(java.lang.String securityKey)
                        throws SecurityException,
                               java.rmi.RemoteException
Informs the Total Recall VR that an external archiver completed an archive session on it.

External archivers should use this method when they are done archiving recordings on the Total Recall VR system. Failing to do so will result in a system that does not allow any future archive sessions until re-started.

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.
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.