remoteprovider.java

jtapi for telephone

CallId join(SerializableCallId call1, SerializableCallId call2, String address, String terminal) throws RemoteException, RawStateException, InvalidArgumentException, MethodNotSupportedException,
	PrivilegeViolationException, ResourceUnavailableException;
	 /**
	  * Start playing a set of audio streams named by the streamIds (may be urls).
	  *
	  * @param terminal The terminal to play the audio on.
	  * @param streamIds The ids for the audi streams to play, usually URLs
	  * @param int offset The number of milliseconds into the audio to start
	  * @param rtcs A set of runtime control sets that tune the playing.
	  * @param optArgs A dictionary of control arguments.
	  *
	  * @exception MediaResourceException A wrapper for a PlayerEvent that describes what went wrong.
	  **/
	 void play(String terminal, String[] streamIds, int offset, RTCHolder[] rtcs, Dictionary optArgs) throws MediaResourceException, RemoteException; 
/**
  * Start recording an audio streams named by the streamId (may be urls).
  *
  * @param terminal The terminal to record the audio from.
  * @param streamId The id for the audio streams to create, usually a URL
  * @param rtcs A set of runtime control sets that tune the recording.
  * @param optArgs A dictionary of control arguments.
  *
  * @exception MediaResourceException A wrapper for a RecorderEvent that describes what went wrong.
  **/
void record(String terminal, String streamId, RTCHolder[] rtcs, Dictionary optArgs) throws MediaResourceException, RemoteException;
/**
  * Release a connection to a call (Connection)
  *
  * @param address The address that we want to release
  * @param call The call to disconnect from
  *
  * @exception RemoteException A distribution (network) error has occured.
  *
  * @author: Richard Deadman
  **/
void release(String address, SerializableCallId call) throws RemoteException, PrivilegeViolationException,
	ResourceUnavailableException, MethodNotSupportedException, RawStateException;
/**
 * Tell the provider that it may release a call id for future use.  This is necessary to ensure that
 * provider call ids are not released until the JTAPI layer is notified of the death of the call.
 * Creation date: (2000-02-17 22:25:48)
 * @author: Richard Deadman
 * @param id The CallId that may be freed.
 */
void releaseCallId(SerializableCallId id) throws RemoteException;
/**
  * Remove a listener for RawEvents
  *
  * @param rl Listener to remove
  * @return void
  * @exception RemoteException A distribution (network) error has occured.
  *
  * @author: Richard Deadman
  **/
void removeListener(RemoteListener rl) throws RemoteException;
/**
 * Tell the RawProvider that Calls which reach this Address should have Call, Connection and TerminalConnections
 * events reported on them.
 * Creation date: (2000-03-07 15:17:16)
 * @author: Richard Deadman
 * @param address The name of the address to change the reporting status on.
 * @param flag true if reporting is to be enabled, false to stop events relating to the call.
 * @exception InvalidArgumentException If the address is not known by the telephony provider.
 * @exception ResourceUnavailableException If the provider could not find the reources to report the calls.
 */
void reportCallsOnAddress(String address, boolean flag) throws RemoteException, InvalidArgumentException, ResourceUnavailableException;
/**
 * Tell the RawProvider that Calls which reach this Terminal should have Call, Connection and TerminalConnections
 * events reported on them.
 * Creation date: (2000-03-07 15:17:16)
 * @author: Richard Deadman
 * @return true if the terminal is known, false otherwise
 * @param address The name of the terminal to change the reporting status on.
 * @param flag true if reporting is to be enabled, false to stop events relating to the call.
 * @exception InvalidArgumentException If the terminal is not known by the telephony provider.
 * @exception ResourceUnavailableException If the reporting could not be started due to resource constraints.
 */
void reportCallsOnTerminal(String terminal, boolean flag) throws RemoteException, InvalidArgumentException, ResourceUnavailableException;
/**
  * Tell the provider to reserve a call id for future use.  The provider does not have to hang onto it.
  * Creation date: (2000-02-16 14:48:48)
  * @author: Richard Deadman
  * @return The CallId created by the provider.
  * @param address The address the call will start from.
  * @exception RemoteException A distribution (network) error has occured.
  * @exception InvalidArgumentException The remote provider does not know the Address.
  *
  * @author: Richard Deadman
  **/
SerializableCallId reserveCallId(String address) throws RemoteException, InvalidArgumentException;
/**
  * Receive DTMF tones from a terminal
  *
  * @param terminal The terminal the signal receiver is attached to.
  * @param num The number of signals to retrieve
  * @param syms A set of symbols patterns to return
  * @param rtcs A set of runtime control sets that tune the signalling.
  * @param optArgs A dictionary of control arguments.
  * @return A RawSigDetectEvent factory for creating an event that can be sent getSignalBuffer() to retrieve the signals.
  *
  * @exception MediaResourceException A wrapper for a SignalDetectorEvent that describes what went wrong.
  **/
