com.avaya.jtapi.tsapi
Class LucentV5TerminalConnectionExImpl

java.lang.Object
  com.avaya.jtapi.tsapi.LucentV5TerminalConnectionExImpl

All Implemented Interfaces:

ITsapiConnIDPrivate, ITsapiTerminalConnection, LucentTerminalConnection, LucentV5TerminalConnection, LucentV5TerminalConnectionEx, CallControlTerminalConnection, MediaTerminalConnection, PrivateData, TerminalConnection

public final class LucentV5TerminalConnectionExImpl
extends java.lang.Object
implements LucentV5TerminalConnectionEx

Field Summary

Fields inherited from interface com.avaya.jtapi.tsapi.LucentTerminalConnection

DR_CALL_CLASSIFIER, DR_NONE, DR_TONE_GENERATOR

Fields inherited from interface javax.telephony.TerminalConnection

ACTIVE, PASSIVE

Fields inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection

BRIDGED, DROPPED, HELD, IDLE, INUSE, RINGING, TALKING, UNKNOWN

Fields inherited from interface javax.telephony.TerminalConnection

ACTIVE, PASSIVE

Fields inherited from interface javax.telephony.media.MediaTerminalConnection

AVAILABLE, NOACTIVITY, PLAYING, RECORDING, UNAVAILABLE

Fields inherited from interface javax.telephony.TerminalConnection

ACTIVE, PASSIVE

Method Summary

void	answer() Answers a telephone call.
boolean	equals(java.lang.Object obj) This overrides the Object classes equals method.
void	generateDtmf(java.lang.String digits)
void	generateDtmf(java.lang.String digits, int toneDuration, int pauseDuration) generateDtmf() with tone and pause duration
int	getCallControlState() Returns the call control state of the TerminalConnection object.
TerminalConnectionCapabilities	getCapabilities() Returns the dynamic capabilities for the instance of the TerminalConnection object.
Connection	getConnection() Returns the Connection object associated with this TerminalConnection.
int	getMediaAvailability() Returns the current media availability state, either AVAILABLE or UNAVAILABLE.
int	getMediaState() Returns the current state of the terminal connection as a bit mask of PLAYING and RECORDING.
java.lang.Object	getPrivateData() Returns some platform-specific data associated with the last method that was invoked on the object for which this PrivateData is implemented.
int	getState() Returns the state of the TerminalConnection object.
Terminal	getTerminal() Returns the Terminal associated with this TerminalConnection object.
TerminalConnectionCapabilities	getTerminalConnectionCapabilities(Terminal terminal, Address address) Deprecated in JTAPI v1.2.
ConnectionID	getTsapiConnectionID() Retrieves the TSAPI ConnectionID associated with a JTAPI Connection or TerminalConnection.
int	hashCode()
void	hold() Places a TerminalConnection on hold with respect to the telephone call of which it is a part.
void	join() Makes a TerminalConnection which is bridged with a telephone call active on that telephone call.
void	leave() Takes a TerminalConnection which is active in a telephone call and places it back into the bridged state.
void	leave(short dropResource, UserToUserInfo userInfo)
void	listenHold(LucentConnection partyToHold) Places the TerminalConnection on listen-hold with respect to the specified Connection (all, if null).
void	listenHold(LucentTerminalConnection partyToHold) Places the TerminalConnection on listen-hold with respect to the specified TerminalConnection (all, if null).
void	listenUnhold(LucentConnection partyToUnhold) Takes the TerminalConnection off listen-hold with respect to the specified Connection (all, if null).
void	listenUnhold(LucentTerminalConnection partyToUnhold) Takes the TerminalConnection off listen-hold with respect to the specified TerminalConnection (all, if null).
java.lang.Object	sendPrivateData(java.lang.Object data) Immediately performs some platform-specific action.
void	setDtmfDetection(boolean enable)
void	setPrivateData(java.lang.Object data) Associates some platform-specific data with the next method that is invoked on the object for which this interface is implemented.
void	startPlaying() Start the playing.
void	startRecording() Start the recording.
void	stopPlaying() Stop the playing.
void	stopRecording() Stop the recording.
void	unhold() Takes a TerminalConnection off hold with respect to the telephone call of which it is a part.
void	useDefaultMicrophone() Instructs the terminal connection to use the default microphone for playing to the telephone line.
void	useDefaultSpeaker() Instructs the terminal connection to use the default speaker for recording from the telephone line.
void	usePlayURL(java.net.URL url) Instructs the terminal connection to use a file for playing to the telephone line.
void	useRecordURL(java.net.URL url) Instructs the terminal connection to use a file for recording from the telephone line.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.avaya.jtapi.tsapi.LucentV5TerminalConnectionEx

