public interface TRSmdrServiceRI
extends java.rmi.Remote
This service provides for collecting a sample of SMDR strings from a connected PBX to the Total Recall VR system and parsing the SMDRs to determine if the Total Recall VR system can extract useful information from them.
Note that this service is not intended for real-time collection and parsing of SMDRs by remote clients. Instead, it should be used to test the operation of current SMDR parser that is active on the Total Recall VR system.
This service requires correct configuration of a SMDR Collector on the Total Recall VR system. In addition, it requires a working (TCP/IP) connection between a PBX and the Total Recall VR system. Consult the Total Recall VR Administration and Installation documentation on how to configure a SMDR Collector.
Modifier and Type | Method and Description |
---|---|
java.lang.String[] |
getCollected(java.lang.String securityKey)
Returns a set of raw SMDR strings as collected from the PBX.
|
java.lang.String |
getLastCollected(java.lang.String securityKey)
Returns the last SMDR string as collected from the PBX.
|
Smdr |
parse(java.lang.String securityKey,
java.lang.String smdr)
Converts a raw SMDR string (as collected from the PBX) to a bean which
contains information that can be used by a Total Recall VR system.
|
java.lang.String[] getCollected(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
Each Total Recall VR system maintains a cache of collected SMDR strings. The size of the cache is 240 SMDR strings (usually individual recored sent by the PBX to the Total Recall VR system). This method returns the content of the cache 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.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 getLastCollected(java.lang.String securityKey) throws SecurityException, java.rmi.RemoteException
Each Total Recall VR system maintains a cache of collected SMDR strings. The size of the cache is 240 SMDR strings (usually individual recored sent by the PBX to the Total Recall VR system). This method returns the last entry in the cache 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.null
if
the cache is empty.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.Smdr parse(java.lang.String securityKey, java.lang.String smdr) throws SecurityException, java.rmi.RemoteException
To parse a raw SMDR, the Total Recall VR system must be configured with a SMDR parser that understands the content of the raw SMDR. The information in the bean will be useless if such parser is not in use.
Consult the Total Recall VR Administration and Installation documentation on how to install and activate a SMDR Parser.
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.smdr
- A raw SMDR string as collected from the PBX.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.