RawSigDetectEvent retrieveSignals(String terminal, int num, SymbolHolder[] patterns, RTCHolder[] rtcs, Dictionary optArgs) throws MediaResourceException, RemoteException;
/**
 * Sends PrivateData for a raw TelephonyProviderInterface Object for it to act upon immediately.
 * <P>This method is mapped to any of six logical raw TPI provider objects based on the following
 * mapping, where the three columns represent the three method parameters:
 * <table BORDER >
 *<tr BGCOLOR="#C0C0C0">
 *<td></td>
 *
 *<th>Call</th>
 *
 *<th>Address</th>
 *
 *<th>Terminal</th>
 *</tr>
 *
 *<tr>
 *<td>Provider</td>
 *
 *<td></td>
 *
 *<td></td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>Call</td>
 *
 *<td>X</td>
 *
 *<td></td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>Address</td>
 *
 *<td></td>
 *
 *<td>X</td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>Terminal</td>
 *
 *<td></td>
 *
 *<td></td>
 *
 *<td>X</td>
 *</tr>
 *
 *<tr>
 *<td>Connection</td>
 *
 *<td>X</td>
 *
 *<td>X</td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>TerminalConnection</td>
 *
 *<td>X</td>
 *
 *<td>X</td>
 *
 *<td>X</td>
 *</tr>
 *
 * <caption ALIGN=BOTTOM><i>"blank" indicates void</i></caption>
 * </table>
 * Creation date: (2000-08-05 22:25:45)
 * return Any serializable object.  If the object's Capabilities.canSendPrivateData() returns false, this returns null.
 * @param call A CallId or void
 * @param address An Address name or void
 * @param terminal A Terminal name or void
 * @param data Any serializable object.
 * @throws NotSerializableException If the returned object is not serializable.
 */
Serializable sendPrivateData(CallId call, String address, String terminal, Serializable data) throws RemoteException, NotSerializableException;
/**
  * Play DTMF tones on a terminal
  *
  * @param terminal The terminal to record the audio from.
  * @param syms A set of symbols to play
  * @param rtcs A set of runtime control sets that tune the signalling.
  * @param optArgs A dictionary of control arguments.
  *
  * @exception MediaResourceException A wrapper for a SignalGeneratorEvent that describes what went wrong.
  **/
void sendSignals(String terminal, SymbolHolder[] syms, RTCHolder[] rtcs, Dictionary optArgs) throws MediaResourceException, RemoteException;
/**
 * setLoadControl method comment.
 */
public void setLoadControl(java.lang.String startAddr, java.lang.String endAddr, double duration, double admissionRate, double interval, int[] treatment) throws javax.telephony.MethodNotSupportedException, RemoteException;
/**
 * Set the PrivateData for a raw TelephonyProviderInterface Object.
 * This applies to the next action on the Object.
 * <P>This method is mapped to any of six logical raw TPI provider objects based on the following
 * mapping, where the three columns represent the three method parameters:
 * <table BORDER >
 *<tr BGCOLOR="#C0C0C0">
 *<td></td>
 *
 *<th>Call</th>
 *
 *<th>Address</th>
 *
 *<th>Terminal</th>
 *</tr>
 *
 *<tr>
 *<td>Provider</td>
 *
 *<td></td>
 *
 *<td></td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>Call</td>
 *
 *<td>X</td>
 *
 *<td></td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>Address</td>
 *
 *<td></td>
 *
 *<td>X</td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>Terminal</td>
 *
 *<td></td>
 *
 *<td></td>
 *
 *<td>X</td>
 *</tr>
 *
 *<tr>
 *<td>Connection</td>
 *
 *<td>X</td>
 *
 *<td>X</td>
 *
 *<td></td>
 *</tr>
 *
 *<tr>
 *<td>TerminalConnection</td>
 *
 *<td>X</td>
 *
 *<td>X</td>
 *
 *<td>X</td>
 *</tr>
 *
 * <caption ALIGN=BOTTOM><i>"blank" indicates void</i></caption>
 * </table>
 * Creation date: (2000-08-05 22:25:45)
 * @param call A CallId or void
 * @param address An Address name or void
 * @param terminal A Terminal name or void
 * @param data Any serializable object.
 */
void setPrivateData(CallId call, String address, String terminal, Serializable data) throws RemoteException;
/**
  * Perform any cleanup after my holder has finished with me.
  * Creation date: (2000-02-11 13:07:46)
  * @exception RemoteException A distribution (network) error has occured.
  *
  * @author: Richard Deadman
  **/
void shutdown() throws RemoteException;
/**
 * Stop any media resources attached to a terminal.
 * Creation date: (2000-03-09 16:08:12)
 * @author: Richard Deadman
 * @param terminal The terminal name.
 */
void stop(String terminal) throws RemoteException;
/**
 * Tell the RawProvider that a certain Call no longer needs to have Call, Connection and
 * TerminalConnections events reported.
 * Creation date: (2000-03-07 15:17:16)
 * @author: Richard Deadman
 * @return true if the call is known, false otherwise
 * @param call The handle on the call to turn state change reporting off for.
 */
boolean stopReportingCall(SerializableCallId call) throws RemoteException;
/**
 * Send Runtime control actions to media resources bound to a terminal.
 * Creation date: (2000-03-09 16:09:09)
 * @author: Richard Deadman
 * @param terminal The name of the terminal the media resources are bound to.
 * @param action The RTC action symbol to invoke on the media resources.
 */
void triggerRTC(String terminal, SymbolHolder action) throws RemoteException;
/**
  * Take a call off hold (CallControlTerminalConnection)
  *
  * @param term The terminal that we want to take off hold
  * @param call The call to reconnect to
  *
  * @exception RemoteException A distribution (network) error has occured.
  *
  * @author: Richard Deadman
  **/
void unHold(SerializableCallId call, String address, String term) throws RemoteException, RawStateException, MethodNotSupportedException,
	PrivilegeViolationException, ResourceUnavailableException;
}