generateDtmf

Methods inherited from interface com.avaya.jtapi.tsapi.LucentV5TerminalConnection

listenHold, listenHold, listenUnhold, listenUnhold

Methods inherited from interface com.avaya.jtapi.tsapi.LucentTerminalConnection

leave

Methods inherited from interface javax.telephony.TerminalConnection

answer, getCapabilities, getConnection, getState, getTerminal, getTerminalConnectionCapabilities

Methods inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection

getCallControlState, hold, join, leave, unhold

Methods inherited from interface javax.telephony.TerminalConnection

answer, getCapabilities, getConnection, getState, getTerminal, getTerminalConnectionCapabilities

Methods inherited from interface javax.telephony.media.MediaTerminalConnection

generateDtmf, getMediaAvailability, getMediaState, setDtmfDetection, startPlaying, startRecording, stopPlaying, stopRecording, useDefaultMicrophone, useDefaultSpeaker, usePlayURL, useRecordURL

Methods inherited from interface javax.telephony.TerminalConnection

answer, getCapabilities, getConnection, getState, getTerminal, getTerminalConnectionCapabilities

Method Detail

equals

public boolean equals(java.lang.Object obj)

This overrides the Object classes equals method.

getState

public final int getState()

Returns the state of the TerminalConnection object.

Specified by:

getState in interface TerminalConnection

Returns:

The current state of the TerminalConnection object.

getTerminal

public final Terminal getTerminal()

Returns the Terminal associated with this TerminalConnection object.

Specified by:

getTerminal in interface TerminalConnection

Returns:

The Terminal object associated with this TerminalConnection.

getConnection

public final Connection getConnection()

Returns the Connection object associated with this TerminalConnection.

Specified by:

getConnection in interface TerminalConnection

Returns:

The Connections associated with this TerminalConnection.

answer

public final void answer()
                  throws TsapiPrivilegeViolationException,
                         TsapiResourceUnavailableException,
                         TsapiMethodNotSupportedException,
                         TsapiInvalidStateException

Answers a telephone call.

Specified by:

answer in interface TerminalConnection

Throws:

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

TsapiMethodNotSupportedException

TsapiInvalidStateException

See Also:

TerminalConnectionListener, ConnectionListener, TerminalConnectionEvent, ConnectionEvent

getCapabilities

public final TerminalConnectionCapabilities getCapabilities()

Description copied from interface: TerminalConnection

Returns the dynamic capabilities for the instance of the TerminalConnection object. Dynamic capabilities tell the application which actions are possible at the time this method is invoked based upon the implementations knowledge of its ability to successfully perform the action. This determination may be based upon argument passed to this method, the current state of the call model, or some implementation- specific knowledge. These indications do not guarantee that a particular method will be successful when invoked, however.

The dynamic TerminalConnection capabilities require no additional arguments.

Specified by:

getCapabilities in interface TerminalConnection

Returns:

The dynamic TerminalConnection capabilities.

getTerminalConnectionCapabilities

public final TerminalConnectionCapabilities getTerminalConnectionCapabilities(Terminal terminal,
                                                                              Address address)
                                                                       throws InvalidArgumentException,
                                                                              PlatformException

Deprecated in JTAPI v1.2. Call getCapabilities().

Specified by:

getTerminalConnectionCapabilities in interface TerminalConnection

Parameters:

terminal - This argument is ignored in JTAPI v1.2 and later.

address - This argument is ignored in JTAPI v1.2 and later.

Returns:

The static TerminalConnectionCapabilities capabilities.

Throws:

InvalidArgumentException - This exception is never thrown in JTAPI v1.2 and later.

PlatformException - A platform-specific exception occurred.

getCallControlState

public final int getCallControlState()

Returns the call control state of the TerminalConnection object.

Specified by:

getCallControlState in interface CallControlTerminalConnection

Returns:

The current call control state of the TerminalConnection.

hold

public final void hold()
                throws TsapiInvalidStateException,
                       TsapiMethodNotSupportedException,
                       TsapiPrivilegeViolationException,
                       TsapiResourceUnavailableException

Places a TerminalConnection on hold with respect to the telephone call of which it is a part.

Specified by:

hold in interface CallControlTerminalConnection

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

See Also:

CallCtlTermConnHeldEv

unhold

public final void unhold()
                  throws TsapiInvalidStateException,
                         TsapiMethodNotSupportedException,
                         TsapiPrivilegeViolationException,
                         TsapiResourceUnavailableException

Takes a TerminalConnection off hold with respect to the telephone call of which it is a part.

Specified by:

unhold in interface CallControlTerminalConnection

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

See Also:

CallCtlTermConnTalkingEv

