Cisco JTAPI Developer Guide for Cisco CallManager 4.2(1)
Cisco JTAPI Implementation
Downloads: This chapterpdf (PDF - 2.34MB) The complete bookPDF (PDF - 4.52MB) | Feedback

Cisco JTAPI Implementation

Table Of Contents

Cisco JTAPI Implementation

Cisco JTAPI Extensions Hierarchy

Class Hierarchy

Interface Hierarchy

Class com.cisco.jtapi.extensions

CiscoAddrAddedToTerminalEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrAutoAcceptStatusChangedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrCreatedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddress

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddressCallInfo

Declaration

Constructors

Methods

CiscoAddressObserver

Declaration

All Superinterfaces

Description

CiscoAddrEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoAddrInServiceEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrOutOfServiceEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrRemovedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoAddrRemovedFromTerminalEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoCall

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Methods

CiscoCallChangedEv

Declaration

All Superinterfaces

Description

Methods

CiscoCallEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Fields

Methods

CiscoCallID

Declaration

All Superinterfaces

Description

Methods

CiscoConferenceEndEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoConferenceStartEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoConnection

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoConnectionID

Declaration

All Superinterfaces

Description

Methods

CiscoConsultCall

Declaration

All Superinterfaces

Description

Methods

CiscoConsultCallActiveEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoG711MediaCapability

Declaration

Description

Fields

Constructors

CiscoG723MediaCapability

Declaration

Description

Fields

Constructors

Methods

CiscoG729MediaCapability

Declaration

Description

Fields

Constructors

CiscoGSMMediaCapability

Declaration

Description

Fields

Constructors

CiscoJtapiException

Declaration

Description

Fields

Methods

CiscoJtapiPeer

Declaration

All Superinterfaces

Description

Methods

CiscoJtapiProperties

Declaration

Description

Methods

CiscoJtapi Version

Declaration

Description

Constructors

Methods

CiscoMediaCapability

Declaration

Direct Known Subclasses

Description

Fields

Constructors

Methods

CiscoMediaOpenLogicalChannelEv

Declaration

All Known Subinterfaces

Description

Fields

Methods

CiscoMediaTerminal

Declaration

All Superinterfaces

Description

Methods

CiscoObjectContainer

Declaration

All Known Subinterfaces

Description

Methods

CiscoOutOfServiceEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Fields

CiscoPartyInfo

Declaration

Description

Methods

CiscoProvCallParkEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoProvEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoProvFeatureEv

Declaration

All Superinterfaces

All Known Subinterfaces

Methods

CiscoProvFeatureID

Declaration

Description

Fields

CiscoProvFeatureUnRegisteredEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoProvider

Declaration

All Superinterfaces

Description

Methods

CiscoProviderCapabilities

Declaration

All Superinterfaces

Description

Methods

CiscoProviderObserver

Declaration

All Superinterfaces

Description

CiscoRegistrationException

Declaration

All Implemented Interfaces

Description

Constructors

CiscoRouteAddress

Declaration

All Superinterfaces

Methods

CiscoRouteSession

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRouteTerminal

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRouteUsedEvent

Declaration

All Superinterfaces

Description

Methods

CiscoRTPBitRate

Declaration

Description

Fields

CiscoRTPHandle

Declaration

Description

Methods

CiscoRTPInputProperties

Declaration

Description

Methods

CiscoRTPInputStartedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPInputStoppedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPOutputProperties

Declaration

Description

Methods

CiscoRTPOutputStartedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPOutputStoppedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoRTPParams

Declaration

Constructors

Methods

CiscoRTPPayload

Declaration

Description

Fields

CiscoSynchronousObserver

Declaration

Description

CiscoTermButtonPressedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermConnPrivacyChangedEv

Declaration

Description

Fields

Methods

CiscoTermCreatedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermDataEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermDeviceStateActiveEv

Declaration

All Super-Interfaces

Description

Methods

CiscoTermDeviceStateAlertingEv

Declaration

All Super-Interfaces

Description

Methods

CiscoTermDeviceStateHeldEv

Declaration

All Super-Interfaces

Description

Methods

CiscoTermDeviceStateIdleEv

Declaration

All Superinterfaces

Description

Methods

CiscoTermEv

Declaration

All Superinterfaces

All Known Subinterfaces

Description

CiscoTermEvFilter

Declaration

Description

Methods

CiscoTerminal

Declaration

All Superinterfaces

All Known Subinterfaces

Description

Fields

Methods

CiscoTerminalConnection

Declaration

All Superinterfaces

Description

Methods

CiscoTerminalObserver

Declaration

All Superinterfaces:

Description

CiscoTermInServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoTermOutOfServiceEv

Declaration

All Superinterfaces

Description

Fields

CiscoTermRegistrationFailedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTermRemovedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoToneChangedEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTransferEndEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoTransferStartEv

Declaration

All Superinterfaces

Description

Fields

Methods

CiscoUnregistrationException

Declaration

All Implemented Interfaces

Description

Constructors

CiscoWideBandMediaCapability

Description

Fields

Constructors

Class com.cisco.services.alarm

Alarm

Declaration

All Known Implementing Classes

Description

Fields

Methods

AlarmManager

Declaration

Description

Constructors

Methods

AlarmWriter

Declaration

All Known Implementing Classes

Description

Methods

DefaultAlarm

Declaration

All Implemented Interfaces

Description

Constructors

Methods

DefaultAlarmWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

ParameterList

Declaration

Description

Constructors

Methods

Class com.cisco.services.tracing

BaseTraceWriter

Declaration

All Implemented Interfaces

Direct Known Subclasses

Description

Constructors

Methods

ConditionalTrace

Declaration

All Superinterfaces

Description

Methods

ConsoleTraceWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

LogFileTraceWriter

Declaration

All Implemented Interfaces

Description

Fields

Constructors

Methods

OutputStreamTraceWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

SyslogTraceWriter

Declaration

All Implemented Interfaces

Description

Constructors

Methods

Trace

Declaration

All Known Subinterfaces

Description

Fields

Methods

TraceManager

Declaration

Description

Methods

TraceManagerFactory

Declaration

Description

Methods

TraceModule

Declaration

All Known Subinterfaces

Description

Methods

TraceWriter

Declaration

All Known Subinterfaces

All Known Implementing Classes

Description

Methods

TraceWriterManager

Declaration

All Superinterfaces

Description

Methods

UnconditionalTrace

Declaration

All Superinterfaces

Description


Cisco JTAPI Implementation


Cisco JTAPI implementation describes interfaces and classes available. To create new applications, use these interfaces and classes with the standard JTAPI interfaces and classes supported by Cisco JTAPI.

This chapter contains the following sections:

Cisco JTAPI Extensions Hierarchy

Class com.cisco.jtapi.extensions

Class com.cisco.services.alarm

Class com.cisco.services.tracing

Cisco JTAPI Extensions Hierarchy

Class Hierarchy

class java.lang.Object

class com.cisco.services.alarm.AlarmManager

class com.cisco.services.tracing.BaseTraceWriter (implements com.cisco.services.tracing.TraceWriter)

class com.cisco.services.tracing.ConsoleTraceWriter

class com.cisco.services.tracing.LogFileTraceWriter

class com.cisco.services.tracing.OutputStreamTraceWriter

class com.cisco.services.tracing.SyslogTraceWriter

class com.cisco.jtapi.extensions.CiscoAddressCallInfo

class com.cisco.jtapi.extensions.CiscoJtapiVersion

class com.cisco.jtapi.extensions.CiscoMediaCapability

class com.cisco.jtapi.extensions.CiscoG711MediaCapability

class com.cisco.jtapi.extensions.CiscoG723MediaCapability

class com.cisco.jtapi.extensions.CiscoG729MediaCapability

class com.cisco.jtapi.extensions.CiscoGSMMediaCapability

class com.cisco.jtapi.extensions.CiscoRTPParams

class com.cisco.services.alarm.DefaultAlarm (implements com.cisco.services.alarm.Alarm)

class com.cisco.services.alarm.DefaultAlarmWriter (implements com.cisco.services.alarm.AlarmWriter)

class com.cisco.services.alarm.ParameterList

class java.lang.Throwable (implements java.io.Serializable)

class java.lang.Exception

class com.cisco.jtapi.extensions.CiscoRegistrationException

class com.cisco.jtapi.extensions.CiscoUnregistrationException

class com.cisco.services.tracing.TraceManagerFactory

Interface Hierarchy

interface javax.telephony.Address

interface com.cisco.jtapi.extensions.CiscoAddress (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.callcenter.RouteAddress

interface com.cisco.jtapi.extensions.CiscoRouteAddress

interface javax.telephony.AddressObserver

interface com.cisco.jtapi.extensions.CiscoAddressObserver

interface com.cisco.services.alarm.Alarm

interface com.cisco.services.alarm.AlarmWriter

interface javax.telephony.Call

interface javax.telephony.callcontrol.CallControlCall

interface com.cisco.jtapi.extensions.CiscoCall (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface com.cisco.jtapi.extensions.CiscoConsultCall

interface com.cisco.jtapi.extensions.CiscoJtapiException

interface com.cisco.jtapi.extensions.CiscoJtapiProperties

interface com.cisco.jtapi.extensions.CiscoObjectContainer

interface com.cisco.jtapi.extensions.CiscoAddress (also extends javax.telephony.Address)

interface com.cisco.jtapi.extensions.CiscoCall (also extends javax.telephony.callcontrol.CallControlCall)

interface com.cisco.jtapi.extensions.CiscoConsultCall

interface com.cisco.jtapi.extensions.CiscoCallID

interface com.cisco.jtapi.extensions.CiscoConnection (also extends javax.telephony.callcontrol.CallControlConnection)

interface com.cisco.jtapi.extensions.CiscoConnectionID

interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModule)

interface com.cisco.jtapi.extensions.CiscoProvider (also extends javax.telephony.Provider)

interface com.cisco.jtapi.extensions.CiscoTerminal (also extends javax.telephony.Terminal)

interface com.cisco.jtapi.extensions.CiscoMediaTerminal

interface com.cisco.jtapi.extensions.CiscoTerminalConnection (also extends javax.telephony.callcontrol.CallControlTerminalConnection)

interface com.cisco.jtapi.extensions.CiscoProvFeatureID

interface com.cisco.jtapi.extensions.CiscoRTPBitRate

interface com.cisco.jtapi.extensions.CiscoRTPInputProperties

interface com.cisco.jtapi.extensions.CiscoRTPOutputProperties

interface com.cisco.jtapi.extensions.CiscoRTPPayload

interface com.cisco.jtapi.extensions.CiscoSynchronousObserver

interface javax.telephony.Connection

interface javax.telephony.callcontrol.CallControlConnection

interface com.cisco.jtapi.extensions.CiscoConnection (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.events.Ev

interface javax.telephony.events.AddrEv

interface com.cisco.jtapi.extensions.CiscoAddrEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv

interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface javax.telephony.events.CallEv

interface javax.telephony.events.CallActiveEv

interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends com.cisco.jtapi.extensions.)

interface com.cisco.jtapi.extensions.CiscoCallEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoConferenceEndEv

interface com.cisco.jtapi.extensions.CiscoConferenceStartEv

interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends javax.telephony.events.CallActiveEv)

interface com.cisco.jtapi.extensions.CiscoTransferEndEv

interface com.cisco.jtapi.extensions.CiscoTransferStartEv

interface com.cisco.jtapi.extensions.CiscoEv

interface com.cisco.jtapi.extensions.CiscoAddrEv (also extends javax.telephony.events.AddrEv)

interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv

interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface com.cisco.jtapi.extensions.CiscoCallEv (also extends javax.telephony.events.CallEv)

interface com.cisco.jtapi.extensions.CiscoConferenceEndEv

interface com.cisco.jtapi.extensions.CiscoConferenceStartEv

interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends javax.telephony.events.CallActiveEv)

interface com.cisco.jtapi.extensions.CiscoTransferEndEv

interface com.cisco.jtapi.extensions.CiscoTransferStartEv

interface com.cisco.jtapi.extensions.CiscoOutOfServiceEv

interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoAddrEv)

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoTermEv)

interface com.cisco.jtapi.extensions.CiscoProvEv (also extends javax.telephony.events.ProvEv)

interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv

interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureEv

interface com.cisco.jtapi.extensions.CiscoProvCallParkEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv

interface com.cisco.jtapi.extensions.CiscoTermCreatedEv

interface com.cisco.jtapi.extensions.CiscoTermRemovedEv

interface com.cisco.jtapi.extensions.CiscoTermEv (also extends javax.telephony.events.TermEv)

interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv

interface com.cisco.jtapi.extensions.CiscoTermDataEv

interface com.cisco.jtapi.extensions.CiscoTermInServiceEv

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface javax.telephony.events.ProvEv

interface com.cisco.jtapi.extensions.CiscoProvEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv

interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureEv

interface com.cisco.jtapi.extensions.CiscoProvCallParkEv

interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv

interface com.cisco.jtapi.extensions.CiscoTermCreatedEv

interface com.cisco.jtapi.extensions.CiscoTermRemovedEv

interface javax.telephony.events.TermEv

interface com.cisco.jtapi.extensions.CiscoTermEv (also extends com.cisco.jtapi.extensions.CiscoEv)

interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv

interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv

interface com.cisco.jtapi.extensions.CiscoTermDataEv

interface com.cisco.jtapi.extensions.CiscoTermInServiceEv

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)

interface javax.telephony.JtapiPeer

interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends com.cisco.jtapi.extensions.CiscoObjectContainer, com.cisco.services.tracing.TraceModule)

interface javax.telephony.Provider

