com.avaya.jtapi.tsapi
Interface ITsapiProviderEx

All Superinterfaces:

CallCenterProvider, ITsapiProvider, Provider

All Known Subinterfaces:

com.avaya.jtapi.tsapi.ITsapiProviderEx2, LucentProvider, LucentV5Provider, LucentV7Provider

public interface ITsapiProviderEx
extends ITsapiProvider

This interface extends ITsapiProvider with new methods to support AES 4.1 features. The Alternate Tlink Selection feature allows the TSAPI.PRO file for the JTAPI client library to specify a list of Alternate Tlinks for the Preferred Tlink. If the Preferred Tlink is unavailable, the JTAPI client library attempts to open a session with an Alternate Tlink. An application may determine the actual Tlink in use by invoking the Provider's getServerID() method. The TSAPI server-to-client heartbeat mechanism allows the JTAPI client library to monitor heartbeat events sent by the Tserver. If two consecutive heartbeat events are missed, then the session's Provider is shutdown. An application may change the heartbeat interval (default 20 seconds) by invoking the Provider's setHeartbeatInterval() method.

Author:

Avaya, Inc.

Field Summary

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

TSAPI_IN_SERVICE, TSAPI_INITIALIZING, TSAPI_OUT_OF_SERVICE, TSAPI_SHUTDOWN

Method Summary

java.lang.String	getServerID()
void	setHeartbeatInterval(short heartbeatInterval) Sets the interval at which the Tserver sends heartbeat events to the client.

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

getTsapiState, getVendor, getVendorVersion, setDebugPrinting, updateAddresses

Methods inherited from interface javax.telephony.callcenter.CallCenterProvider

getACDAddresses, getACDManagerAddresses, getRouteableAddresses

Method Detail

getServerID

java.lang.String getServerID()

Returns:

Returns the TSAPI server ID (Tlink name) of the Provider. When the Alternate Tlink Selection feature is in use, this may may differ from the requested server ID.

setHeartbeatInterval

void setHeartbeatInterval(short heartbeatInterval)
                          throws TsapiInvalidArgumentException

Sets the interval at which the Tserver sends heartbeat events to the client. If two consecutive heartbeat events are missed, then the TSAPI session's Provider is shutdown.

Parameters:

heartbeatInterval - The new heartbeat interval, in seconds.

Throws:

TsapiInvalidArgumentException - If the heartbeat interval is not valid. For AES 4.1, the minimum value is 5 seconds and the maximum value is 60 seconds.