listenHold

public final void listenHold(LucentTerminalConnection partyToHold)
                      throws TsapiInvalidStateException,
                             TsapiInvalidArgumentException,
                             TsapiMethodNotSupportedException,
                             TsapiPrivilegeViolationException,
                             TsapiResourceUnavailableException

Places the TerminalConnection on listen-hold with respect to the specified TerminalConnection (all, if null).

Throws:

TsapiInvalidStateException

TsapiInvalidArgumentException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

listenUnhold

public final void listenUnhold(LucentTerminalConnection partyToUnhold)
                        throws TsapiInvalidStateException,
                               TsapiInvalidArgumentException,
                               TsapiMethodNotSupportedException,
                               TsapiPrivilegeViolationException,
                               TsapiResourceUnavailableException

Takes the TerminalConnection off listen-hold with respect to the specified TerminalConnection (all, if null).

Throws:

TsapiInvalidStateException

TsapiInvalidArgumentException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

listenHold

public final void listenHold(LucentConnection partyToHold)
                      throws TsapiInvalidStateException,
                             TsapiInvalidArgumentException,
                             TsapiMethodNotSupportedException,
                             TsapiPrivilegeViolationException,
                             TsapiResourceUnavailableException

Places the TerminalConnection on listen-hold with respect to the specified Connection (all, if null).

Throws:

TsapiInvalidStateException

TsapiInvalidArgumentException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

listenUnhold

public final void listenUnhold(LucentConnection partyToUnhold)
                        throws TsapiInvalidStateException,
                               TsapiInvalidArgumentException,
                               TsapiMethodNotSupportedException,
                               TsapiPrivilegeViolationException,
                               TsapiResourceUnavailableException

Takes the TerminalConnection off listen-hold with respect to the specified Connection (all, if null).

Throws:

TsapiInvalidStateException

TsapiInvalidArgumentException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

join

public final void join()
                throws TsapiInvalidStateException,
                       TsapiMethodNotSupportedException,
                       TsapiPrivilegeViolationException,
                       TsapiResourceUnavailableException

Makes a TerminalConnection which is bridged with a telephone call active on that telephone call.

Specified by:

join in interface CallControlTerminalConnection

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

See Also:

TermConnActiveEv, CallCtlTermConnTalkingEv

leave

public final void leave()
                 throws TsapiInvalidStateException,
                        TsapiMethodNotSupportedException,
                        TsapiPrivilegeViolationException,
                        TsapiResourceUnavailableException

Takes a TerminalConnection which is active in a telephone call and places it back into the bridged state.

Specified by:

leave in interface CallControlTerminalConnection

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

See Also:

TermConnPassiveEv, TermConnDroppedEv, ConnDisconnectedEv, CallCtlTermConnBridgedEv, CallCtlTermConnDroppedEv, CallCtlConnDisconnectedEv

leave

public final void leave(short dropResource,
                        UserToUserInfo userInfo)
                 throws TsapiInvalidStateException,
                        TsapiMethodNotSupportedException,
                        TsapiPrivilegeViolationException,
                        TsapiResourceUnavailableException

Throws:

TsapiInvalidStateException

TsapiMethodNotSupportedException

TsapiPrivilegeViolationException

TsapiResourceUnavailableException

generateDtmf

public final void generateDtmf(java.lang.String digits)
                        throws TsapiMethodNotSupportedException,
                               TsapiResourceUnavailableException,
                               TsapiInvalidStateException

Specified by:

generateDtmf in interface MediaTerminalConnection

Throws:

TsapiMethodNotSupportedException

TsapiResourceUnavailableException

TsapiInvalidStateException

generateDtmf

public final void generateDtmf(java.lang.String digits,
                               int toneDuration,
                               int pauseDuration)
                        throws TsapiMethodNotSupportedException,
                               TsapiResourceUnavailableException,
                               TsapiInvalidStateException

generateDtmf() with tone and pause duration

Throws:

TsapiMethodNotSupportedException

TsapiResourceUnavailableException

TsapiInvalidStateException

getMediaAvailability

public final int getMediaAvailability()

Description copied from interface: MediaTerminalConnection

Returns the current media availability state, either AVAILABLE or UNAVAILABLE.

Specified by:

getMediaAvailability in interface MediaTerminalConnection

Returns:

The current availability of the media channel.

getMediaState

public final int getMediaState()

Description copied from interface: MediaTerminalConnection

Returns the current state of the terminal connection as a bit mask of PLAYING and RECORDING. If there is not activity, then this method returns MediaTerminalConnection.NOACTIVITY.

Specified by:

getMediaState in interface MediaTerminalConnection

Returns:

The current state of playing or recording.

useDefaultSpeaker