interface com.cisco.jtapi.extensions.CiscoProvider (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.capabilities.ProviderCapabilities

interface com.cisco.jtapi.extensions.CiscoProviderCapabilities

interface javax.telephony.ProviderObserver

interface com.cisco.jtapi.extensions.CiscoProviderObserver

interface javax.telephony.callcenter.RouteSession

interface com.cisco.jtapi.extensions.

interface javax.telephony.Terminal

interface com.cisco.jtapi.extensions.CiscoTerminal (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface com.cisco.jtapi.extensions.CiscoMediaTerminal

interface javax.telephony.TerminalConnection

interface javax.telephony.callcontrol.CallControlTerminalConnection

interface com.cisco.jtapi.extensions.CiscoTerminalConnection (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.TerminalObserver

interface com.cisco.jtapi.extensions.CiscoTerminalObserver

interface com.cisco.services.tracing.Trace

interface com.cisco.services.tracing.ConditionalTrace

interface com.cisco.services.tracing.UnconditionalTrace

interface com.cisco.services.tracing.TraceManager

interface com.cisco.services.tracing.TraceModule

interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends com.cisco.jtapi.extensions.CiscoObjectContainer, javax.telephony.JtapiPeer)

interface com.cisco.services.tracing.TraceWriter

interface com.cisco.services.tracing.TraceWriterManager

Class com.cisco.jtapi.extensions

The Cisco JTAPI extension consists of a set of classes and interfaces that expose the functionality available in the Cisco IP Telephony. This API allows programmers to create independent applications for Cisco CallManager. The Cisco JTAPI implementation offers additional functionality not readily exposed through the JTAPI 1.2 interfaces. Applications can use the interfaces and classes in the com.cisco.jtapi.extensions package with the standard JTAPI interfaces and classes described in the Cisco JTAPI v 1.2 Specification manual to create new applications.

CiscoAddrAddedToTerminalEv

Declaration

public interface CiscoAddrAddedToTerminalEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoAddrAddedToTerminalEv event gets sent under the following conditions:

When User adds a Terminal/Device into the user controlList that contains SharedDN, this event will be sent to application. If a user has an address in control list, and we add new device with same address in control list, this event will be sent.

When EM(Extension mobility) user logs into a Terminal with a profile that contains SharedDN, this event notifies that a new Terminal is added to an already existing Address.

A new SharedDN is added to a Device in a user control list. Interface getTerminal() returns the terminal that gets added to Address. Interface getAddress() will return the address on which the new terminal is added.

Member Summary
Fields
static int
ID
Methods
 javax.telephony.Address
javax.telephony.Terminal

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getAddress()

public javax.telephony.Address getAddress()

getTerminal()

public javax.telephony.Address getTerminal()

CiscoAddrAutoAcceptStatusChangedEv

Declaration

public interface CiscoAddrAutoAcceptStatusChangedEv extends 
CiscoAddrEv

All Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoAddrAutoAcceptStatusChangedEv event is send to Applications whenever AutoAccept status for the Address on the Terminal is changed. If an Address has multiple Terminals, then this event will be sent for Address's AutoAccept status on each individual Terminals.

Member Summary
Fields
static int
ID
Methods
int
getAutoAcceptStatus()
CiscoAddrAutoAcceptStatusChangedEv.getAutoAcceptStatus() returns following value of AutoAccept status of Address on Terminal CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON
 CiscoTerminal
Returns the terminal at which this address is going 
InService.

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface AddrEv
getAddress()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getAutoAcceptStatus()

public int getAutoAcceptStatus()

CiscoAddrAutoAcceptStatusChangedEv.getAutoAcceptStatus() returns following value of AutoAccept status of Address on Terminal CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON

See Also:

CiscoAddress.getAutoAcceptStatus()

getTerminal()

public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()

Returns the terminal at which this address is going InService

In Shared Lines, applications may receive multiple CiscoAddressInService events and the same Address appears on different Terminals. In order for Application to find out which Shared Line is going in service, Applications can use this interface. This interface returns the terminal on which Address is going in Service.

Returns:

the terminal at which this address is going InService

CiscoAddrCreatedEv

Declaration

public interface CiscoAddrCreatedEv extends CiscoProvEv

All Superinterfaces

CiscoEv,CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoAddrCreatedEv event

Member Summary
Fields
static int
ID
Methods
 javax.telephony.Address

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getAddress()

public javax.telephony.Address getAddress()

CiscoAddress

Declaration

public interface CiscoAddress extends javax.telephony.Address, 
CiscoObjectContainer

All Superinterfaces

javax.telephony.Address, CiscoObjectContainer

Description

The CiscoAddress interface extends the Address interface with additional CallManager-specific capabilities.

See Also

javax.telephony.Address

Member Summary
Fields
static int
AutoAccept is off.
static int
AutoAccept is on.
static int
This is an external address with a valid name.
static int
This is an external address with an unknown name.
static int
The address is out-of-service
static int
This is an internal address.
static int
The address is in-service
static int
Sets the ringer status to configured value
static int
Disables the ringer for the address
static int
Enables the ringer for the address
static int
This is an external address with an unknown name.
Methods
void
Use this interface to clear off any phantom calls on the 
address
 CiscoAddressCallInfo
Use this Interface to get info of calls present at the 
terminal
 int
Returns the AutoAccept status of the Address on the 
terminal
javax.telephony.Terminal
Returns an array of terminals for which this address is 
InService.
 int
Returns the state of this address.
 int
Returns the state of this address.
 int
 Returns the type of this address.
 void
Allows the application to enable AutoAccept for addresses 
on CiscoMediaTerminal and/or CiscoRouteTerminal.
 void
Specifies whether the message-waiting indicator should be 
activated or deactivated for the Address specified by the 
destination.
 void
changes the ringer status on this address 

Inherited Member Summary
Methods inherited from interface Address
addCallObserver(CallObserver), addObserver(AddressObserver), 
getAddressCapabilities(Terminal), getCallObservers(), getCapabilities(), 
getConnections(), getName(), getObservers(), getProvider(), getTerminals(), 
removeCallObserver(CallObserver), removeObserver(AddressObserver)
Methods inherited from interface CiscoObjectContainer

Fields

AUTOACCEPT_OFF

public static final int AUTOACCEPT_OFF

AutoAccept is off.

AUTOACCEPT_ON

public static final int AUTOACCEPT_ON

AutoAccept is on.

EXTERNAL

public static final int EXTERNAL

This is an external address with a valid name. An address of this type is created when ANI or callerID is available on the call.

EXTERNAL_UNKNOWN

public static final int EXTERNAL_UNKNOWN

This is an external address with an unknown name. An address of this type is created to represent an endpoint for which there is insufficient information.

IN_SERVICE

public static final int IN_SERVICE

The address is out-of-service

INTERNAL

public static final int INTERNAL

This is an internal address.

OUT_OF_SERVICE

public static final int OUT_OF_SERVICE

The address is in-service

RINGER_DEFAULT

public static final int RINGER_DEFAULT

Sets the ringer status to configured value

RINGER_DISABLE

public static final int RINGER_DISABLE

Disables the ringer for the address

RINGER_ENABLE

public static final int RINGER_ENABLE

Enables the ringer for the address

UNKNOWN

public static final int UNKNOWN

This is an external address with an unknown name. An address of this type is created to represent an endpoint for which there is insufficient information.

Methods

clearCallConnections()

public void clearCallConnections()
throws PrivilegeViolationException

Use this interface to clear off any phantom calls on the address

Throws:

javax.telephony.PrivilegeViolationException

getAddressCallInfo(Terminal)

public com.cisco.jtapi.extensions.CiscoAddressCallInfo
getAddressCallInfo(javax.telephony.Terminal iterminal)

Use this Interface to get info of calls present at the terminal

getAutoAcceptStatus(Terminal)

public void getAutoAcceptStatus(javax.telephony.Terminal terminal)
throws PlatformException, InvalidStateException, MethodNotSuppo
rtedException, 

CiscoAddress.getAutoAccept(Terminal iterminal) returns AutoAccept status of Address on Terminal. It may return one of the following constants: CiscoAddress.AUTOACCEPT_OFF CiscoAddress.AUTOACCEPT_ON.

Pre-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Post-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Parameters:

terminal - Terminal on which AutoAccept status of Address will be returned.

Throws:

javax.telephony.InvalidStateException - The Provider is not "in service".

javax.telephony.PlatformException - Terminal is not on the Address.

javax.telephony.MethodNotSupportedException - This method is not supported ExtraProviderAddresses.

getInServiceAddrTerminals()

public javax.telephony.Terminal[] getInServiceAddrTerminals() 

Use this interface to find out which Shared Lines are in service. In Shared Lines, the same address appears on different Terminals.

Returns:

an array of terminals on which address is in service

getRegistrationState()

public int getRegistrationState()

Deprecated

This method has been replaced by the getState() method.

Returns the state of this address.

The state may be any of the following constants:

· CiscoAddress.OUT_OF_SERVICE
· CiscoAddress.IN_SERVICE

Returns:

the state of this address

getState()

public int getState()

Returns the state of this address.

The state may be any of the following constants:

· CiscoAddress.OUT_OF_SERVICE
· CiscoAddress.IN_SERVICE

Returns:

the state of this address

getType()

public int getType()

Returns the type of this address.

The type may be any of the following constants:

· CiscoAddress.INTERNAL
· CiscoAddress.EXTERNAL
· CiscoAddress.EXTERNAL_UNKNOWN

Returns:

the type of address

setAutoAcceptStatus(int, Terminal)

public void getAutoAcceptStatus(int autoAcceptStatus, 
javax.telephony.Terminal terminal)
throws PlatformException, InvalidStateException, MethodNotSuppo
rtedException

This allows Application to enable AutoAccept for Addresses on CiscoMediaTerminal and/or CiscoRouteTerminal. Addresses on CiscoTerminal other than CiscoMediaTerminal or CiscoRouteTerminal will always have AutoAccept on. If Terminal passed in the parameter is not CiscoMediaTerminal or CiscoRouteTerminal, it will throw exception. For the CiscoMediaTerminal that have Shared Address with CiscoTerminal, it is recommended to enable AutoAccept on CiscoMediaTerminal.

Pre-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Post-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. (getState() == IN_SERVICE

Parameters:

value - Can be either CiscoAddress.AUTOACCEPT_OFF or CiscoAddress.AUTOACCEPT_ON. If autoAcceptStatus is AUTOACCEPT_ON, it will enable AutoAccept for address on Terminal. If autoAcceptStatus is AUTOACCEPT_OFF, it will disable AutoAccept for address on Terminal.

terminal. - It the terminal on which AutoAccept will be enabled

Throws:

javax.telephony.InvalidStateException - The Provider is not "in service".

javax.telephony.PlatformException - Terminal is not on the Address.

javax.telephony.MethodNotSupportedException - This method is not supported ExtraProviderAddresses.

setMessageWaiting(java.lang.String destination, boolean enable)

public void setMessageWaiting(java.lang.String destination, 
boolean enable)
throws MethodNotSupportedException, InvalidStateException, Priv
ilegeViolationException

Specifies whether the message-waiting indicator should be activated or deactivated for the Address specified by the destination. If enable is true, message-waiting is activated if not already activated. If enable is false, message-waiting is deactivated if not already deactivated.

Pre-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

Post-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE


Note The following postconditions as specified in CallControlAddress are currently not enforced by this implementation.


1. this.getMessageWaiting() == enable

2. CallCtlAddrMessageWaitingEv is delivered for this Address

Parameters:

destination - DN whose message waiting indicator should be activated

enable - True to activate message-waiting, false to deactivate.

Throws:

javax.telephony.MethodNotSupportedException - This method is not supported by the given implementation.

javax.telephony.InvalidStateException - The Provider is not "in service".

javax.telephony.PrivilegeViolationException - The Provider user has insufficient privileges to invoke the message waiting indicator for this destination

setRingerStatus(int)

public void setRingerStatus(int status)
throws MethodNotSupportedException, InvalidStateException, Inva
lidArgumentException

Changes the ringer status on this address

Accepts on of the following constants: CiscoAddress.RINGER_DEFAULT CiscoAddress.RINGER_DISABLE CiscoAddress.RINGER_ENABLE

Throws:

javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException

CiscoAddressCallInfo

Declaration

public class CiscoAddressCallInfo
 
java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoAddressCallInfo

Member Summary
Constructors
 
CiscoAddressCallInfo(int, int, int, int), int 
imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold)
 
CiscoAddressCallInfo(int, int, int, int, CiscoCall[]), int 
imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold, 
CiscoCall icalls)
Methods
 CiscoCall[]
 int
 int
 int
 int

Inherited Member Summary
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
toString(), wait(), wait(), wait()

Constructors

CiscoAddressCallInfo(int, int, int, int)

public CiscoAddressCallInfo(int inumActiveCalls,
int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold)

CiscoAddressCallInfo(int, int, int, int, CiscoCall[])

public CiscoAddressCallInfo(int inumActiveCalls,
int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold, 
com.cisco.jtapi.extensions.CiscoCall[] icalls)

Methods

getCalls()

public com.cisco.jtapi.extensions.CiscoCall[] getCalls()

getMaxActiveCalls()

public int getMaxActiveCalls()

getMaxCallsOnHold()

public int getMaxCallsOnHold()

getNumActiveCalls()

public int getNumActiveCalls()

getNumCallsOnHold()

public int getNumCallsOnHold()

CiscoAddressObserver

Declaration

public interface CiscoAddressObserver extends
javax.telephony.AddressObserver

All Superinterfaces

javax.telephony.AddressObserver

Description

Applications implement this interface in order to receive CiscoAddrEv events such as CiscoAddrInServiceEv and CiscoAddrOutOfServiceEv when observing Addresses via the Address.addObserver method.

See Also:

CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv

Inherited Member Summary
Methods inherited from interface AddressObserver
addressChangedEvent(AddrEv[])

CiscoAddrEv

Declaration

public interface CiscoAddrEv extends CiscoEv,
javax.telephony.events.AddrEv

All Superinterfaces

javax.telephony.events.AddrEv, CiscoEv, javax.telephony.events.Ev

All Known Subinterfaces

CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv

Description

The CiscoAddrEv interface, which extends JTAPI's core javax.telephony.events.AddrEv interface, serves as the base interface for all Cisco-extended JTAPI Address events. Every Address-related event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.AddrEv

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface AddrEv
getAddress()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

CiscoAddrInServiceEv

Declaration

public interface CiscoAddrInServiceEv extends CiscoAddrEv

All Superinterfaces

javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoAddrInServiceEv event

Member Summary
Fields
static int
ID
Methods
 CiscoTerminal
Returns the terminal at which this address is going 
InService.

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface AddrEv
getAddress()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getTerminal()

public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()

Returns the terminal at which this address is going InService

In Shared Lines, applications may receive multiple CiscoAddressInService events and the same Address appears on different Terminals. In order for Application to find out which Shared Line is going in service, Applications can use this interface. This interface returns the terminal on which Address is going in Service.

Returns:

the terminal at which this address is going InService

See Also:

CiscoAddress.getInServiceAddressTerminal()

CiscoAddrOutOfServiceEv

Declaration

public interface CiscoAddrOutOfServiceEv extends CiscoAddrEv,

All Superinterfaces

javax.telephony.events.AddrEv,CiscoAddrEv, CiscoEv, CiscoOutOfServiceEv, javax.telephony.events.Ev

Description

The CiscoAddrOutOfServiceEv event

Member Summary
Fields
static int
ID 
Methods
 CiscoTerminal
Returns the terminal at which this address is going 
OutOfService.

Inherited Member Summary
Fields inherited from interface CiscoOutOfServiceEv
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface AddrEv
getAddress()

Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getTerminal()

public com.cisco.jtapi.extensions.CiscoTerminal getTerminal()

Returns the terminal at which this address is going OutOfService

In Shared Lines, applications may receive multiple CiscoAddressOutOfService events and the same Address appears on different Terminals. Applications use this interface to find out which Shared Line is going out of service.

Returns:

the terminal at which this address is going OutOfService

See Also:

CiscoAddress.getInServiceAddressTerminal()

CiscoAddrRemovedEv

Declaration

public interface CiscoAddrRemovedEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoAddrRemovedEv event

Member Summary
Fields
static int
ID
Methods
 javax.telephony.Address

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getAddress()

public javax.telephony.Address getAddress()

CiscoAddrRemovedFromTerminalEv

Declaration

public interface CiscoAddrRemovedEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoAddrRemovedFromTerminalEv event gets sent under the following conditions:

When User removes a Terminal/Device into the user controlList that contains SharedDN, this event will be sent to application. If a user has an address in control list, and we remove a device with same address in control list, this event will be sent.

When EM(Extension mobility) user logs out from Terminal with a profile that contains SharedDN, this event notifies that one of the Terminals is removed from an existing Address.

A new SharedDN is removed from a Device in a user control list. Interface getTerminal() returns the terminal that is removed from the Address. Interface getAddress() will return the address from where the terminal is removed.

Member Summary
Fields
static int
ID
Methods
 javax.telephony.Address

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getAddress()

public javax.telephony.Address getAddress()

getTerminal()

public javax.telephony.Terminal getTerminal()

CiscoCall

Declaration

public interface CiscoCall extends
javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer

All Superinterfaces

javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoObjectContainer

All Known Subinterfaces

CiscoConsultCall

Description

The CiscoCall interface extends the CallControlCall interface with additional CallManager-specific capabilities.

In Cisco CallManager terms, every Call object comprises a set of call legs that share a common identifier: the global call handle. Connection objects represent call legs in JTAPI, and the Call object that relates a set of Connections contains the global call handle that the underlying call legs share.

The global call handle within a CiscoCall is accessible via its CallManagerID and CallID properties. Taken together, the CallManagerID and CallID form the global call handle maintained by the CallManager. This pair of properties is guaranteed to be unique among all ACTIVE Call objects, but when an ACTIVE call becomes INACTIVE, its CallManagerID and CallID may be reused to identify a newly-created Call object. Therefore, it is possible for an INACTIVE Call to have identical CallManagerID and CallID properties to those of a currently ACTIVE Call object.

See Also:

javax.telephony.Call

Member Summary
Methods
 void
Merges N calls together, resulting in the union of the 
participants of all the calls being placed on a single 
call.
 
javax.telephony.Connection
[]
From the CallEvent perspective, this method behaves 
similar to Call.connect(Terminal terminal, Address 
origaddr, String dialedDigits).
boolean
Returns Presentation Indicator(PI) associated with 
getCalledAddressPI. If it returns true, Application can 
display this Address name to end users. If it returns 
false, Applications should not display this Address name 
to end user.
CiscoPartyInfo
Returns information about the called party.
 CiscoCallID
CallID is a unique identifier among all ACTIVE calls 
with the same CallManagerID.
boolean
Returns Presentation Indicator(PI) associated with 
getCallingAddressPI. If it returns true, Application can 
display this Address name to end users. If it returns 
false, Applications should not display this Address name 
to the end user.
 javax.telephony.Address
Returns the current calling address for the call.
boolean
Returns Presentation Indicator(PI) associated with 
CurrentCalledAddress. If it returns true, Application 
can display this Address to end users. If it returns 
false, Applications should not display this Address name 
to end user.
boolean
Returns Presentation Indicator(PI) associated with 
getCurredCalledDisplayNamePI. If it returns true, 
Application can display this DisplayName to end users. 
If it returns false, Applications should not display 
this DisplayName to end user.
 java.lang.String
This interface returns the display of the called party 
in the call.
CiscoPartyInfo
Returns information about the current called party.
 javax.telephony.Address
This interface returns current called address for the 
call this will return updated calling address every 
every time call is redirected or transferred.
For example, in the CiscoJtapi implementation, 
CallControlCall.getCallingAddress() returns the first 
calling party of the call.
boolean
returns Presentation Indicator(PI) associated with 
getCurrentCallingAddressPI If it returns true, 
Application can display this Address name to end users 
if it returns false, Applications should not display 
this Address name to end user
boolean
returns Presentation Indicator(PI) associated with 
getCurrentCalledDisplayNamePI If it returns true, 
Application can display this DisplayName to end users if 
it returns false, Applications should not display this 
DisplayName to end user
 java.lang.String
This interface returns the display name of the calling 
party.
CiscoPartyInfo
Returns information about the last redirected party.
boolean
returns Presentation Indicator(PI) associated with 
getLastRedirectingAddressPI If it returns true, Application 
can display this Address name to end users if it returns 
false, Applications should not display this Address name to 
end user
javax.telephony.Address
This interface returns modified called address for the call 
if an application modifies its calling party using from 
selectRoute API.
javax.telephony.Address
This interface returns modified calling address for the call 
if an application modifies its calling party using from 
selectRoute API.
javax.telephony.Connection
transfer(String, String, String)
This method overloads the CallControlCall.transfer(String) 
method.

Inherited Member Summary
Fields inherited from interface Call
ACTIVE, IDLE, INVALID
Methods inherited from interface Call
addObserver(CallObserver), connect(Terminal, Address, String), 
getCallCapabilities(Terminal, Address), getCapabilities(Terminal, Address), 
getConnections(), getObservers(), getProvider(), getState(), 
removeObserver(CallObserver)
Methods inherited from interface CallControlCall
addParty(String), conference(Call), consult(TerminalConnection), 
consult(TerminalConnection), drop(), getCalledAddress(), getCallingAddress(), 
getCallingTerminal(), getConferenceController(), getConferenceEnable(), 
getLastRedirectedAddress(), getTransferController(), getTransferEnable(), 
offHook(Address, Terminal), setConferenceController(TerminalConnection), 
setConferenceEnable(boolean), setTransferController(TerminalConnection), 
setTransferEnable(boolean), transfer(String), transfer(String)
Methods inherited from interface CiscoObjectContainer

Methods

conference(Call[])

public void
converence(javax.telephony.Call[] otherCalls)

Throws:

InvalidStateException, InvalidArgumentException, MethodNotSupportedE xception, PrivilegeViolationException, ResourceUnavailableException

Merges N Calls together, resulting in the union of the participants of all the Calls being placed on a single Call. This method takes list of Calls as argument, referred to hereafter as the "secondary" Calls. All of the participants from the secondary call are moved to the Call on which this method is invoked.

The Conference Controller

In order for the conferencing feature to happen, there must be a common participant to all the Calls, as represented by a single Terminal and multiple TerminalConnections, one on all of the Calls. These TerminalConnections are known as the conference controllers. In the real-world, only one of the Calls would be active with respect to the controlling Terminal, and hence, the TerminalConnection on the secondary Call should be in the CallControlTerminalConnection.HELD state. The N conference controlling TerminalConnections are merged into one as a result of this method.

Applications can control which TerminalConnection acts as the conference controller when setting up a conference call via the CallControlCall.setConferenceController() method. The CallControlCall.getConferenceController() method returns the current conference controller, or null if there is none. If no conference controller is set initially, the implementation chooses a suitable TerminalConnection when the conferencing feature is invoked. Only the original conference controller can add new parties to a conference call. Attempting to change the conference controller while a conference is going on will not take effect; however, no error gets thrown in the "setConferenceController" API.

The Telephone Call Argument

All of the participants from the secondary Calls, passed as the argument to this method, are "moved" to the Call on which this method was invoked. That is, new Connections and TerminalConnections are created on this Call which are found on the secondary Calls. Those Connections and TerminalConnections on the secondary Calls are removed from the Call and the Call moves into the Call.INVALID state.

The conference controller TerminalConnections are merged into one on this Call. That is, the existing TerminalConnection controller on this Call remains unchanged, while the TerminalConnection on the secondary Calls gets removed from that Call.

Other Shared Participants

There may exist Address and Terminals which are part of some telephone calls in addition to the designated conference controller. In these instances, those participants which are shared between both Calls are merged into one. That is, the Connections and TerminalConnections on this Calls are left unchanged. The corresponding Connections and TerminalConnections on the secondary Calls are removed from that Call.

Pre-conditions:

1. Let tc1 be the conference controller on this Call

2. Let connection1 = tc1.getConnection()

3. Let tc2 to tcN be the conference controllers on otherCalls

4. (this.getProvider()).getState() == Provider.IN_SERVICE

5. (this.getState() == Call.ACTIVE

6. tc1.getTerminal() == tc2.getTerminal()...=tcN.getTerminal

7. tc1.getCallControlState() == CallControlTerminalConnection.TALKING/HELD

8. tc2-tcN.getCallControlState() == CallControlTerminalConnection.HELD/TALKING

9. this != otherCalls

Post-conditions:

1. (this.getProvider()).getState() == Provider.IN_SERVICE

2. this.getState() == Call.ACTIVE

3. otherCall.getState() == INVALID

4. Let c[] be the Connections to be merged from otherCall

5. Let tc[] be the TerminalConnections to be merged from otherCall

6. Let new(c) be the set of new Connections created on this Call

7. Let new(tc) be the set of new TerminalConnections created on this Call

8. new(c) element of this.getConnections()

9. new(c).getCallState() == c.getCallState()

10. new(tc) element of (this.getConnections()).getTerminalConnections()

11. new(tc).getCallState() == tc.getCallState()

12. c[i].getCallControlState() == CallControlConnection.DISCONNECTED for all i

13. tc[i].getCallControlState() == CallControlTerminalConnection.DROPPED for all i

14. CallInvalidEv is delivered for otherCall

15. CallCtlConnDisconnectedEv/ConnDisconnectedEv is delivered for all c[i]

16. CallCtlTermConnDroppedEv/TermConnDroppedEv is delivered for all tc[i]

17. ConnCreatedEv is delivered for all new(c)

18. TermConnCreatedEv is delivered for all new(tc)

19. Appropriate events are delivered for all new(c) and new(tc)

Parameters:

otherCall - The second Call which to merge with this Call object.

Throws:

javax.telephony.InvalidArgumentException - The Call object provided is not valid for the conference

javax.telephony.InvalidStateException - Either the Provider is not "in service", the Call is not "active", or the conference controllers are not in the proper state.

javax.telephony.MethodNotSupportedException - This method is not supported by the implementation.

javax.telephony.PrivilegeViolationException - The application does not have the proper authority to invoke this method.

javax.telephony.ResourceUnavailableException - An internal resource necessary for the successful invocation of this method is not available.

See Also:

javax.telephony.events.ConnCreatedEv, javax.telephony.events.TermConnCreatedEv, javax.telephony.events.ConnDisconnectedEv, javax.telephony.events.TermConnDroppedEv, javax.telephony.events.CallInvalidEv, javax.telephony.callcontrol.events.CallCtlConnDisconnectedEv, javax.telephony.callcontrol.events.CallCtlTermConnDroppedEv

connect(Terminal, Address, String, CiscoRTPParams)

public javax.telephony.Connection[]
connect(javax.telephony.Terminal origterm, 
javax.telephony.Address origaddr, java.lang.String 
dialedDigits, com.cisco.jtapi.extensions.CiscoRTPParams 
rtpParams)throws ResourceUnavailableException, 
PrivilegeViolationException, InvalidPartyException, 
InvalidArgumentException, InvalidStateException, MethodNotSup 
portedException

From CallEvent perspective, this method behaves similar to Call.connect(Terminal terminal, Address origaddr, String dialedDigits). This method may only be invoked when making a call from CiscoMediaTerminal want to specify media parameters for this call. Establishes the media at the specified CiscoRTPParams parameters if the request is successful.

Throws:

javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidPartyException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException

getCalledAddressPI()

public boolean getCallAddressPI()

Returns Presentation Indicator (PI) associated with getCalledAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

getCalledPartyInfo()

CiscoPartyInfo getCalledPartyInfo()

This interface returns the CiscoPartyInfo object with information about the called party.

getCallID()

public com.cisco.jtapi.extensions.CiscoCallID getCallID()

CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.

Returns:

the CallID property of this Call

getCallingAddressPI()

public boolean getCallingAddressPI()

Returns Presentation Indicator (PI) associated with getCallingAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

getCurrentCalledAddress()

public javax.telephony.Address getCurrentCalledAddress()

This interface returns current calling address for the call this will return updated called address every time call gets redirected or transferred.

For example, in the CiscoJtapi implementation, CallControlCall.getCalledAddress() returns the first called party of the call.

getCurrentCalledAddressPI()

public javax.telephony.Address getCurrentCalledAddressPI()

Returns Presentation Indicator (PI) associated with getCalledAddressPI. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

getCurrentCalledDisplayNamePI()

public boolean getCurrentCalledDisplayNamePI()

Returns Presentation Indicator (PI) associated with CurrentCalledAddress. If it returns true, Application can display this address name to the end users. If it returns false, Application should not display this Address name to the end user.

getCurrentCalledPartyDisplayName()

public java.lang.String getCurrentCalledPartyDisplayName()

This interface returns the display of the called party in the call. It returns null if display name is unknown.

getCurrentCalledPartyInfo()

public CiscoPartyInfo getCurrentCalledPartyInfo()

This interface returns the CiscoPartyInfo object with information about the current called party.

getCurrentCallingAddress()

public javax.telephony.Address getCurrentCallingAddress()

This interface returns current called address for the call this will return updated calling address every time call is redirected or transferred


Note In the CiscoJtapi implementation CallControlCall.getCallingAddress()returns the first calling party of the call i.e. the original calling party


 Usage:
 if ( call instanceof CiscoCall ) {
Address currentCalled = ((CiscoCall)call).getCurrentCalling ();
 }
 

See Also:

javax.telephony.callcontrol.CallControlCall

getCurrentCallingAddressPI()

public boolean getCurrentCallingAddressPI()

Returns Presentation Indicator(PI) associated with getCurrentCallingAddress. If it returns true, Application can display this Address to end users. If it returns false, Applications should not display this Address name to end user

getCurrentCallingDisplayNamePI()

public boolean getCurrentCallingDisplayNamePI()

Returns Presentation Indicator(PI) associated with getCurrentCalledDisplayNamePI. If it returns true, Application can display this DisplayName to end users. If it returns false, Applications should not display this DisplayName to end user

getCurrentCallingPartyDisplayName()

public java.lang.String getCurrentCallingPartyDisplayName()

This interface returns the display name of the calling party. It returns null if display name is unknown.

getLastRedirectedPartyInfo()

public CiscoPartyInfo getLastRedirectedPartyInfo()

This interface returns the CiscoPartyInfo object with information about the last redirected party.

getLastRedirectingAddressPI()

public boolean getLastRedirectingAddressPI()

Returns Presentation Indicator(PI) associated with getLastRedirectingAddressPI. If it returns true, Application can display this Address name to end users. If it returns false, Applications should not display this Address name to end user.

getModifiedCalledAddress()

public javax.telephony.Address getModifiedCalledAddress()

This interface returns modified called address for the call if an application modifies its calling party using from selectRoute API. However, this information may not be accurate if an application is only controlling the Route Point that is modifying the calling number. If no modified calling number is performed, this is similar to getCurrentCalledAddress interface. Typically, this is varied from getCurrentCalledAddress when a feature is invoked after modified calling number modifications.

Usage:

 if ( call instanceof CiscoCall ) {
Address currentCalled = ((CiscoCall)call).getModifiedCalledAddress 
();
 }
 

See Also:

javax.telephony.callcontrol.CallControlCall

getModifiedCallingAddress()

public javax.telephony.Address getModifiedCallingAddress()

This interface returns modified calling address for the call if an application modifies its calling party using from selectRoute API. However, this information may not be accurate if an application is only controlling the RP that is modifying the calling number. If no modified calling number is performed, this is similar to getCurrentCallingAddress interface.

Usage:

 if ( call instanceof CiscoCall ) {
Address currentCalled = 
((CiscoCall)call).getModifiedCallingAddress ();
 }
 

See Also:

javax.telephony.callcontrol.CallControlCall

transfer(String, String, String)

javax.telephony.Connection transfer
(java.lang.String destinationAddress, java.lang.String facCode, 
java.lang.String cmcCode) 

This method overloads the CallControlCall.transfer(String) method. It takes two new parameters: facCode and cmcCode. The facCode is the forced authorization code (FAC), and cmcCode is the client matter code (CMC).

See Also:

javax.telephony.callcontrol.CallControlCall

CiscoCallChangedEv

Declaration

public interface CiscoCallChangedEv extends CiscoCallEv, 
javax.telephony.events.CallEv

All Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, javax.telephony.events.Ev

Description

The CiscoCallChangedEv event is delivered to the call observer whenever the Global Call ID (GCID) of the call is changed due to path replacement. In the case of shared lines, multiple CiscoCallChangedEv events would be delivered.

Member Summary
Methods
CiscoCall

Returns a reference to the new call, which would be the surviving call.

CiscoCall

Returns a reference to the old call, which will go to INVALID state.


Returns CiscoCaqllEv.CAUSE_QSIG_PR when GCID is changed QSIG Path replacement.

CiscoConnection

Returns the connection of the call on which the change has occurred.

TerminalConnection

Returns the terminal connection of the on which the GCID has changed. A Null is returned if there is no terminal connection.


Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, 
CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, 
CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, 
CAUSE_CHANUNACCEPTABLE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DESTINATIONOUTOFORDER, 
CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, 
CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, 
CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, 
CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, 
CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, 
CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, 
CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, 
CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, 
CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, 
CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, 
CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, 
CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QUALOFSERVNAVAIL, CAUSE_RECOVERYONTIMEREXPIRY, 
CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, 
CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, 
CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, 
CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUSPCALLBUTNOTTHISONE, 
CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, 
CAUSE_USERBUSY

Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN

Methods inherited from interface CallEv
getCall()

Methods inherited from interface CiscoCallEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Methods

getSurvivingCall()

public com.cisco.jtapi.extensions.CiscoCall getSurvivingCall()

Returns a reference to the new call, which would be the surviving call.

getOriginalCall()

public com.cisco.jtapi.extensions.CiscoCall getOriginalCall()

Returns a reference to the old call, which will go to INVALID state.

getCiscoCause()

public int getCiscoCause()

Returns CiscoCallEv.CAUSE_QSIG_PR when the GCID is changed by QSIG path replacement.

getConnection()

public com.cisco.jtapi.extensions.CiscoConnection getConnection()

Returns the connection of the call on which the change has occurred.

getTerminalConnection()

public javax.telephony.TerminalConnection getTerminalConnection()

Returns the terminal connection of the call on which the GCID has changed. A Null is returned if there is no terminal connection.

CiscoCallEv

Declaration

public interface CiscoCallEv extends CiscoEv,
javax.telephony.events.CallEv

All Superinterfaces

javax.telephony.events.CallEv, CiscoEv, javax.telephony.events.Ev

All Known Subinterfaces

CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoTransferEndEv, CiscoTransferStartEv, CiscoCallChangedEv

Description

The CiscoCallEv interface, which extends the JTAPI core javax.telephony.events.CallEv interface, serves as the base interface for all Cisco-extended JTAPI Call events. Every Call-related event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.CallEv

Member Summary
Fields
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
Methods
 int
 Returns the CallManager cause for this event.

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface CallEv
getCall()
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

CAUSE_ACCESSINFORMATIONDISCARDED

public static final int CAUSE_ACCESSINFORMATIONDISCARDED

CAUSE_BARGE

public static final int CAUSE_BARGE

CAUSE_BCBPRESENTLYAVAIL

public static final int CAUSE_BCBPRESENTLYAVAIL

CAUSE_BCNAUTHORIZED

public static final int CAUSE_BCNAUTHORIZED

CAUSE_BEARERCAPNIMPL

public static final int CAUSE_BEARERCAPNIMPL

CAUSE_CALLBEINGDELIVERED

public static final int CAUSE_CALLBEINGDELIVERED

CAUSE_CALLIDINUSE

public static final int CAUSE_CALLIDINUSE

CAUSE_CALLMANAGER_FAILURE

public static final int CAUSE_CALLMANAGER_FAILURE

CAUSE_CALLREJECTED

public static final int CAUSE_CALLREJECTED

CAUSE_CALLSPLIT

public static final int CAUSE_CALLSPLIT

CAUSE_CHANTYPENIMPL

public static final int CAUSE_CHANTYPENIMPL

CAUSE_CHANUNACCEPTABLE

public static final int CAUSE_CHANUNACCEPTABLE

CAUSE_CTIMANAGER_FAILURE

public static final int CAUSE_CTIMANAGER_FAILURE

CAUSE_DESTINATIONOUTOFORDER

public static final int CAUSE_DESTINATIONOUTOFORDER

CAUSE_DESTNUMMISSANDDCNOTSUB

public static final int CAUSE_DESTNUMMISSANDDCNOTSUB

CAUSE_DPARK

public static final int CAUSE_DPARK

CAUSE_DPARK_REVERSION

public static final int CAUSE_DPARK_REVERSION

CAUSE_DPARK_UNPARK

public static final int CAUSE_DPARK_UNPARK

CAUSE_FACILITYREJECTED

public static final int CAUSE_FACILITYREJECTED

CAUSE_IDENTIFIEDCHANDOESNOTEXIST

public static final int CAUSE_IDENTIFIEDCHANDOESNOTEXIST

CAUSE_IENIMPL

public static final int CAUSE_IENIMPL

CAUSE_INBOUNDBLINDTRANSFER

public static final int CAUSE_INBOUNDBLINDTRANSFER

CAUSE_INBOUNDCONFERENCE

public static final int CAUSE_INBOUNDCONFERENCE

CAUSE_INBOUNDTRANSFER

public static final int CAUSE_INBOUNDTRANSFER

CAUSE_INCOMINGCALLBARRED

public static final int CAUSE_INCOMINGCALLBARRED

CAUSE_INCOMPATABLEDDESTINATION

public static final int CAUSE_INCOMPATABLEDDESTINATION

CAUSE_INTERWORKINGUNSPECIFIED

public static final int CAUSE_INTERWORKINGUNSPECIFIED

CAUSE_INVALIDCALLREFVALUE

public static final int CAUSE_INVALIDCALLREFVALUE

CAUSE_INVALIDIECONTENTS

public static final int CAUSE_INVALIDIECONTENTS

CAUSE_INVALIDMESSAGEUNSPECIFIED

public static final int CAUSE_INVALIDMESSAGEUNSPECIFIED

CAUSE_INVALIDNUMBERFORMAT

public static final int CAUSE_INVALIDNUMBERFORMAT

CAUSE_INVALIDTRANSITNETSEL

public static final int CAUSE_INVALIDTRANSITNETSEL

CAUSE_MANDATORYIEMISSING

public static final int CAUSE_MANDATORYIEMISSING

CAUSE_MSGNCOMPATABLEWCS

public static final int CAUSE_MSGNCOMPATABLEWCS

CAUSE_MSGTYPENCOMPATWCS

public static final int CAUSE_MSGTYPENCOMPATWCS

CAUSE_MSGTYPENIMPL

public static final int CAUSE_MSGTYPENIMPL

CAUSE_NETOUTOFORDER

public static final int CAUSE_NETOUTOFORDER

CAUSE_NOANSWERFROMUSER

public static final int CAUSE_NOANSWERFROMUSER

CAUSE_NOCALLSUSPENDED

public static final int CAUSE_NOCALLSUSPENDED

CAUSE_NOCIRCAVAIL

public static final int CAUSE_NOCIRCAVAIL

CAUSE_NOERROR

public static final int CAUSE_NOERROR

CAUSE_NONSELECTEDUSERCLEARING

public static final int CAUSE_NONSELECTEDUSERCLEARING

CAUSE_NORMALCALLCLEARING

public static final int CAUSE_NORMALCALLCLEARING

CAUSE_NORMALUNSPECIFIED

public static final int CAUSE_NORMALUNSPECIFIED

CAUSE_NOROUTETODDESTINATION

public static final int CAUSE_NOROUTETODDESTINATION

CAUSE_NOROUTETOTRANSITNET

public static final int CAUSE_NOROUTETOTRANSITNET

CAUSE_NOUSERRESPONDING

public static final int CAUSE_NOUSERRESPONDING

CAUSE_NUMBERCHANGED

public static final int CAUSE_NUMBERCHANGED

CAUSE_ONLYRDIVEARERCAPAVAIL

public static final int CAUSE_ONLYRDIVEARERCAPAVAIL

CAUSE_OUTBOUNDCONFERENCE

public static final int CAUSE_OUTBOUNDCONFERENCE

CAUSE_OUTBOUNDTRANSFER

public static final int CAUSE_OUTBOUNDTRANSFER

CAUSE_PROTOCOLERRORUNSPECIFIED

public static final int CAUSE_PROTOCOLERRORUNSPECIFIED

CAUSE_QUALOFSERVNAVAIL

public static final int CAUSE_QUALOFSERVNAVAIL

CAUSE_RECOVERYONTIMEREXPIRY

public static final int CAUSE_RECOVERYONTIMEREXPIRY

CAUSE_REDIRECTED

public static final int CAUSE_REDIRECTED

CAUSE_REQCALLIDHASBEENCLEARED

public static final int CAUSE_REQCALLIDHASBEENCLEARED

CAUSE_REQCIRCNAVIL

public static final int CAUSE_REQCIRCNAVIL

CAUSE_REQFACILITYNIMPL

public static final int CAUSE_REQFACILITYNIMPL

CAUSE_REQFACILITYNOTSUBSCRIBED

public static final int CAUSE_REQFACILITYNOTSUBSCRIBED

CAUSE_RESOURCESNAVAIL

public static final int CAUSE_RESOURCESNAVAIL

CAUSE_RESPONSETOSTATUSENQUIRY

public static final int CAUSE_RESPONSETOSTATUSENQUIRY

CAUSE_SERVNOTAVAILUNSPECIFIED

public static final int CAUSE_SERVNOTAVAILUNSPECIFIED

CAUSE_SERVOPERATIONVIOLATED

public static final int CAUSE_SERVOPERATIONVIOLATED

CAUSE_SERVOROPTNAVAILORIMPL

public static final int CAUSE_SERVOROPTNAVAILORIMPL

CAUSE_SUSPCALLBUTNOTTHISONE

public static final int CAUSE_SUSPCALLBUTNOTTHISONE

CAUSE_SWITCHINGEQUIPMENTCONGESTION

public static final int CAUSE_SWITCHINGEQUIPMENTCONGESTION

CAUSE_TEMPORARYFAILURE

public static final int CAUSE_TEMPORARYFAILURE

CAUSE_UNALLOCATEDNUMBER

public static final int CAUSE_UNALLOCATEDNUMBER

CAUSE_USERBUSY

public static final int CAUSE_USERBUSY

Methods

getCiscoCause()

public int getCiscoCause()

Returns the CallManager cause for this event.

In order to function properly, some applications need to know the reason why an event happened at an endpoint that the application is observing. For example, a Connection may be disconnected because the call was not answered (CAUSE_NOANSWERFROMUSER), or whether the caller it was disconnected because it was rejected (CAUSE_CALLREJECTED).

Returns:

the CallManager cause for this event

CiscoCallID

Declaration

public interface CiscoCallID extends CiscoObjectContainer

All Superinterfaces

CiscoObjectContainer

Description

The CiscoCallID object represents a unique object associated with each call. Applications may use the object itself or the integer representation of the object returned by the intValue() method.

Member Summary
Methods
 CiscoCall
 int
returns the call manager nodeID of the call
 int
returns the GlobalCallID of the call
 int
Returns an integer representation of this object, 
currently a bitwise OR of the CallManagerID and 
GlobalCallID properties (shifted and truncated 
appropriately)

Inherited Member Summary
Methods inherited from interface CiscoObjectContainer

Methods

getCall()

public com.cisco.jtapi.extensions.CiscoCall getCall()

getCallManagerID()

public int getCallManagerID()

returns the call manager nodeID of the call

getGlobalCallID()

public int getGlobalCallID()

returns the GlobalCallID of the call

intValue()

public int intValue()

Returns an integer representation of this object, currently a bitwise OR of the CallManagerID and GlobalCallID properties (shifted and truncated appropriately)

Returns:

an integer representation of this object

CiscoConferenceEndEv

Declaration

public interface CiscoConferenceEndEv extends CiscoCallEv

All Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoConferenceEndEv event indicates that a transfer operation has completed. This event is reported via the CallControlCallObserver interface.

Member Summary
Fields
static int
ID
Methods
 javax.telephony.Address
Returns the Address, which currently acts as the 
conference controller for this call —- the initiating 
call.
 javax.telephony.Call
Returns the call that have merged.
 javax.telephony.Call[]
Returns a list of the calls that could not be 
conferenced.
 javax.telephony.Call
Returns the call that remains active after the 
conference completes.
 
javax.telephony.TerminalCo
nnection
Returns the TerminalConnection, which currently acts as 
the conference controller for this call —- the 
initiating call.
 
javax.telephony.TerminalCo
nnection[]
Returns the TerminalConnection, which currently acts as 
the conference controller for this call —- the 
initiating call.
 
javax.telephony.TerminalCo
nnection
Returns the TerminalConnection, which currently acts as 
the conference controller for this call —- the 
initiating call.
boolean
Returns True or False depending on whether Conference is 
successful or failed.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, 
CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, 
CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, 
CAUSE_CHANUNACCEPTABLE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DESTINATIONOUTOFORDER, 
CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, 
CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, 
CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, 
CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, 
CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, 
CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, 
CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, 
CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, 
CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, 
CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, 
CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, 
CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QUALOFSERVNAVAIL, CAUSE_RECOVERYONTIMEREXPIRY, 
CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, 
CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, 
CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, 
CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUSPCALLBUTNOTTHISONE, 
CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, 
CAUSE_USERBUSY
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface CallEv
getCall()

Methods inherited from interface CiscoCallEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getConferenceControllerAddress()

public javax.telephony.Address getConferenceControllerAddress()

Returns the Address which currently acts as the conference controller for this call —- the initiating call.

getConferencedCall()

public javax.telephony.Call getConferencedCall()

Returns the call that has been merged. This call is in the Call.INVALID state.

getFailedCalls()

public favax.telephony.Call[] getFailedCalls{}

Returns the list of the calls that could not be conferenced.

Returns:

Null, if conference is successful.

See Also:

isSuccess()

getFinalCall()

public javax.telephony.Call getFinalCall()

Returns the call that remains active after the conference is completed.

getHeldConferenceController()

public javax.telephony.TerminalConnection
getHeldConferenceController()

Returns the TerminalConnection which currently acts as the conference controller for this call —- the final call. This is the TerminalConnection that was in HELD state when conference was initiated. This method returns null if the conference controller is not being observed.

getHeldConferenceControllers()

public javax.telephony.TerminalConnection[]
getHeldConferenceControllers()

Returns the TerminalConnection which currently acts as the conference controller for this call: the initiating call. This is the TerminalConnection that was in the HELD state. This method returns null if the conference controller is not being observed. This method returns the first held Controller for multiple call join scenario.

getTalkingConferenceController()

public javax.telephony.TerminalConnection
getTalkingConferenceController()

Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.

isSuccess()

public boolean isSuccess()

Returns True or False depending on whether the Conference successful or failed. Application can use interface to find whether Conference is successful. The following are defined as Conference Fail:

If application issues request Call.conferece(otherCalls[]) this Conference would be considered failed, if one or more than one Calls could Join into Conference. Application can use interface getFailedCalls() to find Failed Call.

If no Conference Bridge available and conference could not be completed at all. Again Application can use interface getFailedCalls() to get list of Calls that could not Join into Conference.

Party being Conferenced Dropped out before conference could be completed.

CiscoConferenceStartEv

Declaration

public interface CiscoConferenceStartEv extends CiscoCallEv

All Superinterfaces

javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoConferenceStartEv event indicates that a conference operation has started. This event is reported via the CallControlCallObserver interface.

Member Summary
Fields
static int
ID
Methods
 javax.telephony.Address
Returns the Address which currently acts as the 
conference controller for this call —- the initiating 
call.
 javax.telephony.Call
Returns the call that will be conferenced.
javax.telephony.Call[]
Returns the list of the calls that will be conferenced.
 javax.telephony.Call
Returns the call that will remain active after the 
conference is completed.
 
javax.telephony.TerminalCo
nnection
Returns the TerminalConnection which currently acts as 
the conference controller for this call —- the 
initiating call.
javax.telephony.TerminalCo
nnection[]
Returns the TerminalConnection that currently acts as 
the conference controller for this call — the initiating 
call.
 
javax.telephony.TerminalCo
nnection
Returns the TerminalConnection which currently acts as 
the conference controller for this call —- the 
initiating call.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, 
CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, 
CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, 
CAUSE_CHANUNACCEPTABLE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DESTINATIONOUTOFORDER, 
CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, 
CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, 
CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, 
CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, 
CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, 
CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, 
CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, 
CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, 
CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, 
CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, 
CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, 
CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QUALOFSERVNAVAIL, CAUSE_RECOVERYONTIMEREXPIRY, 
CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, 
CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, 
CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, 
CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUSPCALLBUTNOTTHISONE, 
CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, 
CAUSE_USERBUSY
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface CallEv
getCall()

Methods inherited from interface CiscoCallEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getConferenceControllerAddress()

public javax.telephony.Address getConferenceControllerAddress()

Returns the Address which currently acts as the conference controller for this call —- the initiating call.

getConferencedCall()

public javax.telephony.Call getConferencedCall()

Returns the call that will be conferenced. This is the call that will be merged into the initiating call.

getConferencedCalls()

public javax.telephony.Call getConferencedCalls()

Returns the list of calls that will be conferenced. This is the call that will be merged into the final call.

getFinalCall()

public javax.telephony.Call getFinalCall()

Returns the call that will remain active after the conference is completed. This is the call all calls are finally merged into.

getHeldConferenceController()

public javax.telephony.TerminalConnection
getHeldConferenceController()

Returns the TerminalConnection that currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed.

getHeldConferenceControllers()

public javax.telephony.TerminalConnection
getHeldConferenceControllers()

Returns the TerminalConnection that currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed. This method returns all held controllers joining into the finalCall.

getTalkingConferenceController()

public javax.telephony.TerminalConnection
getTalkingConferenceController()

Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.

CiscoConnection

Declaration

public interface CiscoConnection extends
javax.telephony.callcontrol.CallControlConnection, 
CiscoObjectContainer

All Superinterfaces

javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer, javax.telephony.Connection

Description

The CiscoConnection interface extends the CallControlConnection interface with additional CallManager-specific capabilities.

Applications can use the getReason method to obtain the reason for the creation of this Connection.

Member Summary
Fields
static int
This indicates that the redirect should be done using 
the search space of the redirect controller's address.
static int
This option indicates that the default behavior for 
Cisco JTAPI should apply.
static int
This option indicates that the calledAddress should be 
reset to the redirect destination.
static int
This option indicates that the calledAddress should 
remain unchanged after the redirect operation.
static int
This indicates that the redirect should be done using 
the search space of the calling address.
static int
This indicates that the redirect should be done using 
the search space that is the default for the 
implementation.
static int
This Connection was the result of a direct call.
static int
This Connection was the result of unconditional 
forwarding.
static int
This Connection was the result of a forwarding on busy.
static int
This Connection was the result of a forwarding on no 
answer.
static int
This Connection is an originating Connection, not a 
destination Connection.
static int
This Connection was the result of a redirection.
static int
This Connection was the result of a transfer.
static int
This redirect mode instructs the implementation to 
perform redirect without checking the validity or 
availability of the destination.
static int
This redirect mode instructs the implementation to 
perform redirect if the destination is valid and 
available.
Methods
 CiscoConnectionID
CiscoConnectionID is a unique object that identifier 
among all ACTIVE calls with the same CallManagerID.
String
Returns the DPark prefix code to be dialed to unpark a 
DParked call.
 int
 Returns the reason for the creation of this Connection.
 
javax.telephony.TerminalC
onnection
This method returns the current redirectController for 
the connection.
 java.lang.String
This method parks the call at a system park port and 
returns the address of the port.
 
javax.telephony.Connectio
n
This method overloads the 
CallControlConnection.redirect() method.
 
javax.telephony.Connectio
n
This method overloads the 
CallControlConnection.redirect() method.
 
javax.telephony.Connectio
n
This method overloads the 
CallControlConnection.redirect() method.

Inherited Member Summary
Fields inherited from interface CallControlConnection
ALERTING, DIALING, DISCONNECTED, ESTABLISHED, FAILED, IDLE, INITIATED, 
NETWORK_ALERTING, NETWORK_REACHED, OFFERED, OFFERING, QUEUED, UNKNOWN
Fields inherited from interface Connection
CONNECTED, INPROGRESS



Methods inherited from interface CallControlConnection
accept(), addToAddress(String), getCallControlState(), park(String), redirect(String), 
reject()
Methods inherited from interface CiscoObjectContainer
Methods inherited from interface Connection
disconnect(), getAddress(), getCall(), getCapabilities(), 
getConnectionCapabilities(Terminal, Address), getState(), getTerminalConnections()

Fields

ADDRESS_SEARCH_SPACE

public static final int ADDRESS_SEARCH_SPACE

This indicates that the redirect should be done using the search space of the redirect controller's address.

CALLED_ADDRESS_DEFAULT

public static final int CALLED_ADDRESS_DEFAULT

This option indicates that the default behavior for Cisco JTAPI should apply. Cisco JTAPI's default behavior is the same as CALLED_ADDRESS_UNCHANGED.

CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

public static final int CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

This option indicates that the calledAddress should be reset to the redirect destination.

CALLED_ADDRESS_UNCHANGED

public static final int CALLED_ADDRESS_UNCHANGED

This option indicates that the calledAddress should remain unchanged after the redirect operation.

CALLINGADDRESS_SEARCH_SPACE

public static final int CALLINGADDRESS_SEARCH_SPACE

This indicates that the redirect should be done using the search space of the calling address.

DEFAULT_SEARCH_SPACE

public static final int DEFAULT_SEARCH_SPACE

This indicates that the redirect should be done using the search space that is the default for the implementation. The default is to use the calling address's search space.

REASON_DIRECTCALL

public static final int REASON_DIRECTCALL

This Connection was the result of a direct call.

REASON_FORWARDALL

public static final int REASON_FORWARDALL

This Connection was the result of unconditional forwarding.

REASON_FORWARDBUSY

public static final int REASON_FORWARDBUSY

This Connection was the result of a forwarding on busy.

REASON_FORWARDNOANSWER

public static final int REASON_FORWARDNOANSWER

This Connection was the result of a forwarding on no answer.

REASON_OUTBOUND

public static final int REASON_OUTBOUND

This Connection is an originating Connection, not a destination Connection.

REASON_REDIRECT

public static final int REASON_REDIRECT

This Connection was the result of a redirection.

REASON_TRANSFERREDCALL

public static final int REASON_TRANSFERREDCALL

This Connection was the result of a transfer.

REDIRECT_DROP_ON_FAILURE

public static final int REDIRECT_DROP_ON_FAILURE

This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The original call will be dropped if the destination is not valid or if it's busy.

REDIRECT_NORMAL

public static final int REDIRECT_NORMAL

This redirect mode instructs the implementation to perform redirect if the destination is valid and available. Otherwise, the request will return error. The original call will not be dropped on failure.

Methods

getAddressPI()

public boolean getAddressPI()

Returns Presentation Indicator(PI) associated with Address on which the connection is created. If it returns true, Application can display this Address Name to end users. If it returns false, Applications should not display this Address Name to end user.

getConnectionID()

public com.cisco.jtapi.extensions.CiscoConnectionID 
getConnectionID()

CiscoConnectionID is a unique object that identifier among all ACTIVE calls with the same CallManagerID.

Returns:

the CallID property of this Call

getDParkPrefixCode()

public String getDParkPrefixCode()

Returns the DPark Prefix Code to be dialed to unpark a DParked call.

When a call is DParked, the new connection object created for the DPark number is moved to Queued state, which is the state for Parked Call. If the application receives a connection and finds that it is in Queued state, JTAPI will also populate the CallControlCause with the new values received from CTI. From the connection Queued Event and the new call control cause, applications can determine if the call is a DPark call or a normal park call.

When unparking the call, applications have to dial both the prefix code and the DPark DN. For park reversion, the call will be sent back to the Parker party if the preconfigured DN for the DPark DN is not configured.

The following cause codes are presented to the application when a call is direct parked and unparked:

public static final int CAUSE_DPARK

public static final int CAUSE_DPARK_UNPARK

public static final int CAUSE_DPARK_REVERSION

getReason()

public int getReason()

Returns the reason for the creation of this Connection.

In order to function properly, some applications need to know the reason why a Connection is created at an endpoint that the application is observing. For example, a voice mail application may want to know whether a caller is someone that wants to leave a message in a voice mailbox (REASON_FORWARDNOANSWER), or whether the caller is trying to access a voice mail box (REASON_DIRECTCALL).

The reason for a Connection creation may be any of the following constants:

· CiscoConnection.REASON_DIRECTCALL
· CiscoConnection.REASON_TRANSFERREDCALL
· CiscoConnection.REASON_FORWARDNOANSWER
· CiscoConnection.REASON_FORWARDBUSY
· CiscoConnection.REASON_FORWARDALL
· CiscoConnection.REASON_REDIRECT
· CiscoConnection.REASON_NORMAL

All of the reasons except for REASON_TRANSFERORIGINATION and REASON_NORMAL are associated with inbound, or destination Connections. The REASON_NORMAL reason is associated without outbound, or originating Connections.

Returns:

the reason for the creation of this Connection

getRedirectController()

public javax.telephony.TerminalConnection getRedirectController()

Returns the current redirectController for the connection.

park()

public java.lang.String park()
throws InvalidArgumentException, PrivilegeViolationException,
ResourceUnavailableException, InvalidStateException

This method parks the call at a system park port and returns the address of the port. The call can be unparked using this address.

Throws:

javax.telephony.InvalidStateException, javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentException

redirect(String, int)

public javax.telephony.Connection redirect(java.lang.String
destinationAddress, int mode)
throws InvalidStateException, InvalidPartyException, MethodNotS
upportedException, PrivilegeViolationException, ResourceUnavail
ableException

This method overloads the CallControlConnection.redirect() method. It takes a new parameter —- redirectMode. When this parameter is:

1. CiscoConnection.REDIRECT_DROP_ON_FAILURE This mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The original call will be dropped if the destination is not valid or if it's busy.

2. CiscoConnection.REDIRECT_NORMAL This mode instructs the implementation to perform redirect only after checking the validity or availability of the destination. This is the same as the CallControlConnection.redirect() method. The original call will not be dropped on failure.

Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int)

public javax.telephony.Connection redirect(java.lang.String
destinationAddress, int mode, int callingSearchSpace) 
throws InvalidStateException, InvalidPartyException, MethodNotS
upportedException, PrivilegeViolationException, ResourceUnavail
ableException

This method overloads the CallControlConnection.redirect() method. It takes two new parameters —- redirectMode and callingSearchSpace. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space.

The redirectMode parameter may be:

1. CiscoConnection.REDIRECT_DROP_ON_FAILURE

2. CiscoConnection.REDIRECT_NORMAL

Read above for a description of what each of these means.
The callingSearchSpace parameter may be:

1. CiscoConnection.DEFAULT_SEARCH_SPACE

2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

3. CiscoConnection.ADDRESS_SEARCH_SPACE


Note The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.


Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int, int)

