public interface TRMonitorServiceRI
extends java.rmi.Remote
This service provides for real-time call monitoring, that is, while calls
are being recorded by the Total Recall VR system. Use the TRPlayServiceRI
to play recordings of call which have ended.
Modifier and Type | Method and Description |
---|---|
void |
annotateRecording(java.lang.String securityKey,
int channelNumber,
java.lang.String note)
Replaces the notes for a recording in progress with the specified note.
|
void |
annotateRecordings(java.lang.String securityKey,
int[] channelNumbers,
java.lang.String note)
Replaces the notes for a set of recordings in progress with the specified note.
|
void |
flagRecording(java.lang.String securityKey,
int channelNumber,
boolean isTag,
boolean isLock)
Replaces the tagged and/or locked flag for a recording in progress.
|
void |
flagRecordings(java.lang.String securityKey,
int[] channelNumbers,
boolean isTag,
boolean isLock)
Replaces the tagged and/or locked flag for a set of recordings in progress.
|
java.util.List |
getActiveRecordings(java.lang.String securityKey)
Returns a list of
Recording beans which
describe the calls being recorded at the time of the request. |
Recording |
getOldestActiveRecording(java.lang.String securityKey)
Returns the
Recording bean for the oldest
call being recorded at the time of the request. |
Recording |
getYoungestActiveRecording(java.lang.String securityKey)
Returns the
Recording bean for the youngest
call being recorded at the time of the request. |
void |
startRemoteMonitor(java.lang.String securityKey,
int channelNumber,
java.net.InetSocketAddress socketAddress)
Instructs the Total Recall VR system to prepare and start a
StreamPacketSender . |
void |
stopRemoteMonitor(java.lang.String securityKey,
int channelNumber,
java.net.InetSocketAddress socketAddress)
Instructs the Total Recall VR system to stop an active
StreamPacketSender and dispose
of it. |
java.util.List getActiveRecordings(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
Recording
beans which
describe the calls being recorded at the time of the request.
The calls are sorted in reverse start time order, i.e. the call that
started last is at the top of the list, while the call that started first
is at the bottom of the list.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.Recording
beans, one for each
call being recorded, and in reverse time order (most recent call
first). Note that the list will be empty if the system is not
recording any calls 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.Recording getOldestActiveRecording(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
Recording
bean for the oldest
call being recorded at the time of the request.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.Recording
beans, one for each
call being recorded, and in reverse time order (most recent call
first). Note that the list will be empty if the system is not
recording any calls 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.Recording getYoungestActiveRecording(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
Recording
bean for the youngest
call being recorded at the time of the request.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.Recording
beans, one for each
call being recorded, and in reverse time order (most recent call
first). Note that the list will be empty if the system is not
recording any calls 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.void startRemoteMonitor(java.lang.String securityKey, int channelNumber, java.net.InetSocketAddress socketAddress) throws TooManySessionsException, MonitoringDisabledException, SecurityException, java.rmi.RemoteException
StreamPacketSender
.
The packet sender will send stream packets for the active call on
the specified channel to the remote client via the specified UDP socket.
The client should have a
StreamPacketReceiver
running
on the specified socket before making this request.
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.channelNumber
- The system will stream audio that is being recorded on the channel
with number that is equal to the one specified by this parameter.
All channels on a Total Recall VR system have a unique number, starting
from 1.socketAddress
- The socket to send packets to. This socket is used by the packet
receiver.TooManySessionsException
- If there are too many active call monitoring sessions already.MonitoringDisabledException
- If the recording policy does not allow monitoring of the call on
the specified channel.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 stopRemoteMonitor(java.lang.String securityKey, int channelNumber, java.net.InetSocketAddress socketAddress) throws SecurityException, java.rmi.RemoteException
StreamPacketSender
and dispose
of it.
The client should stop the
StreamPacketReceiver
that it
uses to receive the packets from the sender after this request to ensure
that it receives all packets sent by the sender.
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.channelNumber
- The system will stop streaming audio that is being recorded on the channel
with number that is equal to the one specified by this parameter.
All channels on a Total Recall VR system have a unique number, starting
from 1.socketAddress
- The socket being used by the packet receiver.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 annotateRecording(java.lang.String securityKey, int channelNumber, java.lang.String note) 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.channelNumber
- The note will be attached to the recording that is being recorded on
the channel with number that is equal to the one specified by this
parameter.
All channels on a Total Recall VR system have a unique number, starting
from 1.note
- To note to attach to the call. Limit to 256 characters.
Set to null
to remove (clear) the note.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 annotateRecordings(java.lang.String securityKey, int[] channelNumbers, java.lang.String note) 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.channelNumbers
- The note will be attached to the recordings that are being recorded on
the channels with numbers that are equal to the ones specified by this
parameter.
All channels on a Total Recall VR system have a unique number, starting
from 1.note
- To note to attach to the call. Limit to 256 characters.
Set to null
to remove (clear) the note.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 flagRecording(java.lang.String securityKey, int channelNumber, boolean isTag, boolean isLock) 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.channelNumber
- The flags will be set on the recording that is being recorded on
the channel with number that is equal to the one specified by this
parameter.
All channels on a Total Recall VR system have a unique number, starting
from 1.isTag
- Set to true
to tag the recording. Set to false
to remove the tag.isLock
- Set to true
to lock the recording. Set to false
to remove the lock.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 flagRecordings(java.lang.String securityKey, int[] channelNumbers, boolean isTag, boolean isLock) 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.channelNumbers
- The flags will be set on the recordings that are being recorded on
the channels with numbers that are equal to the ones specified by this
parameter.
All channels on a Total Recall VR system have a unique number, starting
from 1.isTag
- Set to true
to tag the recording. Set to false
to remove the tag.isLock
- Set to true
to lock the recording. Set to false
to remove the lock.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.