public final void useDefaultSpeaker()
                             throws TsapiMethodNotSupportedException

Description copied from interface: MediaTerminalConnection

Instructs the terminal connection to use the default speaker for recording from the telephone line.

Specified by:

useDefaultSpeaker in interface MediaTerminalConnection

Throws:

TsapiMethodNotSupportedException

useRecordURL

public final void useRecordURL(java.net.URL url)
                        throws TsapiMethodNotSupportedException

Description copied from interface: MediaTerminalConnection

Instructs the terminal connection to use a file for recording from the telephone line.

Specified by:

useRecordURL in interface MediaTerminalConnection

Parameters:

url - The URL-destination for the voice data for recording.

Throws:

TsapiMethodNotSupportedException

useDefaultMicrophone

public final void useDefaultMicrophone()
                                throws TsapiMethodNotSupportedException

Description copied from interface: MediaTerminalConnection

Instructs the terminal connection to use the default microphone for playing to the telephone line.

Specified by:

useDefaultMicrophone in interface MediaTerminalConnection

Throws:

TsapiMethodNotSupportedException

usePlayURL

public final void usePlayURL(java.net.URL url)
                      throws TsapiMethodNotSupportedException

Description copied from interface: MediaTerminalConnection

Instructs the terminal connection to use a file for playing to the telephone line.

Specified by:

usePlayURL in interface MediaTerminalConnection

Parameters:

url - The URL-source of the voice data to play. valid or available source of voice data.

Throws:

TsapiMethodNotSupportedException

startPlaying

public final void startPlaying()
                        throws TsapiMethodNotSupportedException

Description copied from interface: MediaTerminalConnection

Start the playing. This method returns once playing has begun, that is, when getMediaState() & PLAYING == PLAYING.

Specified by:

startPlaying in interface MediaTerminalConnection

Throws:

TsapiMethodNotSupportedException

stopPlaying

public final void stopPlaying()

Description copied from interface: MediaTerminalConnection

Stop the playing. This method returns once the playing has stopped, that is, when getMediaState() & PLAYING == 0. If playing is not currently taking place, this method has no effect.

Specified by:

stopPlaying in interface MediaTerminalConnection

startRecording

public final void startRecording()
                          throws TsapiMethodNotSupportedException

Description copied from interface: MediaTerminalConnection

Start the recording. This method returns once the recording has started, that is, when getMediaState() & RECORDING == RECORDING.

Specified by:

startRecording in interface MediaTerminalConnection

Throws:

TsapiMethodNotSupportedException

stopRecording

public final void stopRecording()

Description copied from interface: MediaTerminalConnection

Stop the recording. This method returns once the recording has stopped, that is, when getMediaState() & RECORDING == 0. If recording is not currently taking place, this method has no effect.

Specified by:

stopRecording in interface MediaTerminalConnection

setDtmfDetection

public final void setDtmfDetection(boolean enable)
                            throws TsapiMethodNotSupportedException

Specified by:

setDtmfDetection in interface MediaTerminalConnection

Throws:

TsapiMethodNotSupportedException

setPrivateData

public final void setPrivateData(java.lang.Object data)

Description copied from interface: PrivateData

Associates some platform-specific data with the next method that is invoked on the object for which this interface is implemented. The format of this data and the manner in which it modifies the method invocation is platform-dependent. This data applies to the next method invocation ONLY and does not affect any future method invocations.

Specified by:

setPrivateData in interface PrivateData

Parameters:

data - The platform-dependent data.

getPrivateData

public final java.lang.Object getPrivateData()

Description copied from interface: PrivateData

Returns some platform-specific data associated with the last method that was invoked on the object for which this PrivateData is implemented. The format of this data is platform-dependent. This data pertains to the last method invocation ONLY.

Specified by:

getPrivateData in interface PrivateData

Returns:

Object The platform-dependent data.

sendPrivateData

public final java.lang.Object sendPrivateData(java.lang.Object data)

Description copied from interface: PrivateData

Immediately performs some platform-specific action. The effect of this methods invocation is immediate and does not directly relate to any future object method invocations. The action taken upon receipt of this data is platform-dependent as is the format of the data itself. This method returns the platform-dependent data actually sent.

Specified by:

sendPrivateData in interface PrivateData

Parameters:

data - The platform-dependent data.

Returns:

The platform-dependent data sent.

getTsapiConnectionID

public final ConnectionID getTsapiConnectionID()

Description copied from interface: ITsapiConnIDPrivate

Retrieves the TSAPI ConnectionID associated with a JTAPI Connection or TerminalConnection.

Specified by:

getTsapiConnectionID in interface ITsapiConnIDPrivate

See Also:

ConnectionID

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object