public javax.telephony.Connection redirect(java.lang.String
destinationAddress, int mode, int callingSearchSpace, 
int calledAddressOption) 
throws InvalidStateException, InvalidPartyException, MethodNotS
upportedException, PrivilegeViolationException, ResourceUnavail
ableException

This method overloads the CallControlConnection.redirect() method. It takes three new parameters —- redirectMode, callingSearchSpace, and calledAddressOption. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space. The calledAddressOption parameter is used to decide whether to reset the original called fields or not.

The redirectMode parameter may be:

1. CiscoConnection.REDIRECT_DROP_ON_FAILURE

2. CiscoConnection.REDIRECT_NORMAL

The callingSearchSpace parameter may be:

1. CiscoConnection.DEFAULT_SEARCH_SPACE

2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

3. CiscoConnection.ADDRESS_SEARCH_SPACE


Note The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.


The calledAddressOption parameter may be:

1. CiscoConnection.CALLED_ADDRESS_DEFAULT

2. CiscoConnection.CALLED_ADDRESS_UNCHANGED

3. CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int, String)

public javax.telephony.Connection redirect(java.lang.String
destinationAddress, int mode, int callingSearchSpace, 
java.lang.String preferredOriginalCalledParty)
throws InvalidStateException, InvalidPartyException, 
MethodNotSupportedException, PrivilegeViolationException, 
ResourceUnavailableException

This method overloads the CallControlConnection.redirect() method. It takes three new parameters -- redirectMode, callingSearchSpace, preferredOriginalCalledParty.

The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space.

The redirectMode parameter may be:

1. CiscoConnection.REDIRECT_DROP_ON_FAILURE

2. CiscoConnection.REDIRECT_NORMAL

Read above for a description of what each of these means.

The callingSearchSpace parameter may be:

1. CiscoConnection.DEFAULT_SEARCH_SPACE

2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

3. CiscoConnection.ADDRESS_SEARCH_SPACE

Read above for a description of what each of these means.


Note The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.


PreferredOriginalCalledParty parameter may be: a DN which will be the originalCalledParty field when call is offered to destinationAddress.

Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

redirect(String, int, int, int, String, String, String)

public javax.telephony.Connection redirect
(java.lang.String destinationAddress, int mode, 
int callingSearchSpace, int calledAddressOption, 
java.lang.String preferredOriginalCalledParty, 
java.lang.String facCode, java.lang.String cmcCode)

This method overloads the CallControlConnection.redirect() method. It takes five new parameters —- redirectMode, callingSearchSpace, calledAddressOption, facCode, and cmcCode. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space. The calledAddressOption parameter is used to decide whether to reset the original called fields or not.

The redirectMode parameter may be:

1. CiscoConnection.REDIRECT_DROP_ON_FAILURE

2. CiscoConnection.REDIRECT_NORMAL

The callingSearchSpace parameter may be:

1. CiscoConnection.DEFAULT_SEARCH_SPACE

2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE

3. CiscoConnection.ADDRESS_SEARCH_SPACE


Note The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.


The calledAddressOption parameter may be:

1. CiscoConnection.CALLED_ADDRESS_DEFAULT

2. CiscoConnection.CALLED_ADDRESS_UNCHANGED

3. CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

Throws:

javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateException

PreferredOriginalCalledParty parameter may be a DN that will be the originalCalledParty field when the call is offered to destinationAddress.

The facCode is the forced account code (FAC), and cmcCode is the client matter code (CMC).

setRequestController(TerminalConnection)

public void
setRequestController(javax.telephony.TerminalConnection tc)
throws InvalidArgumentException, InvalidStateException

This interface is provided to Requesting TerminalConnection. Applications are required to call this method prior to redirecting /Parking/disconnecting the Call for a Connection for a SharedLine Call. On a SharedLine address, there will be more that one TerminalConnection for a connection.

When there is only one active terminalConnection, applications may not specify RequestController, however if there is more that one active TerminalConnection in same connection e.g for BargedCall/ConferenceCall then Applications must specify RequestController. RequestController is the TerminalConnection which will be used for completing request. RequestController will be set to null/0 after request is completed/executed.

The following examples show how this interface can be used.

Example 2-1 Redirect: Address A has two active terminalConnection TC1 and TC2 Application want to redirect Call T2 to C.

CiscoConnection.setRequqestController(TC2);

CiscoConnection.redirect(C);

Example 2-2 Park: Address A have two active TerminalConnection TC1 and TC2 Application want to Park the Call at T2

CiscoConnection.setRequestController(TC2);

CiscoConnection.park();

Throws:

javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException

CiscoConnectionID

Declaration

public interface CiscoConnectionID extends CiscoObjectContainer

All Superinterfaces

CiscoObjectContainer

Description

The CiscoConnectionID object represents a unique object associated with each connection. Applications may use the object itself or the integer representation of the object returned by the intValue() method.

Member Summary
Methods
 CiscoConnection
 int
Returns an integer representation of this object, 
currently the CallManager CallLeg ID.

Inherited Member Summary
Methods inherited from interface CiscoObjectContainer

Methods

getConnection()

public com.cisco.jtapi.extensions.CiscoConnection getConnection()

intValue()

public int intValue()

Returns an integer representation of this object, currently the CallManager CallLeg ID.

Returns:

an integer representation of this object

CiscoConsultCall

Declaration

public interface CiscoConsultCall extends CiscoCall

All Superinterfaces

javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoCall, CiscoObjectContainer

Description

The CiscoConsultCall interface extends the CiscoCall interface to expose certain properties of Calls that have been created as part of a consultative transfer or consultative conference.

See Also:

javax.telephony.Call

Member Summary
Methods
 
javax.telephony.Connectio
n[]
From CallEvent perspective, this method behaves similar 
to CallControlCall.consult(TerminalConnection tc, String 
dialedDigits).
 
javax.telephony.TerminalC
onnection
Returns the consulting TerminalConnection that was used 
to create this CiscoConsultCall.

Inherited Member Summary
Fields inherited from interface Call
ACTIVE, IDLE, INVALID
Methods inherited from interface Call
addObserver(CallObserver), connect(Terminal, Address, String), 
getCallCapabilities(Terminal, Address), getCapabilities(Terminal, Address), 
getConnections(), getObservers(), getProvider(), getState(), 
removeObserver(CallObserver)
Methods inherited from interface CallControlCall
addParty(String), conference(Call), consult(TerminalConnection), 
consult(TerminalConnection), drop(), getCalledAddress(), getCallingAddress(), 
getCallingTerminal(), getConferenceController(), getConferenceEnable(), 
getLastRedirectedAddress(), getTransferController(), getTransferEnable(), 
offHook(Address, Terminal), setConferenceController(TerminalConnection), 
setConferenceEnable(boolean), setTransferController(TerminalConnection), 
setTransferEnable(boolean), transfer(String), transfer(String)
Methods inherited from interface CiscoCall
Methods inherited from interface CiscoObjectContainer

Methods

consultWithoutMedia(TerminalConnection, String)

public javax.telephony.Connection[]
consultWithoutMedia(javax.telephony.TerminalConnection tc, 
java.lang.String dialedDigits) 
throws InvalidStateException, InvalidArgumentException, MethodN
otSupportedException, ResourceUnavailableException, PrivilegeVi
olationException, InvalidPartyException

From CallEvent perspective, this method behaves similar to CallControlCall.consult(TerminalConnection tc, String dialedDigits). Creates a consultation between this Call and an active Call without establishing the media. This consult call may only be transferred, not conferenced.

The Consultation Purpose

This method does not support if invoked with CallControlCall.setConferneceEnable(). It only supports if invoked with CallControlCall.setTransferEnable().

Throws:

javax.telephony.InvalidPartyException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException

getConsultingTerminalConnection()

public javax.telephony.TerminalConnection
getConsultingTerminalConnection()

Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.

If this Call was created as part of a consultative transfer or consultative conference, the TerminalConnection which was used to perform the consultation on the original Call is returned by the getConsultingTerminalConnection method. This may be useful to applications that wish to correlate a ConsultCall with its original Call. Note that the original Call does not have any methods which may be used to determine the ConsultCall, if any, to which it is related.

Returns:

null if this Call is not the result of a consultation, or the consulting TerminalConnection of the original Call if this Call is the result of a consultation.

CiscoConsultCallActiveEv

Declaration

public interface CiscoConsultCallActiveEv extends CiscoCallEv,
javax.telephony.events.CallActiveEv

All Superinterfaces

javax.telephony.events.CallActiveEv, javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.Ev

Description

The CiscoConsultCallActiveEv event interface extends the JTAPI CallActiveEv. It indicates that the state of the Call object has changed to Call.ACTIVE and that the call was initiated as a result of a consultative transfer or consultative conference operation (manual or programmatic). Applications can obtain the consulting TerminalConnection on the original (consulting) call by using the CiscoConsultCall.getConsultingTerminalConnection method.

This event is reported to applications via the CallObserver interface.

See Also:

javax.telephony.Call, javax.telephony.CallObserver, javax.telephony.events.CallActiveEv

Member Summary
Fields
static int
ID


Methods
 
javax.telephony.TerminalC
onnection
Returns the consulting TerminalConnection that was used 
to create this CiscoConsultCall.

Inherited Member Summary
Fields inherited from interface CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BARGE, CAUSE_BCBPRESENTLYAVAIL, 
CAUSE_BCNAUTHORIZED, CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, 
CAUSE_CALLMANAGER_FAILURE, CAUSE_CALLREJECTED, CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, 
CAUSE_CHANUNACCEPTABLE, CAUSE_CTIMANAGER_FAILURE, CAUSE_DESTINATIONOUTOFORDER, 
CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, CAUSE_IDENTIFIEDCHANDOESNOTEXIST, 
CAUSE_IENIMPL, CAUSE_INBOUNDBLINDTRANSFER, CAUSE_INBOUNDCONFERENCE, 
CAUSE_INBOUNDTRANSFER, CAUSE_INCOMINGCALLBARRED, CAUSE_INCOMPATABLEDDESTINATION, 
CAUSE_INTERWORKINGUNSPECIFIED, CAUSE_INVALIDCALLREFVALUE, CAUSE_INVALIDIECONTENTS, 
CAUSE_INVALIDMESSAGEUNSPECIFIED, CAUSE_INVALIDNUMBERFORMAT, CAUSE_INVALIDTRANSITNETSEL, 
CAUSE_MANDATORYIEMISSING, CAUSE_MSGNCOMPATABLEWCS, CAUSE_MSGTYPENCOMPATWCS, 
CAUSE_MSGTYPENIMPL, CAUSE_NETOUTOFORDER, CAUSE_NOANSWERFROMUSER, CAUSE_NOCALLSUSPENDED, 
CAUSE_NOCIRCAVAIL, CAUSE_NOERROR, CAUSE_NONSELECTEDUSERCLEARING, 
CAUSE_NORMALCALLCLEARING, CAUSE_NORMALUNSPECIFIED, CAUSE_NOROUTETODDESTINATION, 
CAUSE_NOROUTETOTRANSITNET, CAUSE_NOUSERRESPONDING, CAUSE_NUMBERCHANGED, 
CAUSE_ONLYRDIVEARERCAPAVAIL, CAUSE_OUTBOUNDCONFERENCE, CAUSE_OUTBOUNDTRANSFER, 
CAUSE_PROTOCOLERRORUNSPECIFIED, CAUSE_QUALOFSERVNAVAIL, CAUSE_RECOVERYONTIMEREXPIRY, 
CAUSE_REDIRECTED, CAUSE_REQCALLIDHASBEENCLEARED, CAUSE_REQCIRCNAVIL, 
CAUSE_REQFACILITYNIMPL, CAUSE_REQFACILITYNOTSUBSCRIBED, CAUSE_RESOURCESNAVAIL, 
CAUSE_RESPONSETOSTATUSENQUIRY, CAUSE_SERVNOTAVAILUNSPECIFIED, 
CAUSE_SERVOPERATIONVIOLATED, CAUSE_SERVOROPTNAVAILORIMPL, CAUSE_SUSPCALLBUTNOTTHISONE, 
CAUSE_SWITCHINGEQUIPMENTCONGESTION, CAUSE_TEMPORARYFAILURE, CAUSE_UNALLOCATEDNUMBER, 
CAUSE_USERBUSY
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface CallEv
getCall()
Methods inherited from interface CiscoCallEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

ID

public static final int ID

Methods

getHeldTerminalConnection()

public javax.telephony.TerminalConnection
getHeldTerminalConnection()

Deprecated.

replaced by CiscoConsultCall.getConsultingTerminalConnection ()

Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.

This may be useful to applications that wish to correlate a consultation Call with its original Call. Note that the original Call does not have any methods which may be used to determine the consultation Call, if any, to which it is related.

Returns:

the consulting TerminalConnection of the Call that created the Call referenced by this event

CiscoEv

Declaration

public interface CiscoEv extends javax.telephony.events.Ev

All Superinterfaces

javax.telephony.events.Ev

All Known Subinterfaces

CiscoAddrAddedToTerminalEv, CiscoAddrAutoAcceptStatusChangedEv, CiscoAddrCreatedEv, CiscoAddrEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv, CiscoAddrRemovedEv, CiscoCallEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoOutOfServiceEv, CiscoProvCallParkEv, CiscoProvEv, CiscoProvFeatureEv, CiscoProvFeatureUnRegisteredEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputStoppedEv, CiscoRTPOutputStartedEv, CiscoTermButtonPressedEv, CiscoTermButtonPressedEv, CiscoTermCreatedEv, CiscoTermDataEv, CiscoTermEv, CiscoTerminal, CiscoTerminal, CiscoTermInServiceEv, CiscoTermOutOfServiceEv, CiscoTermRemovedEv, CiscoTransferEndEv, CiscoTransferStartEv

Description

The CiscoEv interface, which extends JTAPI's core javax.telephony.events.Ev interface, serves as the base interface for all Cisco-extended JTAPI events. Every event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.Ev

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

CiscoG711MediaCapability

Declaration

public class CiscoG711MediaCapability extends CiscoMediaCapability
 
java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +--com.cisco.jtapi.extensions.CiscoG711MediaCapability

Description

The CiscoG711MediaCapability object specifies the properties for a G.711 encoded RTP stream. Applications that support G.711 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.

The default packet size is thirty milliseconds.

Member Summary
Fields
static int
The frames-per-packet value for 60 millisecond packets
static int
The frames-per-packet value for 30 millisecond packets
static int
The frames-per-packet value for 20 millisecond packets
Constructors
 
Constructs a CiscoG711MediaCapability</CODE object with a 
default thirty millisecond packet size.
 
Constructs a CiscoG711MediaCapability</CODE object with 
the specified packet size.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
wait(), wait(), wait()

Fields

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET

The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET

The frames-per-packet value for 20 millisecond packets

Constructors

CiscoG711MediaCapability()

public CiscoG711MediaCapability()

Constructs a CiscoG711MediaCapability</CODE object with a default thirty millisecond packet size.

CiscoG711MediaCapability(int)

public CiscoG711MediaCapability(int maxFramesPerPacket)

Constructs a CiscoG711MediaCapability</CODE object with the specified packet size.

CiscoG723MediaCapability

Declaration

public class CiscoG723MediaCapability extends CiscoMediaCapability
java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +--com.cisco.jtapi.extensions.CiscoG723MediaCapability

Description

The CiscoG723MediaCapability object specifies the properties for a G.723 encoded RTP stream. Applications that support G.723 media termination use this object to specify their preferred packet size and bit rate when registering a CiscoMediaTerminal.

The default packet size is thirty milliseconds and the default bit rate is 6.4k.

Member Summary
Fields
static int
The frames-per-packet value for 60 millisecond packets
static int
The frames-per-packet value for 30 millisecond packets
static int
The frames-per-packet value for 20 millisecond packets
Constructors
 
Constructs a CiscoG723MediaCapability</CODE object with a 
default thirty millisecond packet size and 6.4k bit rate.
 
Constructs a CiscoG723MediaCapability</CODE object with 
the specified packet size and bit rate.
Methods
 int
Returns the bit rate specified by this capability object.
 java.lang.String

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability

Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
witty wait()

Fields

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET

The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET

The frames-per-packet value for 20 millisecond packets

Constructors

CiscoG723MediaCapability()

public CiscoG723MediaCapability()

Constructs a CiscoG723MediaCapability</CODE object with a default thirty millisecond packet size and 6.4k bit rate.

CiscoG723MediaCapability(int, int)

public CiscoG723MediaCapability(int maxFramesPerPacket,
int bitRate)

Constructs a CiscoG723MediaCapability</CODE object with the specified packet size and bit rate.

Methods

getBitRate()

public int getBitRate()

Returns the bit rate specified by this capability object.

Returns:

a bit rate from the RTPBitRate interface

toString()

public java.lang.String toString()

Overrides:

toString in class CiscoMediaCapability

CiscoG729MediaCapability

Declaration

public class CiscoG729MediaCapability extends CiscoMediaCapability
java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +--com.cisco.jtapi.extensions.CiscoG729MediaCapability

Description

The CiscoG729MediaCapability object specifies the properties for a G.729 encoded RTP stream. Applications that support G.729 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.

The default packet size is thirty milliseconds.

Member Summary
Fields
static int
The frames-per-packet value for 60 millisecond packets
static int
The frames-per-packet value for 30 millisecond packets
static int
The frames-per-packet value for 20 millisecond packets
Constructors
 
Constructs a CiscoG729MediaCapability</CODE object with a 
default G729 payload and thirty millisecond packet size.
 
Constructs a CiscoG729MediaCapability</CODE object with 
the specified packet size and payload.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
witty wait()

Fields

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET

The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET

The frames-per-packet value for 20 millisecond packets

Constructors

CiscoG729MediaCapability()

public CiscoG729MediaCapability()

Constructs a CiscoG729MediaCapability</CODE object with a default G729 payload and thirty millisecond packet size.

CiscoG729MediaCapability(int, int)

public CiscoG729MediaCapability(int payload,
int maxFramesPerPacket)

Constructs a CiscoG729MediaCapability</CODE object with the specified packet size and payload. The choice of payload is specified in CiscoRTPPayload with the options CiscoRTPPayload.G729 and CiscoRTPPayload.G729ANNEXA

CiscoGSMMediaCapability

Declaration

public class CiscoGSMMediaCapability extends CiscoMediaCapability
 
java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoMediaCapability
        |
        +--com.cisco.jtapi.extensions.CiscoGSMMediaCapability

Description

The CiscoGSMMediaCapability object specifies the properties for a GSM encoded RTP stream. Applications that support GSM media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.

The default packet size is thirty milliseconds.

Member Summary
Fields
static int
The frames-per-packet value for 30 millisecond packets
Constructors
 
Constructs a CiscoGSMMediaCapability</CODE object with a 
default eighty millisecond packet size.
 
Constructs a CiscoGSMMediaCapability</CODE object with 
the specified packet size.

Inherited Member Summary
Fields inherited from class CiscoMediaCapability
Methods inherited from class CiscoMediaCapability
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
wait(), wait(), wait()

Fields

FRAMESIZE_EIGHTY_MILLISECOND_PACKET

public static final int FRAMESIZE_EIGHTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

Constructors

CiscoGSMMediaCapability()

public CiscoGSMMediaCapability()

Constructs a CiscoGSMMediaCapability</CODE object with a default eighty millisecond packet size.

CiscoGSMMediaCapability(int)

public CiscoGSMMediaCapability(int maxFramesPerPacket)

Constructs a CiscoGSMMediaCapability</CODE object with the specified packet size.

CiscoJtapiException

Declaration

public interface CiscoJtapiException

Description

The CiscoJtapiException interface defines CTI error codes. These are the error codes that may be returned by CTI requests. All the JTAPI exceptions have been extended to implement this interface. The Error codes can be got by casting the exception to CiscoJtapiException and calling the method getErrorCode(). If 'e' is any exception caught in an application, see if its an instance of CiscoJtapiException.

 
try { 
 // some code here } 
 catch ( Exception e ) { 
 if( e instanceof CiscoJtapiException){
 CiscoJtapiException ce = 
com.cisco.cti.client.CTIFAILURE.(CiscoJtapiException) e 
 int errorCode = com.cisco.cti.client.CTIFAILURE.ce.getErrorCode() 
//returns the ErrorCode. 
}  
 }  
 

Member Summary
Fields
static int
static int
public static final int
CALL_DROPPED
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int 
CTIERR_FAC_CMC_REASON_FAC_NEEDED
static int 
CTIERR_FAC_CMC_REASON_CMC_NEEDED
static int 
CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED
static int 
CTIERR_FAC_CMC_REASON_FAC_INVALID
static int 
CTIERR_FAC_CMC_REASON_CMC_INVALID
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
static int
The CTI error codes.
Methods
 int
Returns the errorCode for this exception
 java.lang.String
This method returns the detail description of the 
errorCode
 java.lang.String
This method returns the detail description of the 
errorCode
 java.lang.String
This method returns an exception in the string format.
 java.lang.String
This method will return an exception in the string 
format.

Fields

ASSOCIATED_LINE_NOT_OPEN

public static final int ASSOCIATED_LINE_NOT_OPEN

CALL_ALREADY_EXISTS

public static final int CALL_ALREADY_EXISTS

CALL_DROPPED

public static final int CALL_DROPPED

The call is dropped after the feature request (hold, unhold, transfer, conference) but before completing the request.

CALLHANDLE_NOTINCOMINGCALL

public static final int CALLHANDLE_NOTINCOMINGCALL

CALLHANDLE_UNKNOWN_TO_LINECONTROL

public static final int CALLHANDLE_UNKNOWN_TO_LINECONTROL

CANNOT_OPEN_DEVICE

public static final int CANNOT_OPEN_DEVICE

CANNOT_TERMINATE_MEDIA_ON_PHONE

public static final int CANNOT_TERMINATE_MEDIA_ON_PHONE

CFWDALL_ALREADY_OFF

public static final int CFWDALL_ALREADY_OFF

CFWDALL_ALREADY_SET

public static final int CFWDALL_ALREADY_SET

CFWDALL_DESTN_INVALID

public static final int CFWDALL_DESTN_INVALID

CLUSTER_LINK_FAILURE

public static final int CLUSTER_LINK_FAILURE

COMMAND_NOT_IMPLEMENTED_ON_DEVICE

public static final int COMMAND_NOT_IMPLEMENTED_ON_DEVICE

CONFERENCE_ALREADY_PRESENT

public static final int CONFERENCE_ALREADY_PRESENT

CONFERENCE_FAILED

public static final int CONFERENCE_FAILED

CONFERENCE_FULL

public static final int CONFERENCE_FULL

CONFERENCE_INACTIVE

public static final int CONFERENCE_INACTIVE

CONFERENCE_INVALID_PARTICIPANT

public static final int CONFERENCE_INVALID_PARTICIPANT

CTIERR_ACCESS_TO_DEVICE_DENIED

public static final int CTIERR_ACCESS_TO_DEVICE_DENIED

CTIERR_APP_SOFTKEYS_ALREADY_CONTROLLED

public static final int CTIERR_APP_SOFTKEYS_ALREADY_CONTROLLED

CTIERR_APPLICATION_DATA_SIZE_EXCEEDED

public static final int CTIERR_APPLICATION_DATA_SIZE_EXCEEDED

CTIERR_CALL_MANAGER_NOT_AVAILABLE

public static final int CTIERR_CALL_MANAGER_NOT_AVAILABLE

CTIERR_CALL_NOT_EXISTED

public static final int CTIERR_CALL_NOT_EXISTED

CTIERR_CALL_PARK_NO_DN

public static final int CTIERR_CALL_PARK_NO_DN

CTIERR_CALL_REQUEST_ALREADY_OUTSTANDING

public static final int CTIERR_CALL_REQUEST_ALREADY_OUTSTANDING

CTIERR_CALL_UNPARK_FAILED

public static final int CTIERR_CALL_UNPARK_FAILED

CTIERR_CAPABILITIES_DO_NOT_MATCH

public static final int CTIERR_CAPABILITIES_DO_NOT_MATCH

CTIERR_CLOSE_DELAY_NOT_SUPPORTED_WITH_REG_TYPE

public static final int 
CTIERR_CLOSE_DELAY_NOT_SUPPORTED_WITH_REG_TYPE

CTIERR_CONFERENCE_ALREADY_EXISTED

public static final int CTIERR_CONFERENCE_ALREADY_EXISTED

CTIERR_CONFERENCE_NOT_EXISTED

public static final int CTIERR_CONFERENCE_NOT_EXISTED

CTIERR_CONSULT_CALL_FAILURE

public static final int CTIERR_CONSULT_CALL_FAILURE

CTIERR_CONSULTCALL_ALREADY_OUTSTANDING

public static final int CTIERR_CONSULTCALL_ALREADY_OUTSTANDING

CTIERR_CTIHANDLER_PROCESS_CREATION_FAILED

public static final int CTIERR_CTIHANDLER_PROCESS_CREATION_FAILED

CTIERR_DEVICE_ALREADY_OPENED

public static final int CTIERR_DEVICE_ALREADY_OPENED

CTIERR_DEVICE_NOT_OPENED_YET

public static final int CTIERR_DEVICE_NOT_OPENED_YET

CTIERR_DEVICE_OWNER_ALIVE_TIMER_STARTED

public static final int CTIERR_DEVICE_OWNER_ALIVE_TIMER_STARTED

CTIERR_DEVICE_SHUTTING_DOWN

public static final int CTIERR_DEVICE_SHUTTING_DOWN

CTIERR_DUPLICATE_CALL_REFERENCE

public static final int CTIERR_DUPLICATE_CALL_REFERENCE

CTIERR_FAC_CMC_REASON_CMC_INVALID

public static final int CTIERR_FAC_CMC_REASON_CMC_INVALID

CTIERR_FAC_CMC_REASON_CMC_NEEDED

public static final int CTIERR_FAC_CMC_REASON_CMC_NEEDED

CTIERR_FAC_CMC_REASON_FAC_INVALID

public static final int CTIERR_FAC_CMC_REASON_FAC_INVALID

CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED

public static final int.CTIERR_FAC_CMC_REASON_FAC_CMC_NEEDED

CTIERR_FAC_CMC_REASON_FAC_NEEDED

public static final int CTIERR_FAC_CMC_REASON_FAC_NEEDED

CTIERR_FEATURE_ALREADY_REGISTERED

public static final int CTIERR_FEATURE_ALREADY_REGISTERED

CTIERR_FEATURE_DATA_REJECT

public static final int CTIERR_FEATURE_DATA_REJECT

CTIERR_ILLEGAL_DEVICE_TYPE

public static final int CTIERR_ILLEGAL_DEVICE_TYPE

CTIERR_INCOMPATIBLE_AUTOINSTALL_PROTOCOL_VERSION

public static final int 
CTIERR_INCOMPATIBLE_AUTOINSTALL_PROTOCOL_VERSION

CTIERR_INCORRECT_MEDIA_CAPABILITY

public static final int CTIERR_INCORRECT_MEDIA_CAPABILITY

CTIERR_INFORMATION_NOT_AVAILABLE

public static final int CTIERR_INFORMATION_NOT_AVAILABLE

CTIERR_INTERNAL_FAILURE

public static final int CTIERR_INTERNAL_FAILURE

CTIERR_INVALID_DEVICE_NAME

public static final int CTIERR_INVALID_DEVICE_NAME

CTIERR_INVALID_DTMFDIGITS

public static final int CTIERR_INVALID_DTMFDIGITS

CTIERR_INVALID_MEDIA_DEVICE

public static final int CTIERR_INVALID_MEDIA_DEVICE

CTIERR_INVALID_MEDIA_PARAMETER

public static final int CTIERR_INVALID_MEDIA_PARAMETER

CTIERR_INVALID_MEDIA_PROCESS

public static final int CTIERR_INVALID_MEDIA_PROCESS

CTIERR_INVALID_MEDIA_RESOURCE_ID

public static final int CTIERR_INVALID_MEDIA_RESOURCE_ID

CTIERR_INVALID_MESSAGE_HEADER_INFO

public static final int CTIERR_INVALID_MESSAGE_HEADER_INFO

CTIERR_INVALID_MESSAGE_LENGTH

public static final int CTIERR_INVALID_MESSAGE_LENGTH

CTIERR_INVALID_MONITOR_DN_TYPE

public static final int CTIERR_INVALID_MONITOR_DN_TYPE

CTIERR_INVALID_PARAMETER

public static final int CTIERR_INVALID_PARAMETER

CTIERR_INVALID_PARK_DN

public static final int CTIERR_INVALID_PARK_DN

CTIERR_INVALID_PARK_REGISTRATION_HANDLE

public static final int CTIERR_INVALID_PARK_REGISTRATION_HANDLE

CTIERR_INVALID_RESOURCE_TYPE

public static final int CTIERR_INVALID_RESOURCE_TYPE

CTIERR_MAXCALL_LIMIT_REACHED

public static final int CTIERR_MAXCALL_LIMIT_REACHED

CTIERR_INCORRECT_MEDIA_CAPABILITY

public static final int CTIERR_INCORRECT_MEDIA_CAPABILITY

CTIERR_INVALID_DTMFDIGITS

public static final int CTIERR_INVALID_DTMFDIGITS

CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC

public static final int CTIERR_MEDIA_ALREADY_TERMINATED_DYNAMIC

CTIERR_MEDIA_ALREADY_TERMINATED_NONE

public static final int CTIERR_MEDIA_ALREADY_TERMINATED_NONE

CTIERR_MEDIA_ALREADY_TERMINATED_STATIC

public static final int CTIERR_MEDIA_ALREADY_TERMINATED_STATIC

CTIERR_MEDIA_CAPABILITY_MISMATCH

public static final int CTIERR_MEDIA_CAPABILITY_MISMATCH

CTIERR_MEDIA_RESOURCE_NAME_SIZE_EXCEEDED

public static final int CTIERR_MEDIA_RESOURCE_NAME_SIZE_EXCEEDED

CTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCH

public static final int CTIERR_MEDIAREGISTRATIONTYPE_DO_NOT_MATCH

CTIERR_MESSAGE_TOO_BIG

public static final int CTIERR_MESSAGE_TOO_BIG

CTIERR_MORE_ACTIVE_CALLS_THAN_RESERVED

public static final int CTIERR_MORE_ACTIVE_CALLS_THAN_RESERVED

CTIERR_NO_EXISTING_CALLS

public static final int CTIERR_NO_EXISTING_CALLS

CTIERR_NO_EXISTING_CONFERENCE

public static final int CTIERR_NO_EXISTING_CONFERENCE

CTIERR_NO_RESPONSE_FROM_MP

public static final int CTIERR_NO_RESPONSE_FROM_MP

CTIERR_NOT_PRESERVED_CALL

public static final int CTIERR_NOT_PRESERVED_CALL

CTIERR_OPERATION_FAILED_QUIETCLEAR

public static final int CTIERR_OPERATION_FAILED_QUIETCLEAR

CTIERR_OPERATION_NOT_ALLOWED

public static final int CTIERR_OPERATION_NOT_ALLOWED

CTIERR_OWNER_NOT_ALIVE

public static final int CTIERR_OWNER_NOT_ALIVE

CTIERR_PENDING_ACCEPT_OR_ANSWER_REQUEST

public static final int CTIERR_PENDING_ACCEPT_OR_ANSWER_REQUEST

CTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGE

public static final int CTIERR_REDIRECT_UNAUTHORIZED_COMMAND_USAGE

CTIERR_REGISTER_FEATURE_ACTIVATION_FAILED

public static final int CTIERR_REGISTER_FEATURE_ACTIVATION_FAILED

CTIERR_RESOURCE_NOT_AVAILABLE

public static final int CTIERR_RESOURCE_NOT_AVAILABLE

CTIERR_STATION_SHUT_DOWN

public static final int CTIERR_STATION_SHUT_DOWN

CTIERR_SYSTEM_ERROR

public static final int CTIERR_SYSTEM_ERROR

CTIERR_UNKNOWN_EXCEPTION

public static final int CTIERR_UNKNOWN_EXCEPTION

CTIERR_UNSUPPORTED_CALL_PARK_TYPE

public static final int CTIERR_UNSUPPORTED_CALL_PARK_TYPE

DARES_INVALID_REQ_TYPE

public static final int DARES_INVALID_REQ_TYPE

DATA_SIZE_LIMIT_EXCEEDED

public static final int DATA_SIZE_LIMIT_EXCEEDED

DB_ERROR

public static final int DB_ERROR

DB_ILLEGAL_DEVICE_TYPE

public static final int DB_ILLEGAL_DEVICE_TYPE

DB_NO_MORE_DEVICES

public static final int DB_NO_MORE_DEVICES

DESTINATION_BUSY

public static final int DESTINATION_BUSY

DESTINATION_UNKNOWN

public static final int DESTINATION_UNKNOWN

DEVICE_ALREADY_REGISTERED

public static final int DEVICE_ALREADY_REGISTERED

DEVICE_NOT_OPEN

public static final int DEVICE_NOT_OPEN

DEVICE_OUT_OF_SERVICE

public static final int DEVICE_OUT_OF_SERVICE

DIGIT_GENERATION_ALREADY_IN_PROGRESS

public static final int DIGIT_GENERATION_ALREADY_IN_PROGRESS

DIGIT_GENERATION_CALLSTATE_CHANGED

public static final int DIGIT_GENERATION_CALLSTATE_CHANGED

DIGIT_GENERATION_WRONG_CALL_HANDLE

public static final int DIGIT_GENERATION_WRONG_CALL_HANDLE

DIGIT_GENERATION_WRONG_CALL_STATE

public static final int DIGIT_GENERATION_WRONG_CALL_STATE

DIRECTORY_LOGIN_FAILED

public static final int DIRECTORY_LOGIN_FAILED

DIRECTORY_LOGIN_NOT_ALLOWED

public static final int DIRECTORY_LOGIN_NOT_ALLOWED

DIRECTORY_TEMPORARY_UNAVAILABLE

public static final int DIRECTORY_TEMPORARY_UNAVAILABLE

EXISTING_FIRSTPARTY

public static final int EXISTING_FIRSTPARTY

HOLDFAILED

public static final int HOLDFAILED

ILLEGAL_CALLINGPARTY

public static final int ILLEGAL_CALLINGPARTY

ILLEGAL_CALLSTATE

public static final int ILLEGAL_CALLSTATE

ILLEGAL_HANDLE

public static final int ILLEGAL_HANDLE

ILLEGAL_MESSAGE_FORMAT

public static final int ILLEGAL_MESSAGE_FORMAT

INCOMPATIBLE_PROTOCOL_VERSION

public static final int INCOMPATIBLE_PROTOCOL_VERSION

INVALID_LINE_HANDLE

public static final int INVALID_LINE_HANDLE

INVALID_RING_OPTION

public static final int INVALID_RING_OPTION

LINE_INFO_DOES_NOT_EXIST

public static final int LINE_INFO_DOES_NOT_EXIST

LINE_NOT_PRIMARY

public static final int LINE_NOT_PRIMARY

LINECONTROL_FAILURE

public static final int LINECONTROL_FAILURE

MAX_NUMBER_OF_CTI_CONNECTIONS_REACHED

public static final int MAX_NUMBER_OF_CTI_CONNECTIONS_REACHED

MSGWAITING_DESTN_INVALID

public static final int MSGWAITING_DESTN_INVALID

NO_ACTIVE_DEVICE_FOR_THIRDPARTY

public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTY

NO_CONFERENCE_BRIDGE

public static final int NO_CONFERENCE_BRIDGE

NOT_INITIALIZED

public static final int NOT_INITIALIZED

PROTOCOL_TIMEOUT

public static final int PROTOCOL_TIMEOUT

PROVIDER_ALREADY_OPEN

public static final int PROVIDER_ALREADY_OPEN

PROVIDER_CLOSED

public static final int PROVIDER_CLOSED

PROVIDER_NOT_OPEN

public static final int PROVIDER_NOT_OPEN

REDIRECT_CALL_CALL_TABLE_FULL

public static final int REDIRECT_CALL_CALL_TABLE_FULL

REDIRECT_CALL_DESTINATION_BUSY

public static final int REDIRECT_CALL_DESTINATION_BUSY

REDIRECT_CALL_DESTINATION_OUT_OF_ORDER

public static final int REDIRECT_CALL_DESTINATION_OUT_OF_ORDER

REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT

public static final int REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT

REDIRECT_CALL_DOES_NOT_EXIST

public static final int REDIRECT_CALL_DOES_NOT_EXIST

REDIRECT_CALL_INCOMPATIBLE_STATE

public static final int REDIRECT_CALL_INCOMPATIBLE_STATE

REDIRECT_CALL_MEDIA_CONNECTION_FAILED

public static final int REDIRECT_CALL_MEDIA_CONNECTION_FAILED

REDIRECT_CALL_NORMAL_CLEARING

public static final int REDIRECT_CALL_NORMAL_CLEARING

REDIRECT_CALL_ORIGINATOR_ABANDONED

public static final int REDIRECT_CALL_ORIGINATOR_ABANDONED

REDIRECT_CALL_PARTY_TABLE_FULL

public static final int REDIRECT_CALL_PARTY_TABLE_FULL

REDIRECT_CALL_PENDING_REDIRECT_TRANSACTION

public static final int REDIRECT_CALL_PENDING_REDIRECT_TRANSACTION

REDIRECT_CALL_PROTOCOL_ERROR

public static final int REDIRECT_CALL_PROTOCOL_ERROR

REDIRECT_CALL_UNKNOWN_DESTINATION

public static final int REDIRECT_CALL_UNKNOWN_DESTINATION

REDIRECT_CALL_UNKNOWN_ERROR

public static final int REDIRECT_CALL_UNKNOWN_ERROR

REDIRECT_CALL_UNKNOWN_PARTY

public static final int REDIRECT_CALL_UNKNOWN_PARTY

REDIRECT_CALL_UNRECOGNIZED_MANAGER

public static final int REDIRECT_CALL_UNRECOGNIZED_MANAGER

REDIRECT_CALLINFO_ERR

public static final int REDIRECT_CALLINFO_ERR

REDIRECT_ERR

public static final int REDIRECT_ERR

RETRIEVEFAILED

public static final int RETRIEVEFAILED

RETRIEVEFAILED_ACTIVE_CALL_ON_LINE

public static final int RETRIEVEFAILED_ACTIVE_CALL_ON_LINE

SSAPI_NOT_REGISTERED

public static final int SSAPI_NOT_REGISTERED

TIMEOUT

public static final int TIMEOUT

TRANSFER_INACTIVE

public static final int TRANSFER_INACTIVE

TRANSFERFAILED

public static final int TRANSFERFAILED

TRANSFERFAILED_CALLCONTROL_TIMEOUT

public static final int TRANSFERFAILED_CALLCONTROL_TIMEOUT

TRANSFERFAILED_DESTINATION_BUSY

public static final int TRANSFERFAILED_DESTINATION_BUSY

TRANSFERFAILED_DESTINATION_UNALLOCATED

public static final int TRANSFERFAILED_DESTINATION_UNALLOCATED

TRANSFERFAILED_OUTSTANDING_TRANSFER

public static final int TRANSFERFAILED_OUTSTANDING_TRANSFER

UNDEFINED_LINE

public static final int UNDEFINED_LINE

UNKNOWN_GLOBAL_CALL_HANDLE

public static final int UNKNOWN_GLOBAL_CALL_HANDLE

UNRECOGNIZABLE_PDU

public static final int UNRECOGNIZABLE_PDU

UNSPECIFIED

public static final int UNSPECIFIED

The CTI error codes. These are the error codes that may be returned by CTI requests.

Methods

getErrorCode()

public int getErrorCode()

Returns the errorCode for this exception

Returns:

errorCode in an integer representation

getErrorDescription()

public java.lang.String getErrorDescription()

This method returns the detail description of the errorCode

Returns:

String detail description of the errorCode

getErrorDescription(int)

public java.lang.String getErrorDescription(int errorCode)

Deprecated.

instead use String getErrorDescription ();

This method returns the detail description of the errorCode

Returns:

String detail description of the errorCode

getErrorName()

public java.lang.String getErrorName()

This method returns an exception in the string format.

Returns:

String representation of the error code

getErrorName(int)

public java.lang.String getErrorName(int errorCode)

Deprecated.

instead use String getErrorName ();

This method will return an exception in the string format.

Returns:

String representation of the error code

CiscoJtapiPeer

Declaration

public interface CiscoJtapiPeer extends
com.cisco.services.tracing.TraceModule, javax.telephony.JtapiPeer, 
CiscoObjectContainer

All Superinterfaces

CiscoObjectContainer, javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModule

Description

By extending the com.cisco.services.tracing.TraceModule interface, the CiscoJtapiPeer exposes trace information to applications. All instances of JtapiPeer objects created by the Cisco JTAPI implementation implement this interface. Applications that wish to manipulate the trace settings of the Cisco JTAPI implementation may use the CiscoJtapiPeer.getTraceManager method to obtain its TraceManager object. The TraceManager object may then be manipulated as described in the com.cisco.services.tracing package.

See Also:

com.cisco.services.tracing.TraceModule

Member Summary
Methods
 CiscoJtapiProperties
CiscoJtapiProperties defines the various methods that 
applications can use to modify the parameters that the 
JTAPI layer will use.

Inherited Member Summary
Methods inherited from interface CiscoObjectContainer

Methods inherited from interface JtapiPeer
getName(), getProvider(String), getServices()
Methods inherited from interface TraceModule
getTraceManager(), getTraceModuleName()

Methods

getJtapiProperties()

public com.cisco.jtapi.extensions.CiscoJtapiProperties
getJtapiProperties()

CiscoJtapiProperties defines the various methods that applications can use to modify the parameters that the JTAPI layer will use.

See Also:

CiscoJtapiProperties

CiscoJtapiProperties

Declaration

public interface CiscoJtapiProperties

Description

Cisco JTAPI's behavior and functionality is tailored by many parameters which are read in from the jtapi.ini file when an instance of CiscoJtapiPeer is instantiated. These parameters are now exposed to applications for control via this CiscoJtapiproperties interface.

Applications can query the CiscoJtapiproperties properties object and change these parameters to better suit the application functionality. Exposing these properties via the CiscoJtapiproperties interface also allows applications to have a single point of administration (at the application end) for these parameters.

The most visible parameters are those describing the tracing levels and tracing destinations.

Usage:

JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null ); 
 if(peer instanceof CiscoJtapiPeer){ 
 CiscoJtapiProperties jProps = 
((CiscoJtapiPeer)peer).getJtapiProperties(); 
 jProps.setTracePath("\\D:\\Traces\\WorkFlow"); 
 jProps.setUseJavaConsoleTrace(false); 
 MyProviderObserver providerObserver = new MyProviderObserver (); 
 provider = peer.getProvider ( providerName ); 
 } 
  

where

an application sets the java console tracing to off and the trace path to D:\Traces\WorkFlowApp1.

When the peer gets obtained, an object implementing CiscoJtapiProperties gets created by reading parameters set in the jtapi.ini file. If no jtapi.ini file exists in the classpath, the default settings get used to create this object.

The parameters used by Cisco Jtapi are read in and frozen when the first getProvider () call is made.

Member Summary
Methods
 java.lang.String
get the alarm service host name
 int
get the port number for the alarm service
 int
get the timout for cti requests, other than the provider 
open (seconds)
 java.lang.String[]
get names of supported debugging level jtapi traces
 boolean
get the enabled or disabled state of a debugging level 
trace
 int
get the desired interval at which the CTI Manager must 
send heartbeats to JTAPI (seconds).
 java.lang.String
the filename for individual log files.
 java.lang.String
get the filename extension for log files
 int
number of trace files before rollover
 boolean
get the enabled state of periodic wake up
 int
get the interval for periodic wakeup (milliseconds)
 int
get the timout for a provider open request (seconds)
 int
get the interval at which the connection to the CTI 
Manager will ge retried (seconds)
 int
get the threshold for the event queue size to trigger 
alarms
 boolean
get the enabled state of event queue stats
 int
get the route select timeout (milliseconds)
 java.lang.String[]
Returns the services that this implementation supports.
 java.lang.String
get the syslog collector hostname
 int
get the syslog collector UDP port
 java.lang.String
the directory in the path where trace files will be 
written
 int
the size of the tracefiles before rollover
 java.lang.String[]
get the names of supported jtapi traces
 java.lang.String
get the path where the trace files will be located
 boolean
get the enabled or disabled state of a trace
 boolean
get the enabled/disabled state of the alarm service
 boolean
get the enabled or disabled state of jtapi log file 
tracing
 boolean
get the enabled or disabled state of jtapi console 
tracing
 boolean
if UseSameDir is true this will cause the traces to go to 
a single directory.
 boolean
get the enabled or disabled state of syslog tracing
 void
set the alarm service host name
 void
set the port number the alarm service is listening on
 void
set the timeout for cti requests other than provider open 
(seconds)
 void
enable or disable a particular debugging level trace
 void
set the desired interval at which the CTI Manager must 
send heartbeats to JTAPI (seconds).
 void
set the filename for log files
 void
set the filename extension for log files
 void
set the number of trace files before rollover
 void
set the enable/disable state for periodic wake up
 void
set the periodic wake up interval (milliseconds)
 void
set the timeout for a provider open request (seconds)
 void
set the interval at which the connection to the CTI 
Manager will ge retried (seconds)
 void
set the threshold for the event queue size to trigger 
alarms
 void
enable / disable event queue statistics
 void
set the route select timeout milliseconds
 void
set a list of available services
 void
set the syslog collector hostname
 void
set the syslog collector UDP port
 void
set the directory where jtapi trace files should be 
written
 void
set the size of the trace file
 void
set the directory root where jtapi traces will be written
 void
enable or disable a particular trace
 void
enable the alarm service
 void
enable or disable jtapi log file tracing
 void
enable or disable jtapi console tracing
 void
if UseSameDir is true this will cause the traces to go to 
a single directory.
 void
enable or disable syslog tracing

Methods

getAlarmServiceHostname()

public java.lang.String getAlarmServiceHostname()

get the alarm service host name

getAlarmServicePort()

public int getAlarmServicePort()

get the port number for the alarm service

getCtiRequestTimeout()

public int getCtiRequestTimeout()

get the timout for cti requests, other than the provider open (seconds)

getDebuggingNames()

public java.lang.String[] getDebuggingNames()

get names of supported debugging level jtapi traces

getDebuggingValue(String)

public boolean getDebuggingValue(java.lang.String debuggingName)

get the enabled or disabled state of a debugging level trace

getDesiredServerHeartbeatInterval()

public int getDesiredServerHeartbeatInterval()

get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.

getFileNameBase()

public java.lang.String getFileNameBase()

the filename for individual log files.

getFileNameExtension()

public java.lang.String getFileNameExtension()

get the filename extension for log files

getNumTraceFiles()

public int getNumTraceFiles()

number of trace files before rollover

getPeriodicWakeupEnabled()

public boolean getPeriodicWakeupEnabled()

get the enabled state of periodic wake up

getPeriodicWakeupInterval()

public int getPeriodicWakeupInterval()

get the interval for periodic wakeup (milliseconds)

getProviderOpenRequestTimeout()

public int getProviderOpenRequestTimeout()

get the timout for a provider open request (seconds)

getProviderRetryInterval()

public int getProviderRetryInterval()

get the interval at which the connection to the CTI Manager will ge retried (seconds)

getQueueSizeThreshold()

public int getQueueSizeThreshold()

get the threshold for the event queue size to trigger alarms

getQueueStatsEnabled()

public boolean getQueueStatsEnabled()

get the enabled state of event queue stats

getRouteSelectTimeout()

public int getRouteSelectTimeout()

get the route select timeout (milliseconds)

getServices()

public java.lang.String[] getServices()

Returns the services that this implementation supports. Note: This is a static list administered in the jtapi.ini file. There is no automatic discovery mechanism to locate available cti services

getSyslogCollector()

public java.lang.String getSyslogCollector()

get the syslog collector hostname

getSyslogCollectorUDPPort()

public int getSyslogCollectorUDPPort()

get the syslog collector UDP port

getTraceDirectory()

public java.lang.String getTraceDirectory()

The directory in the path where trace files will be written

getTraceFileSize()

public int getTraceFileSize()

The size of the tracefiles before rollover

getTraceNames()

public java.lang.String[] getTraceNames()

get the names of supported jtapi traces

getTracePath()

public java.lang.String getTracePath()

get the path where the trace files will be located

getTraceValue(String)

public boolean getTraceValue(java.lang.String traceName)

get the enabled or disabled state of a trace

getUseAlarmService()

public boolean getUseAlarmService()

get the enabled/disabled state of the alarm service

getUseFileTrace()

public boolean getUseFileTrace()

get the enabled or disabled state of jtapi log file tracing

getUseJavaConsoleTrace()

public boolean getUseJavaConsoleTrace()

get the enabled or disabled state of jtapi console tracing

getUseSameDir()

public boolean getUseSameDir()

if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a separate directory, indexed in sequence from the last directory written or available.

getUseSyslog()

public boolean getUseSyslog()

get the enabled or disabled state of syslog tracing

setAlarmServiceHostname(String)

public void setAlarmServiceHostname(java.lang.String hostname)

set the alarm service host name

setAlarmServicePort(int)

public void setAlarmServicePort(int portNumber)

set the port number the alarm service is listening on

setCtiRequestTimeout(int)

public void setCtiRequestTimeout(int seconds)

set the timeout for cti requests other than provider open (seconds)

setDebuggingValue(String, boolean)

public void setDebuggingValue(java.lang.String debuggingName,
boolean value)

enable or disable a particular debugging level trace

setDesiredServerHeartbeatInterval(int)

public void setDesiredServerHeartbeatInterval(int seconds)

set the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.

setFileNameBase(String)

public void setFileNameBase(java.lang.String base)

set the filename for log files

setFileNameExtension(String)

public void setFileNameExtension(java.lang.String extn)

set the filename extension for log files

setNumTraceFiles(int)

public void setNumTraceFiles(int val)

set the number of trace files before rollover

setPeriodicWakeupEnabled(boolean)

public void setPeriodicWakeupEnabled(boolean enabled)

set the enable/disable state for periodic wake up

setPeriodicWakeupInterval(int)

public void setPeriodicWakeupInterval(int milliseconds)

set the periodic wake up interval (milliseconds)

setProviderOpenRequestTimeout(int)

public void setProviderOpenRequestTimeout(int seconds)

set the timeout for a provider open request (seconds)

setProviderRetryInterval(int)

public void setProviderRetryInterval(int seconds)

set the interval at which the connection to the CTI Manager will ge retried (seconds)

setQueueSizeThreshold(int)

public void setQueueSizeThreshold(int size)

set the threshold for the event queue size to trigger alarms

setQueueStatsEnabled(boolean)

public void setQueueStatsEnabled(boolean enabled)

enable / disable event queue statistics

setRouteSelectTimeout(int)

public void setRouteSelectTimeout(int milliseconds)

set the route select timeout milliseconds

setServices(String[])

public void setServices(java.lang.String[] services)

set a list of available services

setSyslogCollector(String)

public void setSyslogCollector(java.lang.String value)

set the syslog collector hostname

setSyslogCollectorUDPPort(int)

public void setSyslogCollectorUDPPort(int port)

set the syslog collector UDP port

setTraceDirectory(String)

public void setTraceDirectory(java.lang.String dir)

set the directory where jtapi trace files should be written

setTraceFileSize(int)

public void setTraceFileSize(int val)

set the size of the trace file

setTracePath(String)

public void setTracePath(java.lang.String path)

set the directory root where jtapi traces will be written

setTraceValue(String, boolean)

public void setTraceValue(java.lang.String traceName,
boolean value)

enable or disable a particular trace

setUseAlarmService(boolean)

public void setUseAlarmService(boolean value)

enable the alarm service

setUseFileTrace(boolean)

public void setUseFileTrace(boolean value)

enable or disable jtapi log file tracing

setUseJavaConsoleTrace(boolean)

public void setUseJavaConsoleTrace(boolean value)

enable or disable jtapi console tracing

setUseSameDir(boolean)

public void setUseSameDir(boolean value)

if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a separate directory, indexed in sequence from the last directory written or available.

setUseSyslog(boolean)

public void setUseSyslog(boolean value)

enable or disable syslog tracing

CiscoJtapi Version

Declaration

public class CiscoJtapiVersion
 
java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoJtapiVersion

Description

This class gives the version information of the installed Cisco JTAPI. Programs can get the version number using the accessor methods. Cisco JTAPI Version is in a.b(x.y) format where a indicates the major version b indicates the minor version x indicates the revision number y indicates the build number

Member Summary
Constructors


Methods
 java.lang.String
Returns 'release' if it is a release version or debug if 
it is not a release version
 int
This returns the build number of the version
 int
This method returns the major version number
 int
This method returns the minor version number
 int
This method returns the revision number of the version
 java.lang.String
returns the version information in a.b(x.y) format 
without name
 java.lang.String
returns the version information in a.b(x.y) format

Inherited Member Summary
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
wait(), wait(), wait()

Constructors

CiscoJtapiVersion()

public CiscoJtapiVersion()

Methods

getBuildDescription()

public java.lang.String getBuildDescription()

Returns 'release' if it is a release version or debug if it is not a release version

getBuildNumber()

public int getBuildNumber()

This returns the build number of the version

getMajorVersion()

public int getMajorVersion()

This method returns the major version number

getMinorVersion()

public int getMinorVersion()

This method returns the minor version number

getRevisionNumber()

public int getRevisionNumber()

This method returns the revision number of the version

getVersion()

public java.lang.String getVersion()

returns the version information in a.b(x.y) format without name

toString()

public java.lang.String toString()

returns the version information in a.b(x.y) format

Overrides:

toString in class Object

CiscoMediaCapability

Declaration

public class CiscoMediaCapability
 
java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoMediaCapability

Direct Known Subclasses

CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapability, CiscoWideBandMediaCapability

Description

The CiscoMediaCapability object specifies the properties of a particular media format that an application can support for CiscoMediaTerminals that it registers. Because CiscoMediaCapability is an abstract class, applications may only construct its subclasses directly.

See Also:

CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapability, CiscoRTPBitRate, CiscoRTPPayload

Member Summary
Fields
static 
CiscoMediaCapability
G.711 capability with default parameters
static 
CiscoMediaCapability
G.723 capability with default parameters
static 
CiscoMediaCapability
G.729 capability with default parameters
static 
CiscoMediaCapability
GSM capability with default parameters
static 
CiscoMediaCapability
Wide band capability with default parameters
Constructors
 
CiscoMediaCapability(int, int), int maxFramesPerPacket)
Constructs a CiscoMediaCapability object for the 
specified payload type and packet size.
Methods
 int
Returns the packet size (in milliseconds) specified by 
this object.
 int
Returns the payload type specified by this object.
boolean
Returns whether the payload of this object gets supported 
or not.
 java.lang.String


Inherited Member Summary
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
wait(), wait(), wait()

Fields

G711_64K_30_MILLISECONDS

public static final
com.cisco.jtapi.extensions.CiscoMediaCapability 
G711_64K_30_MILLISECONDS

G.711 capability with default parameters

See Also:

CiscoG711MediaCapability

G723_6K_30_MILLISECONDS

public static final
com.cisco.jtapi.extensions.CiscoMediaCapability 
G723_6K_30_MILLISECONDS

G.723 capability with default parameters

See Also:

CiscoG723MediaCapability

G729_30_MILLISECONDS

public static final
com.cisco.jtapi.extensions.CiscoMediaCapability 
G729_30_MILLISECONDS

G.729 capability with default parameters

See Also:

CiscoG729MediaCapability

GSM_80_MILLISECONDS

public static final
com.cisco.jtapi.extensions.CiscoMediaCapability 
GSM_80_MILLISECONDS

GSM capability with default parameters

See Also:

CiscoGSMMediaCapability

WIDEBAND_256K_10_MILLISECONDS

public static final
com.cisco.jtapi.extensions.CiscoMediaCapability 
WIDEBAND_256K_10_MILLISECONDS

Wideband capability with default parameters

See Also:

CiscoWideBandMediaCapability

Constructors

CiscoMediaCapability(int, int)

public CiscoMediaCapability(int payloadType,
int maxFramesPerPacket)

Constructs a CiscoMediaCapability object for the specified payload type and packet size.

Methods

getMaxFramesPerPacket()

public int getMaxFramesPerPacket()

Returns the packet size (in milliseconds) specified by this object.

Returns:

the packet size, specified as a number of milliseconds. The MaxFramesPerPacket parameter getMaxFramesPerPacket()

public int getMaxFramesPerPacket()

Returns the packet size (in milliseconds) specified by this object.

Returns:

the packet size, specified as a number of milliseconds. The maxFramesPerPacket parameter is a carry over from the H.245 protocol definition. Cisco CallManager does not use this field as the number of frames per RTP packet, but rather as the number of milliseconds of audio per RTP packet that the device can receive. Non-Cisco IP Phones may utilize different (higher) rates even though these rates may not be exceeded to and or from Cisco IP Phones.

getPayloadType()

public int getPayloadType()

Returns the payload type specified by this object.

Returns:

a payload type from the RTPPayload interface

isSupported()

public boolean isSupported()

Returns whether the payload of this object is supported or not.

Returns:

true if the payloadType gets supported; otherwise, false.

toString()

public java.lang.String toString()

Overrides:

toString in class Object

CiscoMediaOpenLogicalChannelEv

Declaration

public interface CiscoMediaOpenLogicalChannelEv extends CiscoTermEv

All Known Subinterfaces

CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEvDescription

Description

The CiscoMediaOpenLogicalChannelEv event is sent each time when media is established for dynamically registered CiscoMediaTerminals or CiscoRouteTerminals. Upon receiving this event applications must invoke setRTPParams on CiscoMediaTerminal or CiscoRouteTerminal and pass in ipAddress and port number where to terminate media along with rtpHandle that is delivered in this event. Applications can get call reference using CiscoProvider.getCall(CiscoRTPHandle). Applications need to be aware that the far end and local end may not be able to invoke features unless setRTPParams method is invoked. If applications fail to respond to this event within specified time, the call may be disconnected.

Member Summary
Fields
static int
ID
Methods
 CiscoRTPHandle
Returns CiscoRTPHandle object.
int
Returns the packet size of the far end in milliseconds.
int
Returns the payload format of the far end, one of the 
following constants.

Fields

ID

public static final int ID

Methods

getCiscoRTPHandle()

public com.cisco.jtapi.extensions.CiscoRTPHandle 
getCiscoRTPHandle()

Returns CiscoRTPHandle object. Applications should pass this handle along with RTP Parameters to CiscoMediaTerminal or CiscoRouteTerminal. Applications can get call reference using CiscoProvider.getCall. If there is no callobserver or there was no callobserver when this event gets delivered, then CiscoProvider.getCall may return null.

Returns:

CiscoRTPHandle

See Also:

CiscoRTPParams

getPacketSize()

public int getPacketSize()

Returns the packet size of the far end in milliseconds.

Returns:

packet size, in milliseconds

getPayLoadType()

public int getPayLoadType()

Returns the payload format of the far end, one of the following constants:

CiscoRTPPayload.NONSTANDARD

CiscoRTPPayload.G711ALAW64K

CiscoRTPPayload.G711ALAW56K

CiscoRTPPayload.G711ULAW64K

CiscoRTPPayload.G711ULAW56K

CiscoRTPPayload.G722_64K

CiscoRTPPayload.G722_56K

CiscoRTPPayload.G722_48K

CiscoRTPPayload.G7231

CiscoRTPPayload.G728

CiscoRTPPayload.G729

CiscoRTPPayload.G729ANNEXA

CiscoRTPPayload.IS11172AUDIOCAP

CiscoRTPPayload.IS13818AUDIOCAP

CiscoRTPPayload.ACY_G729AASSN

CiscoRTPPayload.DATA64

CiscoRTPPayload.DATA56

CiscoRTPPayload.GSM

CiscoRTPPayload.ACTIVEVOICE

Returns:

payload type

CiscoMediaTerminal

Declaration

public interface CiscoMediaTerminal extends CiscoTerminal

All Superinterfaces

CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal

Description

A CiscoMediaTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoMediaTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoMediaTerminal is a logical telephony endpoint, which may be associated with any application that desires to terminate media. Such applications include voice mail systems, interactive voice response (IVR), and "soft" phones.


Note Only CTIPorts appear as CiscoMediaTerminals through JTAPI.


Terminating media is a two-step process. To terminate media for a particular terminal, an application adds an observer that implements the CiscoTerminalObserver interface using the Terminal.addObserver method. Finally, the application registers its IP address and port number to which the Terminal's incoming RTP streams are to be directed using the CiscoMediaTerminal.register method.

See Also:

CiscoTerminal

Member Summary
Methods
 void
Changes the default registration parameters to specified 
address and port.
 boolean
This method returns true if the CiscoMediaTerminal is 
registered and false otherwise.
 void
The CiscoMediaTerminal must be in the 
CiscoTerminal.UNREGISTERED state and its Provider must be 
in the Provider.IN_SERVICE state.
 void
Registers a Terminal with the specified address and port, 
defaulting to G.711 64KHz u-law encoding with a thirty 
millisecond packet size.
 void
The CiscoMediaTerminal must be in the 
CiscoTerminal.UNREGISTERED state and its Provider must be 
in the Provider.IN_SERVICE state.
 void
The CiscoMediaTerminal must be in the 
CiscoTerminal.UNREGISTERED state and its Provider must be 
in the Provider.IN_SERVICE state.
void
Application can set ipAddress and RTPPort number to 
dynamically stream media for a call.
 void
The CiscoMediaTerminal must be registered and its 
Provider must be in the Provider.IN_SERVICE state.

Inherited Member Summary
Fields inherited from interface CiscoTerminal
Methods inherited from interface CiscoObjectContainer
Methods inherited from interface CiscoTerminal


Methods inherited from interface Terminal
addCallObserver(CallObserver), addObserver(TerminalObserver), getAddresses(), 
getCallObservers(), getCapabilities(), getName(), getObservers(), getProvider(), 
getTerminalCapabilities(Terminal, Address), getTerminalConnections(), 
removeCallObserver(CallObserver), removeObserver(TerminalObserver)

Methods

changeRTPDefaults(InetAddress, int)

public void changeRTPDefaults(java.net.InetAddress address,
int port) 
throws CiscoRegistrationException

Changes the default registration parameters to specified address and port. Only Registered application may invoke this method.

Parameters:

address - the internet address for inbound RTP streams on this terminal

port - the UDP port for inbound RTP streams on this terminal

Throws:

CiscoRegistrationException

isRegistered()

public boolean isRegistered()

This method returns true if the CiscoMediaTerminal is registered and false otherwise.

isRegisteredByThisApp()

public boolean isRegisteredByThisApp()

This method returns true if this application issued a successful registration request. This if valid even if device is out of service because of CTIManager failure. This will be set to true until this application unregisters the device.

register(CiscoMediaCapability[], int)

public void
register(com.cisco.jtapi.extensions.CiscoMediaCapability[] 
capabilities, int failureCloseDelay) throws 
CiscoRegistrationException

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal. Registers a Terminal with specified CiscoMediaCapabilities. Indicates that application is interested in supplying ipAddress and port dynamically for each call. Applications registering with this method will receive CiscoMediaOpenLogicalChannelEv for each call and will have to supply ipAddress and port number using setRTPParams method on CiscoTerminalConnection.

Method Arguments

Arguments indicate the type of RTP encodings that the application is willing to support for this Terminal and the application or CTIManager failure persistence delay

Method Post-conditions

This method returns successfully when the CiscoMediaTerminal is registered.

Parameters:

capabilities - the list of RTP encodings supported by this terminal

failureCloseDelay - persistence delay seconds on application or CTIManager failure

Throws:

CiscoRegistrationException

See Also:

CiscoMediaOpenLogicalChannelEv

register(InetAddress, int)

public void register(java.net.InetAddress address, int port
throws CiscoRegistrationException

Deprecated.

Registers a Terminal with the specified address and port, defaulting to G.711 64KHz u-law encoding with a thirty millisecond packet size.

Parameters:

address - the internet address for inbound RTP streams on this terminal

port - the UDP port for inbound RTP streams on this terminal

Throws:

CiscoRegistrationException

register(InetAddress, int, CiscoMediaCapability[])

public void register(java.net.InetAddress address, int port,
com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities) 
throws CiscoRegistrationException

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal.

Method Arguments

This method has three arguments. The first argument specifies the internet address at which the RTP media stream for this Terminal will be terminated, the second indicates the UDP port at which RTP packets will be directed, and the final argument indicates the type of RTP encodings that the application is willing to support for this Terminal.

Method Post-conditions

This method returns successfully when the MediaTerminal is registered.

Parameters:

address - the internet address for inbound RTP streams on this terminal

port - the UDP port for inbound RTP streams on this terminal

capabilities - the list of RTP encodings supported by this terminal

Throws:

CiscoRegistrationException

register(InetAddress, int, CiscoMediaCapability[], int)

public void register(java.net.InetAddress address, int port,
com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities, 
int failureCloseDelay) throws CiscoRegistrationException

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the MediaTerminal.

Method Arguments

This method has four arguments. The first argument specifies the internet address at which the RTP media stream for this Terminal will be terminated, the second indicates the UDP port at which RTP packets will be directed, the third argument indicates the type of RTP encodings that the application is willing to support for this Terminal, and the final argument is the application or CTIManager failure persistence delay

Method Post-conditions

This method returns successfully when the MediaTerminal is registered.

Parameters:

address - the internet address for inbound RTP streams on this terminal

port - the UDP port for inbound RTP streams on this terminal

capabilities - the list of RTP encodings supported by this terminal

failureCloseDelay - persistence delay seconds on application or CTIManager failure

Throws:

CiscoRegistrationException

setRTPParams(CiscoRTPHandle, CiscoRTPParams)

public void 
setRTPParams(com.cisco.jtapi.extensions.CiscoRTPHandle0 rtpHandle, 
com.cisco.jtapi.extensions.CiscoRTPParams rtpParams)
throws InvalidStateException, InvalidArgumentException, 
PrivilegeViolationException

Applications can set ipAddress and RTP Port number to dynamically stream media for a call. In order to do this, applications will have to register MediaTerminal or CiscoRouteTeminal by providing only capabilities. Applications will have to invoke this method upon receiving CiscoCallOpenLogicalChannel on terminalObserver. Applications need to pass in rtpHandle that is received in CiscoCallOpenLogicalChannelEv. Applications can get CiscoCall reference using CiscoProvider.getRTPHandle(rtpHandle) method. This may return null if either no callobserver is added on the terminal or no callobserver at the time when this event was sent or there is no call associated with this handle.

Throws:

javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException

See Also:

CiscoRTPParams

unregister()

public void unregister()
throws CiscoUnregistrationException

The CiscoMediaTerminal must not be registered and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to unregister the MediaTerminal.

Method Post-conditions

This method returns successfully when the MediaTerminal is unregistered.

Throws:

CiscoRegistrationException

CiscoObjectContainer

Declaration

public interface CiscoObjectContainer

All Known Subinterfaces

CiscoAddress, CiscoCall, CiscoCallID, CiscoConnection, CiscoConnectionID, CiscoConsultCall, CiscoJtapiPeer, CiscoMediaTerminal, CiscoProvider, CiscoTerminal, CiscoTerminalConnection

Description

The ApplicationObject interface allows applications to associate an application defined object to objects that implement this interface.

Member Summary
Methods
 java.lang.Object
Gets the application-defined object.
 java.lang.Object
Sets an application-defined object.

Methods

getObject()

public java.lang.Object getObject()

Gets the application-defined object.

Returns:

the CallID property of this Call

setObject(Object)

public java.lang.Object setObject(java.lang.Object reference)

Sets an application-defined object.

Returns:

the CallManagerID property of this Call

CiscoOutOfServiceEv

Declaration

public interface CiscoOutOfServiceEv extends CiscoEv

All Superinterfaces

CiscoEv, javax.telephony.events.Ev

All Known Subinterfaces

CiscoAddrOutOfServiceEv, CiscoTermOutOfServiceEv

Description

The CiscoAddrOutOfServiceEv event


Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()

Fields

CAUSE_CALLMANAGER_FAILURE

public static final int CAUSE_CALLMANAGER_FAILURE

CAUSE_CTIMANAGER_FAILURE

public static final int CAUSE_CTIMANAGER_FAILURE

CAUSE_DEVICE_FAILURE

public static final int CAUSE_DEVICE_FAILURE

CAUSE_DEVICE_UNREGISTERED

public static final int CAUSE_DEVICE_UNREGISTERED

CAUSE_NOCALLMANAGER_AVAILABLE

public static final int CAUSE_NOCALLMANAGER_AVAILABLE

CAUSE_REHOME_TO_HIGHER_PRIORITY_CM

public static final int CAUSE_REHOME_TO_HIGHER_PRIORITY_CM

CAUSE_REHOMING_FAILURE

public static final int CAUSE_REHOMING_FAILURE

ID

public static final int ID

CiscoPartyInfo

Declaration

public interface CiscoPartyInfo

Description

Exposes voice mailbox fields.

Member Summary
Methods
String
Returns voice mailbox of the party.

Methods

getVoiceMailbox()

public String getVoiceMailbox()

Returns voice mailbox of the party.

CiscoProvCallParkEv

Declaration

public interface CiscoProvCallParkEv extends CiscoProvFeatureEv

All Superinterfaces

CiscoEv, CiscoProvEv, CiscoProvFeatureEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoProvCallParkEv event is delivered to the provider observer when a call is parked by any device in the cluster. To receive this event the application should register using CiscoProvider.registerFeature() and CiscoProvFeatureID.MONITOR_CALLPARK_DN. The user profile used by the application should have the "Call Park Retrieval Allowed" flag enabled to receive this event.

Member Summary
Fields
static int
ID
static int
Indicates that a call is parked
static int
Indicates that a call is unparked
static int
This event is due to call park
static int
This event is due to call park remainder
static int
This event is due to call being unparked
Methods
 int
Returns an integer representation of this object
 java.lang.String
This returns where the call is parked
 java.lang.String
This returns the DN of the parked party
 java.lang.String
This returns the DN of the parking party
 int
This returns the reason of the event.
 int
This returns the state of the call Possible states are  
CiscoProvCallParkEv.PARK_STATE_IDLE 
CiscoProvCallParkEv.PARK_STATE_ACTIVE

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface CiscoProvFeatureEv
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

PARK_STATE_ACTIVE

public static final int PARK_STATE_ACTIVE

Indicates that a call is parked

PARK_STATE_IDLE

public static final int PARK_STATE_IDLE

Indicates that a call is unparked

REASON_CALLPARK

public static final int REASON_CALLPARK

This event is due to call park

REASON_CALLPARKREMAINDER

public static final int REASON_CALLPARKREMAINDER

This event is due to call park remainder

REASON_CALLUNPARK

public static final int REASON_CALLUNPARK

This event is due to call being unparked

Methods

getintCallIDValue()

public int getintCallIDValue()

Returns an integer representation of this object

getParkDN()

public java.lang.String getParkDN()

This returns where the call is parked

getParkedParty()

public java.lang.String getParkedParty()

This returns the DN of the parked party

getParkingParty()

public java.lang.String getParkingParty()

This returns the DN of the parking party

getReason()

public int getReason()

This returns the reason of the event. Possible states include the following: CiscoProvCallParkEv.REASON_CALLPARK CiscoProvCallParkEv.REASON_CALLUNPARK CiscoProvCallParkEv.REASON_CALLPARKREMAINDER

getState()

public int getState()

This returns the state of the call Possible states include the following: CiscoProvCallParkEv.PARK_STATE_IDLE CiscoProvCallParkEv.PARK_STATE_ACTIVE

CiscoProvEv

Declaration

public interface CiscoProvEv extends CiscoEv,
javax.telephony.events.ProvEv

All Superinterfaces

CiscoEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

All Known Subinterfaces

CiscoAddrAddedToTerminalEv, CiscoAddrCreatedEv, CiscoAddrRemovedEv, CiscoProvCallParkEv, CiscoProvFeatureEv, CiscoProvFeatureUnRegisteredEv, CiscoTermCreatedEv, CiscoTermRemovedEv

Description

The CiscoProvEv interface, which extends JTAPI's core javax.telephony.events.ProvEv interface, serves as the base interface for all Cisco-extended JTAPI Provider events. Every Provider-related event in this package extends this interface, directly or indirectly.

See Also:

javax.telephony.events.ProvEv

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

CiscoProvFeatureEv

Declaration

public interface CiscoProvFeatureEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

All Known Subinterfaces

CiscoProvCallParkEv

Member Summary
Methods
 int
Feature ID for which application is interested in 
receiving events

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN


Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Methods

getFeatureID()

public int getFeatureID()

Feature ID for which application is interested in receiving events

CiscoProvFeatureID

Declaration

public interface CiscoProvFeatureID

Description

This interface lists the features supported by the registerFeature interface.

Member Summary
Fields
static int

Fields

MONITOR_CALLPARK_DN

public static final int MONITOR_CALLPARK_DN

This feature ID is used with registerFeature interface in CiscoProvider to receive CiscoProvCallParkEv when a call is parked or unparked from any device in the cluster.

CiscoProvFeatureUnRegisteredEv

Declaration

public interface CiscoProvFeatureUnRegisteredEv extends CiscoProvEv

All Superinterfaces

CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEv

Description

The CiscoProvFeatureUnRegisteredEv event This event indicates the unregistration of a particular feature by Cisco CallManager

Member Summary
Fields
static int
ID
Methods
 int
FeatureID for which application will no longer receive 
events

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface ProvEv
getProvider()

Fields

ID

public static final int ID

Methods

getFeatureID()

public int getFeatureID()

FeatureID for which application will no longer receive events

CiscoProvider

Declaration

public interface CiscoProvider extends javax.telephony.Provider,

All Superinterfaces

CiscoObjectContainer, javax.telephony.Provider

Description

Member Summary
Methods
CiscoTerminal
Returns an instance of the CiscoTerminal class which 
corresponds to the given name.
 void
Deletes an unused call created by createCall().
void
Removes the CiscoTerminal Ojbect from providers control.
CiscoCall
Returns call object with the rtpHandle associated with a 
specific terminal.
 boolean
Returns the current state of the callback guard feature
 CiscoMediaTerminal
Returns an instance of the CiscoMediaTerminal class which 
corresponds to the given name.
 CiscoMediaTerminal[]
Returns an array of CiscoMediaTerminals associated with 
the Provider and within the Provider's domain.
 java.lang.String
Returns the current version of provider running if 
provider is in service otherwise it will return empty 
string
 void
used to register for a particular feature for which 
application will get Provider events.
 void
Enables or disables try/catch logic for observer 
callbacks 
 void
used to unregister a particular feature.

Inherited Member Summary
Fields inherited from interface Provider
IN_SERVICE, OUT_OF_SERVICE, SHUTDOWN
Methods inherited from interface CiscoObjectContainer




Methods inherited from interface Provider
addObserver(ProviderObserver), createCall(), getAddress(String), 
getAddressCapabilities(Terminal), getAddressCapabilities(Terminal), getAddresses(), 
getCallCapabilities(Terminal, Address), getCallCapabilities(Terminal, Address), 
getCalls(), getCapabilities(), getConnectionCapabilities(Terminal, Address), 
getConnectionCapabilities(Terminal, Address), getName(), getObservers(), 
getProviderCapabilities(Terminal), getProviderCapabilities(Terminal), getState(), 
getTerminal(String), getTerminalCapabilities(Terminal), 
getTerminalCapabilities(Terminal), getTerminalConnectionCapabilities(Terminal), 
getTerminalConnectionCapabilities(Terminal), getTerminals(), 
removeObserver(ProviderObserver), shutdown()

Methods

createTerminal(java.lang.String name)

CiscoTerminal createTerminal(java.lang.String name)

Returns an instance of the CiscoTerminal class which corresponds to the given name.

deleteCall(Call)

public void deleteCall(javax.telephony.Call call
throws InvalidStateException

Deletes an unused call created by createCall(). An exception is generated if the call is not in IDLE state or if provider is not in Provider.IN_SERVICE state. Applications may use this interface to move un used calls to INVALID state and reclaim resources allocated to the call.

Pre-conditions:

1. this.getState() == Provider.IN_SERVICE

2. call.getState() == Call.IDLE

Post-conditions:

1. call.getState() == Call.INVALID

Throws:

javax.telephony.InvalidStateException

deleteTerminal(com.cisco.jtapi.extensions.CiscoTerminal terminal)

void deleteTerminal(com.cisco.jtapi.extensions.CistoTerminal 
terminal)

Removes the CiscoTerminal Ojbect from providers control.

getCall(CiscoRTPHandle)

public com.cisco.jtapi.extensions.CiscoCall0 
getCall(com.cisco.jtapi.extensions.CiscoRTPHandle rtpHandle)
throws InvalidStateException

Returns call object with the rtpHandle associated with a specific terminal. This method may return null if this rtpHandle is no longer associated with any call or if there was no callObserver added on the terminal at the time when CiscoCallOpenLogicalChannelEv which contained this handle gets sent to applications.

Throws:

javax.telephony.InvalidStateException

getCallbackGuardEnabled()

public boolean getCallbackGuardEnabled()

Returns the current state of the callback guard feature

Returns:

the current state of the callback guard feature

getMediaTerminal(String)

public com.cisco.jtapi.extensions.CiscoMediaTerminal
getMediaTerminal(java.lang.String name 
throws InvalidArgumentException

Returns an instance of the CiscoMediaTerminal class which corresponds to the given name. Each CiscoMediaTerminal has a unique name associated with it, which is assigned to it by the JTAPI implementation. If no CiscoMediaTerminal is available for the given name within the Provider's domain, this method throws the InvalidArgumentException. This CiscoMediaTerminal is contained in the arrays generated by Provider.getTerminals() and CiscoProvider.getMediaTerminals().

Pre-conditions:

1. Let CiscoMediaTerminal terminal = this.getMediaTerminal(name);

2. terminal is an element of this.getTerminals();

3. terminal is an element of this.getMediaTerminals();

Post-conditions:

1. Let CiscoMediaTerminal terminal = this.getMediaTerminal(name);

2. terminal is an element of this.getTerminals();

3. terminal is an element of this.getMediaTerminals();

Parameters:

name - The name of desired CiscoMediaTerminal object.

Returns:

The CiscoMediaTerminal object associated with the given name.

Throws:

javax.telephony.InvalidArgumentException - The name provided does not correspond to a name of any CiscoMediaTerminal known to the Provider or within the Provider's domain.

getMediaTerminals()

public com.cisco.jtapi.extensions.CiscoMediaTerminal[]
getMediaTerminals()
throws ResourceUnavailableException

Returns an array of CiscoMediaTerminals associated with the Provider and within the Provider's domain. Each CiscoMediaTerminal possesses a unique name, which is assigned to it by the JTAPI implementation. If there are no CiscoMediaTerminals associated with this Provider, then this method returns null. This array is a subset of the array returned by Provider.getTerminals().

Post-conditions:

1. Let CiscoMediaTerminal[] terminals = this.getMediaTerminals()

2. terminals == null or terminals.length >= 1

3. if terminals != null, terminals is a subset of this.getTerminals ()

Returns:

An array of Terminals in the Provider's local domain.

Throws:

javax.telephony.ResourceUnavailableException - Indicates the number of media terminals present in the Provider is too great to return as a static array.

getVersion()

public java.lang.String getVersion()

Returns the current version of provider running if provider is in service otherwise it will return empty string

registerFeature(int)

public void registerFeature(int featureID)
throws InvalidStateException, PrivilegeViolationException, Inva
lidArgumentException

used to register for a particular feature for which application will get Provider events. Applications should pass in the featureID of the softkey. Current supported features are listed in CiscoProvFeatureID interface

Throws:

javax.telephony.InvalidArgumentException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidStateException

setCallbackGuardEnabled(boolean)

public void setCallbackGuardEnabled(boolean enabled)

Enables or disables try/catch logic for observer callbacks

In order to protect itself from application exceptions in observer callbacks, the Provider normally guards all invocations of application interfaces (e.g. observers) with the following code:

try { 
  
 observer.callStateChanged ( ... ); 
  
 } catch ( Throwable t ) { 
 // log the exception here 
 }  

This isolates application errors from the JTAPI implementation, allowing easier troubleshooting, since the JTAPI implementation can note the unhandled exception and continue operating. Some errors are considered non-recoverable and will be re-thrown by JTAPI, generally resulting in application exit. Such errors include ThreadDeath, OutOfMemoryError, and StackOverflowError. Applications wishing to trap errors within JTAPI threads should create a subclass of ThreadGroup and initialize JTAPI from a thread within that ThreadGroup. By overriding the ThreadGroup.uncaughtException () method, the application can be made aware of all unrecoverable errors thrown on JTAPI threads.

In some cases, JTAPI aggressive error-catching approach may make it more difficult to troubleshoot applications within a java debugger. Microsoft Visual J++ version 6.0, for example, does not handle breakpoints within application observer callbacks properly if JTAPI catches Throwable. In such cases, JTAPI application developers may choose to disable the internal JTAPI try/catch logic.


Note Disabling callback guards in this manner is only intended for use while troubleshooting applications, and never for use in production environments. By default, callback guards are always enabled.


Parameters:

enabled - if true, callback guard will be enabled; if false, callback guard will be disabled

unregisterFeature(int)

public void unregisterFeature(int featureID)
throws InvalidStateException

used to unregister a particular feature. Provider events for the feature will stop after unregistering the feature

Throws:

javax.telephony.InvalidStateException

CiscoProviderCapabilities

Declaration

public interface CiscoProviderCapabilities extends
javax.telephony.capabilities.ProviderCapabilities

All Superinterfaces

javax.telephony.capabilities.ProviderCapabilities

Description

This interface defines the specific capabilities offered by the Cisco JTAPI implementation.

Member Summary
Methods
boolean
Enables a user to be provisioned in the Directory to be 
able to observe any terminal (and its addresses) in the 
system.

Inherited Member Summary
Methods inherited from interface ProviderCapabilities
isObservable()

Methods

canObserveAnyTerminal()

boolean canOberveAnyTerminal()

Enables a user to be provisioned in the Directory to be able to observe any Terminal (and its addresses) in the system.

CiscoProviderObserver

Declaration

public interface CiscoProviderObserver extends
javax.telephony.ProviderObserver

All Superinterfaces

javax.telephony.ProviderObserver

Description

Applications implement this interface in order to receive CiscoProvEv events such as CiscoAddrCreatedEv and CiscoTermCreatedEv when observing a Provider via the Provider.addObserver method.

See Also:

CiscoAddrCreatedEv, CiscoTermCreatedEv

Inherited Member Summary
Methods inherited from interface ProviderObserver
providerChangedEvent(ProvEv[])

CiscoRegistrationException

Declaration

public class CiscoRegistrationException extends java.lang.Exception
 
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.cisco.jtapi.extensions.CiscoRegistrationEx
ception

All Implemented Interfaces

java.io.Serializable

Description

The CiscoMediaTerminal.register method throws this exception when the registration process fails for any reason. For example, registration would fail if the Provider were OUT_OF_SERVICE or if the device were already registered.

See Also:

CiscoMediaTerminal.register(InetAddress, int, CiscoMediaCapability[])


Inherited Member Summary
Methods inherited from class Object
clone(), equals(Object), finalize(), getClass(), hashCode(), notify(), notifyAll(), 
wait(), wait(), wait()
Methods inherited from class Throwable
fillInStackTrace(), getLocalizedMessage(), getMessage(), printStackTrace(PrintWriter), 
printStackTrace(PrintWriter), printStackTrace(PrintWriter), toString()

Constructors

CiscoRegistrationException()

public CiscoRegistrationException()

CiscoRegistrationException(String)

public CiscoRegistrationException(java.lang.String description)

CiscoRouteAddress

Declaration

public interface CiscoRouteAddress extends
javax.telephony.callcenter.RouteAddress

All Superinterfaces

javax.telephony.Address, javax.telephony.callcenter.RouteAddress

Member Summary
Methods
void

Inherited Member Summary
Fields inherited from interface RouteAddress
ALL_ROUTE_ADDRESS


Methods inherited from interface Address
addCallObserver(CallObserver), addObserver(AddressObserver), 
getAddressCapabilities(Terminal), getCallObservers(), getCapabilities(), 
getConnections(), getName(), getObservers(), getProvider(), getTerminals(), 
removeCallObserver(CallObserver), removeObserver(AddressObserver)
Methods inherited from interface RouteAddress
cancelRouteCallback(RouteCallback), getActiveRouteSessions(), getRouteCallback(), 
registerRouteCallback(RouteCallback)

Methods

registerRouteCallback(RouteCallback, boolean)

public void 
registerRouteCallback(javax.telephony.callcenter.RouteCallback
routeCallback, 
boolean disableAutoRehoming)throws ResourceUnavailableException
, MethodNotSupportedException

Throws:

javax.telephony.MethodNotSupportedException, javax.telephony.ResourceUnavailableException

CiscoRouteSession

Declaration

public interface CiscoRouteSession extends
javax.telephony.callcenter.RouteSession

All Superinterfaces

javax.telephony.callcenter.RouteSession

Description

The CiscoRouteSession supports application access to underlying call associated with a RouteSession. Also, various internal ERRORs where endRoute is called internally are exposed to the application, should they wish to handle endRouteEvent() in any special way for these cases.

See Also:

javax.telephony.Call

Member Summary
Fields
static int
This indicates that the redirect should be done using the 
search space of the calling address.
static int
This indicates that the redirect should be done using the 
search space that is the default for the implementation.
static int
This is a parameter for PreferedOriginalCalledOpotion. It 
specifies not to reset the OriginalCalled.
static int
If an internal InvalidStateException occurred or some 
preconditions/post-conditions were not met during routing 
endRoute is called with this ERROR_INVALID_STATE error.
static int
For now, since there is no default route mechanism in 
place, if there is no callback registered for this app, 
an endRoute with this error is called.
static int
ERRORS defined for internal successful endRoute call.
static int
Each routeEvent()/reRouteEvent() sent starts a timer for 
the app to respond with a routeSelect()/ endRoute().
static int
A parameter value for PreferedOriginalCalledOption. If 
the value of preferedOriginalCalledOption gets set to 
this, it resets OriginalCalled to 
preferedOriginalCalledNumber.
static int
This indicates that the redirect should be done using the 
search space of the route point address.
Methods
 javax.telephony.Call
Returns the call associated with this RouteSession.
 void
This method overloads the selectRoute method in the 
RouteSession interface to allow applications to specify a 
calling search space to be used when the call is 
redirected to the route destination.
void
Selects one or more possible destinations for the routing 
of the Call with modifying calling number.
void
Selects one or more possible destinations for the routing 
of the Call.

Inherited Member Summary
Fields inherited from interface RouteSession
CAUSE_INVALID_DESTINATION, CAUSE_NO_ERROR, CAUSE_PARAMETER_NOT_SUPPORTED, 
CAUSE_ROUTING_TIMER_EXPIRED, CAUSE_STATE_INCOMPATIBLE, CAUSE_UNSPECIFIED_ERROR, 
ERROR_RESOURCE_BUSY, ERROR_RESOURCE_OUT_OF_SERVICE, ERROR_UNKNOWN, RE_ROUTE, ROUTE, 
ROUTE_CALLBACK_ENDED, ROUTE_END, ROUTE_USED
Methods inherited from interface RouteSession
endRoute(int), getCause(), getRouteAddress(), getState(), selectRoute(String[])

Fields

CALLINGADDRESS_SEARCH_SPACE

public static final int CALLINGADDRESS_SEARCH_SPACE

This indicates that the redirect should be done using the search space of the calling address.

DEFAULT_SEARCH_SPACE

public static final int DEFAULT_SEARCH_SPACE

This indicates that the redirect should be done using the search space that is the default for the implementation. The default is to use the caller's search space.

DONOT_RESET_ORIGINALCALLED

public static final int DONOT_RESET_ORIGINALCALLED

This could be parameter value for PreferedOriginalCalled Option, it specifies not to reset OriginalCalled

ERROR_INVALID_STATE

public static final int ERROR_INVALID_STATE

If an internal InvalidStateException occurred or some preconditions/postconditions were not met during routing endRoute is called with this ERROR_INVALID_STATE error.

ERROR_NO_CALLBACK

public static final int ERROR_NO_CALLBACK

For now, since there is no default route mechanism in place, if there is no callback registered for this app, an endRoute with this error is called.

ERROR_NONE

public static final int ERROR_NONE

ERRORS defined for internal successful endRoute call. Error value set for no error.

ERROR_ROUTESELECT_TIMEOUT

public static final int ERROR_ROUTESELECT_TIMEOUT

Each routeEvent()/reRouteEvent() sent starts a timer for the app to respond with a routeSelect()/ endRoute(). The default value of this timer is 5secs. Should the application not respond within this time, an endRoute is called with this error = ERROR_ROUTESELECT_TIMOUT

RESET_ORIGINALCALLED

public static final int RESET_ORIGINALCALLED

This could be parameter value for PreferedOriginalCalled Option, it value of preferedOriginalCalledOption is set to this, it will reset OriginalCalled to preferedOriginalCalledNumber

ROUTEADDRESS_SEARCH_SPACE

public static final int ROUTEADDRESS_SEARCH_SPACE

This indicates that the redirect should be done using the search space of the route point address.

Methods

getCall()

public javax.telephony.Call getCall()

Returns the call associated with this RouteSession.

Returns:

the call associated with this RouteSession

selectRoute(String[], int)

public void selectRoute(java.lang.String[] routeSelected,
int callingSearchSpace) 
throws MethodNotSupportedException

This method overloads the selectRoute method in the RouteSession interface to allow applications to specify a calling search space to be used when the call is redirected to the route destination.

The callingSearchSpace parameter may be:

1. CiscoRouteSession.DEFAULT_SEARCH_SPACE

2. CiscoRouteSession.CALLINGADDRESS_SEARCH_SPACE

3. CiscoRouteSession.ROUTEADDRESS_SEARCH_SPACE

Throws:

javax.telephony.MethodNotSupportedException

selectRoute(String[], int, String[])

public void selectRoute(java.lang.String[] routeSelected, int 
callingSearchSpace, java.lang.String[] modifyingCallingNumber)
throws PrivilegeViolationException, MethodNotSupportedException

Selects one or more possible destinations for the routing of the Call with modifying calling number. This method takes an array of string destination telephone address names, modifying calling numbers in priority order. The highest priority destination is the first element in the given array, and routing is attempted with this destination first with the corresponding element of modifying calling number. If modifiedCallingNumber is null for an element, the calling number is not modified, if a call is routed to that particular routeSelected element.

Successive given destination addresses are attempted until one is found which does not fail. A RouteUsedEvent event is delivered to the application when a successful routing destination has been selected and the Call has been routed to that destination. Pre-conditions: this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE or RouteSession.RE_ROUTE Post-Conditions this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE_USED if Call was successfully routed. RouteUsedEvent is delivered for this RouteSession if a successful destination was selected.

Parameters:

routeSelected - A list of possible destinations for the call.

Throws:

MethodNotSupportedExceptionImpl - Routing is not supported by the implementation. The callingSearchSpace parameter may be:

CiscoRouteSession.DEFAULT_SEARCH_SPACE

CiscoRouteSession.CALLINGADDRESS_SEARCH_SPACE

CiscoRouteSession.ROUTEADDRESS_SEARCH_SPACE

The modifiedCallingNumber may be an array of elements for which application would like to modify the calling number when call reaches routeselected element.

javax.telephony.MethodNotSupportedException, javax.telephony.PrivilegeViolationException

selectRoute(String[], int, String[], int[])

public void selectRoute(java.lang.String[] routeSelected, int 
callingSearchSpace, java.lang.String[] 
preferedOriginalCalledNumber, int[] preferedOrignalCalledOption)
throws PrivilegeViolationException, MethodNotSupportedException

Selects one or more possible destinations for the routing of the Call. This method takes an array of string destination telephone address names, in prioritized order and array of string for PreferredOriginalCalled number. PreferedOriginalCalled number will be selected corresponding to index of destination telephone name Array. If index corresponding to destination array is not found in PreferedOriginalCalled number array then preferedOriginalCalled preferedOriginalCalled will be set to destination.

The highest priority destination is the first element in the given array, and routing is attempted with this destination first. Successive given destination addresses are attempted until one is found which does not fail. A RouteUsedEvent event is delivered to the application when a successful routing destination has been selected and the Call has been routed to that destination.

Pre-conditions:

this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE or RouteSession.RE_ROUTE Post-Conditions this.getRouteAddress().getProvider().getState() == Provider.IN_SERVICE this.getState() == RouteSession.ROUTE_USED if Call was successfully routed. RouteUsedEvent is delivered for this RouteSession if a successful destination was selected.

Parameters:

routeSelected - A list of possible destinations for the call.

preferedOriginalCalledOption - A list of option each corresponding to RouteList, this option specifies whether to set OriginalCalled to preferedOriginalCalledNumber. This takes value CiscoRouteSession.DONOT_RESET_ORIGINALCALLED, CiscoRouteSession.RESET_ORIGINALCALLED. If value is not specified or it is null then, JTAPI will default it to CiscoRouteSession.DONOT_RESET_ORIGINALCALLED

Throws:

MethodNotSupportedExceptionImpl - Routing is not supported by the implementation.

javax.telephony.MethodNotSupportedException, javax.telephony.PrivilegeViolationException

CiscoRouteTerminal

Declaration

public interface CiscoRouteTerminal extends CiscoTerminal

All Superinterfaces

CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal

Description

A CiscoRouteTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoRouteTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoRouteTerminal is a logical telephony endpoint, which may be associated with any application that desires to route calls and also terminate media. Unlike CiscoMediaTerminal, CiscoRouteTerminal can have multiple active calls at the same time. Typically, CiscoRouteTerminals will be used to put callers in queue until an agent is available to service the caller.


Note Only RoutePoint Terminals appear as CiscoRouteTerminal through JTAPI.


Terminating media is a three-step process.

1. Application registers its media capabilities with this terminal using CiscoRouteTerminal.register method.

2. An application adds an observer that implements CiscoTerminalObserver interface using the Terminal.addObserver method.

3. Application will either registerRouteCallBack on RouteAddress associated with this terminal or addCallObserver on CiscoRouteTerminal.

Applications will receive CiscoMediaOpenLogicalChannelEv for each call and will have to supply ipAddress and port number using setRTPParams method on CiscoTerminalConnection.


Note For no media termination, all applications written for or prior to CiscoJtapiClient 1.4(x) release need to be modified to register with NO_MEDIA_TERMINATION.


Multiple applications can register with same RoutePoint as long as they are registered with same media capabilities and registrationType. All applications if registered with CiscoRouteTerminal.DYNAMIC_MEDIA_REGISTRATION and adds callObserver will receive CiscoMediaOpenLogicalChannelEv but only one application will be able to invoke setRTPParams.

CiscoRouteTerminals can also be registered with a delayed close. On an application or CTIManager failure the CallManager persists the CiscoRouteTerminal resource for the duration of the delay. This allows a back-up application to recover the route point and take over the call control for it. Calls that are in an ACCEPTED or CONNECTED state will remain and the back-up application's CallObserver will be delivered existing call notifications.

See Also:

CiscoTerminal

Member Summary
Fields
static int
Applications that are interested in media termination 
need to register with this type and pass in capabilities 
that it supports in registration request.
static int
Applications that are not interested in media termination 
need to register with this type and pass in null value 
for CiscoMediaCapability in the registration request
Methods
 boolean
This method returns true only if the CiscoRouteTerminal 
is registered
 boolean
This method returns true if this application issued a 
successful registration request.
 void
The CiscoRouteTerminal must be in the 
CiscoTerminal.UNREGISTERED state and its Provider must be 
in the Provider.IN_SERVICE state
void
Applications can set ipAddress and RTP port number to 
dynamically stream media for a call.
void
The CiscoRouteTerminal must be registered and its 
Provider must be in the Provider.IN_SERVICE state

Inherited Member Summary
Fields inherited from interface CiscoTerminal
IN_SERVICE, OUT_OF_SERVICE
Methods inherited from interface CiscoObjectContainer
getObject(), setObject(Object)
Methods inherited from interface CiscoTerminal
getFilter(), getRTPInputProperties(), getRTPOutputProperties(), getRegistrationState(), 
getState(), sendData(byte[]), sendData(byte[]), setFilter(CiscoTermEvFilter), 
unPark(Address, String)
Methods inherited from interface Terminal
addCallObserver(CallObserver), addObserver(TerminalObserver), getAddresses(), 
getCallObservers(), getCapabilities(), getName(), getObservers(), getProvider(), 
getTerminalCapabilities(Terminal, Address), getTerminalConnections(), 
removeCallObserver(CallObserver), removeObserver(TerminalObserver)

Fields

DYNAMIC_MEDIA_REGISTRATION

public static final int DYNAMIC_MEDIA_REGISTRATION

Applications that are interested in media termination need to register with this type and pass in capabilities that it supports in registration request.

NO_MEDIA_REGISTRATION

public static final int NO_MEDIA_REGISTRATION

Applications that are not interested in media termination need to register with this type and pass in null value for CiscoMediaCapability in the registration request.

Methods

isRegistered()

public boolean isRegistered()

This method returns true only if the CiscoRouteTerminal is registered and false otherwise. If RouteTerminal is OutOfService, this returns false and if it is InService, it returns true. For CTIManager failure cases, this is false.

isRegisteredByThisApp()

public boolean isRegisteredByThisApp()

This method returns true if this application issued a successful registration request. This if valid even if device is out of service because of CTIManager failure. This will be set to true until this application unregisters the device.

register(CiscoMediaCapability[], int, int)

public void 
register(com.cisco.jtapi.extensions.CiscoMediaCapability[] 
capabilities, int registrationType, int failureCloseDelay)
throws CiscoRegistrationException

The CiscoRouteTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to register the RouteTerminal. Registers a Terminal with specified CiscoMediaCapabilities and register type.

1. If registrationType is CiscoRouteTerminal.NO_MEDIA_REGISTRATION, application cannot terminate media and can use route point for call routing purpose.

2. If registration Type is CiscoRouteTerminal.DYNAMIC_MEDIA_REGISTRATION, then app can terminate media and can have multiple active calls. This Indicates that application is interested in supplying ipAddress and port dynamically for each call. Applications registering with this type will receive CiscoMediaOpenLogicalChannelEv for each call and will have to supply ipAddress and port number using setRTPParams method on CiscoTerminalConnection.

Method Arguments

Capabilities:

1. indicates the type of RTP encodings that the application is willing to support for this Terminal. If application is not interested in media termination, it may pass in null value

Possible RegistrationTypes:

1. CiscoRouteTerminal.NO_MEDIA_REGISTRATION

2. CiscoRouteTerminal.DYNAMIC_MEDIA_REGISTRATION

FailureCloseDelay:

1. A value indicating the number of seconds the persistence is desired.

Method Post-conditions

This method returns successfully when the CiscoRouteTerminal is registered.

Parameters:

capabilities - the list of RTP encodings supported by this terminal

registrationType - CiscoRouteTerminal.DYNAMIC_MEDIA_REGISTRATION or CiscoRouteTerminal.NO_MEDIA_REGISTRATION

failureCloseDelay - persistence delay seconds on application or CTIManager failure

setRTPParams(CiscoRTPHandle, CiscoRTPParams)

public void 
setRTPParams(com.cisco.jtapi.extensions.CiscoRTPHandle0 rtpHandle, 
com.cisco.jtapi.extensions.CiscoRTPParams0 rtpParams)
throws InvalidStateException, InvalidArgumentException, 
PrivilegeViolationException

Applications can set ipAddress and RTP Port number to dynamically stream media for a call. In order to do this, applications will have to register MediaTerminal or CiscoRouteTeminal by providing only capabilities. Applications will have to invoke this method upon receiving CiscoCallOpenLogicalChannel on terminalObserver. Applications need to pass in rtpHandle that is received in CiscoCallOpenLogicalChannelEv

Throws:

javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException

See Also:

CiscoRTPParams, CiscoMediaOpenLogicalChannelEv

unregister()

public void unregister()
throws CiscoUnregistrationException

The CiscoRouteTerminal must be registered and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to unregister the RouteTerminal.

Method Post-conditions

This method returns successfully when the MediaTerminal is unregistered.

Throws:

CiscoUnregistrationException

CiscoRouteUsedEvent

Declaration

public interface CiscoRouteUsedEvent extends
javax.telephony.callcenter.events.RouteUsedEvent

All Superinterfaces

javax.telephony.callcenter.events.RouteSessionEvent

javax.telephony.callcenter.events.RouteUsedEvent

Description

The CiscoRouteUsedEvent event interface indicates the RouteSession interface has moved into the RouteSession.ROUTE_USED state and the Call has terminated at a destination as a result of routing by the application. This interface extends the RouteUsedEvent interface and is reported via the RouteCallback interface.

Member Summary
Methods
int
This method returns an array index of route where the 
call has been routed.

Inherited Member Summary
Fields inherited from interface RouteSessionEvent
getRouteSession()
Methods inherited from interface RouteUsedEvent
getCallingAddress(), getCallingTerminal(), getDomain(), getRouteUsed()

Methods

getRouteSelectedIndex()

public int getRouteSelectedIndex()

This method returns an array index of route where the call has been routed.

CiscoRTPBitRate

Declaration

public interface CiscoRTPBitRate

Description

The RTPBitRate interface contains constants describing G.723 RTP bit rates. These constants are returned by the CiscoRTPInputProperties.getBitRate method and the CiscoRTPOutputProperties.getBitRate method.

See Also:

CiscoRTPInputProperties.getBitRate(), CiscoRTPOutputProperties.getBitRate()

Member Summary
Fields
static int
5.3k G.723 bit rate
static int
6.4k G.723 bit rate

Fields

R5_3

public static final int R5_3

5.3k G.723 bit rate

R6_4

public static final int R6_4

6.4k G.723 bit rate

CiscoRTPHandle

Declaration

public interface CiscoRTPHandle

Description

The CiscoRTPHandle is returned in CiscoMediaCallOpenLogicalChannelEv and applications should pass this handle in setRTPParams of CiscoMediaTerminal or CiscoRouteTerminal depending on where CiscoMediaCallOpenLogicalChannelEv is received. Applications can use this object to get call reference using CiscoProvider.getCall(CiscoRTPHandle). However, if there is no callobserver added or there was no callobserver added at the time when CiscoMediaCallOpen LogicalChannelEv is sent, CiscoProvider.getCall(CiscoRTPHandle) may return null method.

Member Summary
Methods
 int
Returns the media bit rate, one of the following 
constants: 

Methods

getHandle()

public int getHandle()

Returns an integer representation of this object, currently the CallManager CallLeg ID of the call.

Returns:

an integer representation of this object

CiscoRTPInputProperties

Declaration

public interface CiscoRTPInputProperties

Description

Member Summary
Methods
 int
Returns the media bit rate, one of the following 
constants: 
 boolean
 java.net.InetAddress
 int
 int
 int
Returns the payload format, one of the following 
constants: 

Methods

getBitRate()

public int getBitRate()

Returns the media bit rate, one of the following constants:

· CiscoRTPBitRate.R5_3
· CiscoRTPBitRate.R6_4

Returns:

payload type

getEchoCancellation()

public boolean getEchoCancellation()

Returns:

echo cancellation

getLocalAddress()

public java.net.InetAddress getLocalAddress()

Returns:

address to which media will be directed

getLocalPort()

public int getLocalPort()

Returns:

port to which media will be directed

getPacketSize()

public int getPacketSize()

Returns:

packet size, in milliseconds

getPayloadType()

public int getPayloadType()

Returns the payload format, one of the following constants:

· CiscoRTPPayload.NONSTANDARD
· CiscoRTPPayload.G711ALAW64K
· CiscoRTPPayload.G711ALAW56K
· CiscoRTPPayload.G711ULAW64K
· CiscoRTPPayload.G711ULAW56K
· CiscoRTPPayload.G722_64K
· CiscoRTPPayload.G722_56K
· CiscoRTPPayload.G722_48K
· CiscoRTPPayload.G7231
· CiscoRTPPayload.G728
· CiscoRTPPayload.G729
· CiscoRTPPayload.G729ANNEXA
· CiscoRTPPayload.IS11172AUDIOCAP
· CiscoRTPPayload.IS13818AUDIOCAP
· CiscoRTPPayload.ACY_G729AASSN
· CiscoRTPPayload.DATA64
· CiscoRTPPayload.DATA56
· CiscoRTPPayload.GSM
· CiscoRTPPayload.ACTIVEVOICE

Returns:

payload type

CiscoRTPInputStartedEv

Declaration

public interface CiscoRTPInputStartedEv extends CiscoEv

All Superinterfaces

CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv

Description

Member Summary
Fields
static int
ID
Methods
 CiscoCallID
returns CiscoCallID
 CiscoRTPInputProperties

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN


Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface TermEv
getTerminal()

Fields

ID

public static final int ID

Methods

getCallID()

public com.cisco.jtapi.extensions.CiscoCallID getCallID()

returns CiscoCallID

getRTPInputProperties()

public com.cisco.jtapi.extensions.CiscoRTPInputProperties
getRTPInputProperties()

Returns:

RTP input properties

CiscoRTPInputStoppedEv

Declaration

public interface CiscoRTPInputStoppedEv extends CiscoTermEv

All Superinterfaces

CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv

Description

Member Summary
Fields
static int
ID
Methods
 CiscoCallID
returns CiscoCallID

Inherited Member Summary
Fields inherited from interface Ev
CAUSE_CALL_CANCELLED, CAUSE_DEST_NOT_OBTAINABLE, CAUSE_INCOMPATIBLE_DESTINATION, 
CAUSE_LOCKOUT, CAUSE_NETWORK_CONGESTION, CAUSE_NETWORK_NOT_OBTAINABLE, CAUSE_NEW_CALL, 
CAUSE_NORMAL, CAUSE_RESOURCES_NOT_AVAILABLE, CAUSE_SNAPSHOT, CAUSE_UNKNOWN, 
META_CALL_ADDITIONAL_PARTY, META_CALL_ENDING, META_CALL_MERGING, META_CALL_PROGRESS, 
META_CALL_REMOVING_PARTY, META_CALL_STARTING, META_CALL_TRANSFERRING, META_SNAPSHOT, 
META_UNKNOWN
Methods inherited from interface Ev
getCause(), getID(), getMetaCode(), getObserved(), isNewMetaEvent()
Methods inherited from interface TermEv
getTerminal()

Fields

ID

public static final int ID

Methods

getCallID()

public com.cisco.jtapi.extensions.CiscoCallID getCallID()

returns CiscoCallID

CiscoRTPOutputProperties

Declaration

public interface CiscoRTPOutputProperties

Description

Member Summary
Methods
 int
Returns the media bit rate, one of the following 
constants: 
 int
 int
 int
Returns the payload format, one of the following 
constants: 
 int
 java.net.InetAddress
 int
 boolean

Methods

getBitRate()

public int getBitRate()

Returns the media bit rate, one of the following constants:

· CiscoRTPBitRate.R5_3
· CiscoRTPBitRate.R6_4

Returns:

payload type

getMaxFramesPerPacket()

public int getMaxFramesPerPacket()

Returns:

the maximum number of frames to send per packet

getPacketSize()

public int getPacketSize()

Returns:

packet size, in milliseconds

getPayloadType()

public int getPayloadType()

Returns the payload format, one of the following constants:

· CiscoRTPPayload.NONSTANDARD
· CiscoRTPPayload.G711ALAW64K
· CiscoRTPPayload.G711ALAW56K
· CiscoRTPPayload.G711ULAW64K
· CiscoRTPPayload.G711ULAW56K