Cisco CallManager 3.0 JTAPI Developer Guide
Cisco JTAPI Extensions
Downloads: This chapterpdf (PDF - 663.0KB) The complete bookPDF (PDF - 2.06MB) | Feedback

Cisco JTAPI Extensions

Table Of Contents

Cisco JTAPI Extensions

Introduction

Cisco JTAPI Extensions Hierarchy

Class Hierarchy

Interface Hierarchy

Class com.cisco.jtapi.extensions

Cisco JTAPI Extension Classes

CiscoG711MediaCapability

Interface Declaration

Description

Variable Index

Constructor Index

Variable Detail

Constructor Detail

CiscoG723MediaCapability

Interface Declaration

Description

Variable Index

Constructor Index

Method Index

Variable Detail

Constructor Detail

Method Detail

Cisco G729 Media Capability

Description

Field Index

Constructor Index

Variable Detail

Constructor Detail

CiscoGSMMediaCapability

Interface Declaration

Description

Variable Index

Constructor Index

Variable Detail

Constructor Detail

CiscoMediaCapability

Interface Declaration

Description

Variable Index

Constructor Index

Method Index

Variable Detail

Constructor Detail

Method Detail

CiscoRegistrationException

Interface Declaration

Description

Constructor Index

Constructor Detail

CiscoUnregistrationException

Interface Declaration

Description

Constructor Index

Constructor Detail

Interface com.cisco.jtapi.extensions

Cisco JTAPI Extension Interfaces

CiscoAddrCreatedEv

Interface Declaration

Description

Variable Index

Method Index

Variable Details

Method Details

CiscoAddress

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoAddressObserver

Interface Declaration

Description

CiscoAddrEv

Interface Declaration

Description

CiscoAddrInServiceEv

Interface Declaration

Description

Variable Index

Variable Detail

CiscoAddrOutOfServiceEv

Interface Declaration

Description

Variable Index

Variable Detail

CiscoCall

Interface Declaration

Description

Method Index

Method Detail

CiscoCallEv

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoCallID

Interface Declaration

Description

Method Index

Method Detail

CiscoConferenceEndEv

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoConferenceStartEv

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoConnection

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoConnectionID

Interface Declaration

Description

Method Index

Method Detail

CiscoConsultCall

Interface Declaration

Description

Method Index

Method Detail

CiscoConsultCallActiveEv

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoEv

Interface Declaration

Description

CiscoJtapiPeer

Interface Declaration

Description

CiscoMediaCapability

Interface Declaration

Description

Variable Index

Constructor Index

Method Index

Variable Detail

Constructor Detail

Method Detail

CiscoMediaTerminal

Interface Declaration

Description

Method Index

Method Detail

CiscoObjectContainer

Interface Declaration

Description

Method Index

Method Detail

CiscoProvEv

Interface Declaration

Description

CiscoProvider

Interface Declaration

Description

Method Index

Method Detail

CiscoProviderObserver

Interface Declaration

Description

CiscoRegistrationException

Interface Declaration

Description

Constructor Index

Constructor Detail

CiscoRouteSession

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoRTPBitRate

Interface Declaration

Description

Variable Index

Variable Detail

CiscoRTPInputProperties

Interface Declaration

Method Index

Method Detail

CiscoRTPInputStartedEv

Interface Declaration

Variable Index

Method Index

Variable Detail

Method Detail

CiscoRTPInputStoppedEv

Interface Declaration

Variable Index

Variable Detail

CiscoRTPOutputProperties

Interface Declaration

Method Index

Method Detail

CiscoRTPOutputStartedEv

Interface Declaration

Variable Index

Method Index

Variable Detail

Method Detail

CiscoRTPOutputStoppedEv

Interface Declaration

Variable Index

Variable Detail

CiscoRTPPayload

Interface Declaration

Description

Field Index

Field Detail

CiscoSynchronousObserver

Interface Declaration

Description

CiscoTelephonyException

Interface Declaration

Description

Field Index

Method Index

Field Detail

Method Detail

CiscoTermCreatedEv

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoTermEv

Interface Declaration

Description

CiscoTerminal

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoTerminalConnection

Interface Declaration

Description

CiscoTerminalObserver

Interface Declaration

Description

CiscoTermInServiceEv

Interface Declaration

Description

Variable Index

Variable Detail

CiscoTermOutOfServiceEv

Interface Declaration

Description

Variable Index

Variable Detail

CiscoTransferEndEv

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail

CiscoTransferStartEv

Interface Declaration

Description

Variable Index

Method Index

Variable Detail

Method Detail


Cisco JTAPI Extensions


Introduction

The Cisco JTAPI implementation 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. Use these interfaces and classes with the standard JTAPI interfaces and classes described in the Cisco JTAPI v 1.2 Specification manual to create new applications.

This chapter contains the following sections:

Cisco JTAPI Extensions Hierarchy

Class com.cisco.jtapi.extensions

Interface com.cisco.jtapi.extensions

Cisco JTAPI Extensions Hierarchy

Class Hierarchy

class java.lang.Object

class com.cisco.jtapi.extensions.CiscoMediaCapability

class com.cisco.jtapi.extensions.CiscoG711MediaCapability

class com.cisco.jtapi.extensions.CiscoG723MediaCapability

class com.cisco.jtapi.extensions.CiscoG729 Media Capability

class com.cisco.jtapi.extensions.CiscoGSMMediaCapability

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

class java.lang.Exception

class com.cisco.jtapi.extensions.CiscoRegistrationException

class com.cisco.jtapi.extensions.CiscoUnregistrationException

Interface Hierarchy

interface javax.telephony.Address

interface com.cisco.jtapi.extensions.CiscoAddress(also

extendscom.cisco.jtapi.extensions.CiscoObjectContainer)

interface javax.telephony.AddressObserver

interface com.cisco.jtapi.extensions.CiscoAddressObserver

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.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.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 com.cisco.jtapi.extensions.CiscoTelephonyException

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

interface javax.telephony.events.CallEv

interface javax.telephony.events.CallActiveEv

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

extends com.cisco.jtapi.extensions.CiscoCallEv)

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.CiscoProvEv(also extends javax.telephony.events.ProvEv)

interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv

interface com.cisco.jtapi.extensions.CiscoTermCreatedEv

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.CiscoTermInServiceEv

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv

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.CiscoTermCreatedEv

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.CiscoTermInServiceEv

interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv

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.ProviderObserver

interface com.cisco.jtapi.extensions.CiscoProviderObserver

interface javax.telephony.callcenter.RouteSession

interface com.cisco.jtapi.extensions.CiscoRouteSession

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.TraceModule

interface com.cisco.jtapi.extensions.CiscoJtapiPeer(also extends

com.cisco.jtapi.extensions.CiscoObjectContainer, javax.telephony.JtapiPeer)

Class com.cisco.jtapi.extensions

Cisco JTAPI Extension Classes

Table 2-1 Cisco JTAPI extension classes and their methods

Cisco Extension Classes
Method Names

CiscoG711MediaCapability

 

CiscoG723MediaCapability

getBitRate()

toString()

Cisco G729 Media Capability

 

CiscoGSMMediaCapability

 

CiscoMediaCapability

getMaxFramesPerPacket()

getPayloadType()

toString()

CiscoRegistrationException

 

CiscoUnregistrationException

 

CiscoG711MediaCapability

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

public class CiscoG711MediaCapability
extends CiscoMediaCapability

Interface Declaration

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 30 milliseconds.

Variable Index

FRAMESIZE_SIXTY_MILLISECOND_PACKET 

The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET 

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET 

The frames-per-packet value for 20 millisecond packets

Fields inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, 
GSM_80_MILLISECONDS

Constructor Index

CiscoG711MediaCapability()

Constructs a CiscoG711MediaCapability

CiscoG711MediaCapability(int) 

Constructs a CiscoG711MediaCapability

Methods inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Variable Detail

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET

The frames-per-packet value for 20 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET

The frames-per-packet value for 60 millisecond packets

Constructor Detail

CiscoG711MediaCapability

public CiscoG711MediaCapability(int maxFramesPerPacket)

Constructs a CiscoG711MediaCapability

CiscoG711MediaCapability

public CiscoG711MediaCapability()

Constructs a CiscoG711MediaCapability

CiscoG723MediaCapability

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

public class CiscoG723MediaCapability 
extends CiscoMediaCapability

Interface Declaration

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 30 milliseconds and the default bit rate is 6.4k.

Variable Index

FRAMESIZE_SIXTY_MILLISECOND_PACKET 

The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET 

The frames-per-packet value for 20 millisecond packets

Constructor Index

CiscoG723MediaCapability() 

Constructs a CiscoG723MediaCapability

CiscoG723MediaCapability(int, int) 

Constructs a CiscoG723MediaCapability

Fields inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, 
GSM_80_MILLISECONDS

Method Index

getBitRate()

Returns the bit rate specified by this capability object.

toString()

Methods inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Variable Detail

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET

The frames-per-packet value for 20 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET

The frames-per-packet value for 60 millisecond packets

Constructor Detail

CiscoG723MediaCapability

public CiscoG723MediaCapability(int maxFramesPerPacket, int bitRate)

Constructs a CiscoG723MediaCapability

CiscoG723MediaCapability

public CiscoG723MediaCapability()

Constructs a CiscoG723MediaCapability

Method Detail

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

Cisco G729 Media Capability

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

public class CiscoG729MediaCapability
extends CiscoMediaCapability

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 30 milliseconds.

Field Index

FRAMESIZE_SIXTY_MILLISECOND_PACKET 

The frames-per-packet value for 60 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET 

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_TWENTY_MILLISECOND_PACKET 

The frames-per-packet value for 20 millisecond packets

Fields inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, 
GSM_80_MILLISECONDS

Constructor Index

CiscoG729MediaCapability() 

Constructs a CiscoG729MediaCapability

CiscoG729MediaCapability(int payload, int maxFramesPerPacket) 

Constructs a CiscoG729MediaCapability

Methods inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Variable Detail

FRAMESIZE_TWENTY_MILLISECOND_PACKET

public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKET

The frames-per-packet value for 20 millisecond packets

FRAMESIZE_THIRTY_MILLISECOND_PACKET

public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

FRAMESIZE_SIXTY_MILLISECOND_PACKET

public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKET

The frames-per-packet value for 60 millisecond packets

Constructor Detail

CiscoG729MediaCapability

public CiscoG729MediaCapability(int payload, int maxFramesPerPacket)

Constructs a CiscoG729MediaCapability

CiscoG729MediaCapability

public CiscoG729MediaCapability()

Constructs a CiscoG729MediaCapability

CiscoGSMMediaCapability

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

public class CiscoGSMMediaCapability 
extends CiscoMediaCapability

Interface Declaration

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 30 milliseconds.

Variable Index

FRAMESIZE_EIGHTY_MILLISECOND_PACKET 

The frames-per-packet value for 30 millisecond packets

Fields inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

G711_64K_30_MILLISECONDS, G723_6K_30_MILLISECONDS, G729_30_MILLISECONDS, 
GSM_80_MILLISECONDS

Constructor Index

CiscoGSMMediaCapability() 

Constructs a CiscoG711MediaCapability

CiscoGSMMediaCapability(int maxFramesPerPacket) 

Constructs a CiscoGSMMediaCapability

Methods inherited from class com.cisco.jtapi.extensions.CiscoMediaCapability

getMaxFramesPerPacket, getPayloadType, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Variable Detail

FRAMESIZE_EIGHTY_MILLISECOND_PACKET

public static final int FRAMESIZE_EIGHTY_MILLISECOND_PACKET

The frames-per-packet value for 30 millisecond packets

Constructor Detail

CiscoGSMMediaCapability

public CiscoGSMMediaCapability(int maxFramesPerPacket)

Constructs a CiscoGSMMediaCapability

CiscoGSMMediaCapability

public CiscoGSMMediaCapability()

Constructs a CiscoGSMMediaCapability

CiscoMediaCapability

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

public class CiscoMediaCapability 
extends java.lang.Object

Interface Declaration

CiscoMediaCapability

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

Cisco RTPBitRate

Cisco RTPPayload

Variable Index

G711_64K_30_MILLISECONDS

G.711 capability with default parameters

G723_6K_30_MILLISECONDS

G.723 capability with default parameters

G729_30_MILLISECONDS 

G.729 capability with default parameters

GSM_80_MILLISECONDS 

GSM capability with default parameters

Constructor Index

CiscoMediaCapability(int, int)

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

Method Index

getMaxFramesPerPacket()

Returns the packet size specified by this object.

getPayloadType() 

Returns the payload type specified by this object.

toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Variable Detail

G711_64K_30_MILLISECONDS

public static final CiscoMediaCapability G711_64K_30_MILLISECONDS

G.711 capability with default parameters

See Also

CiscoG711MediaCapability

G723_6K_30_MILLISECONDS

public static final CiscoMediaCapability G723_6K_30_MILLISECONDS

G.723 capability with default parameters

See Also

CiscoG723MediaCapability

G729_30_MILLISECONDS

public static final CiscoMediaCapability GG729_30_MILLISECONDS

G729_30_MILLISECONDS

G.729 capability with default parameters

GSM_80_MILLISECONDS

public static final CiscoMediaCapability GSM_80_MILLISECONDS

GSM capability with default parameters

See Also

CiscoGSMMediaCapability

Constructor Detail

CiscoMediaCapability

public CiscoMediaCapability(int payloadType, int maxFramesPerPacket)

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

Method Detail

getPayloadType

public int getPayloadType()

Returns the payload type specified by this object.

Returns

a payload type from the RTPPayload interface

getMaxFramesPerPacket

public int getMaxFramesPerPacket()

Returns the packet size specified by this object.

Returns

the packet size, specified as a the number of frames within a single packet

toString

public java.lang.String toString()
Overrides

toString in class java.lang.Object

CiscoRegistrationException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.cisco.jtapi.extensions.RegistrationException

public class CiscoRegistrationException
extends java.lang.Exception

Interface Declaration

CiscoRegistrationException

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(java.net.InetAddress, int, com.cisco.jtapi.extensions.CiscoMediaCapability[])

Constructor Index

CiscoRegistrationException()

CiscoRegistrationException(String)

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace,
printStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CiscoRegistrationException

public CiscoRegistrationException()

CiscoRegistrationException

public CiscoRegistrationException(String description)

CiscoUnregistrationException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.cisco.jtapi.extensions.CiscoUnregistrationException

public class CiscoUnregistrationException
extends java.lang.Exception

Interface Declaration

CiscoUnregistrationException

Description

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

See Also

unregister

Constructor Index

CiscoUnregistrationException() 

CiscoUnregistrationException(String) 

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace,
printStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CiscoUnregistrationException

public CiscoUnregistrationException()

CiscoUnregistrationException

public CiscoUnregistrationException(String description)

Interface com.cisco.jtapi.extensions

Cisco JTAPI Extension Interfaces

Table 2-2 Cisco JTAPI Extension Interfaces and Their Methods 

Cisco Extension Interfaces
Method Names

CiscoAddrCreatedEv

getAddress()

CiscoAddress

getRegistrationState()

getState()

getType()

CiscoAddressObserver

None.

CiscoAddrEv

None.

CiscoAddrInServiceEv

None.

CiscoAddrOutOfServiceEv

None.

CiscoCall

getCallID()

CiscoCallEv

getCiscoCause()

CiscoCallID

getCall()

intValue()

CiscoConferenceEndEv

getConferenceCall()

getConferenceControllerAddress()

getFinalCall()

getHeldConferenceController()

getTalkingConferenceController()

CiscoConferenceStartEv

getConferenceCall()

getConferenceControllerAddress()

getFinalCall()

getHeldConferenceController()

getTalkingConferenceController()

CiscoConnection

getConnectionID()

getredirect

getredirect

getReason()

CiscoConnectionID

getConnection()

intValue()

CiscoConsultCall

getConsultingTerminalConnection()

CiscoConsultCallActiveEv

getHeldTerminalConnection()

CiscoEv

None.

CiscoJtapiPeer

None.

CiscoMediaTerminal

isRegistered()

register(InetAddress, int)

register(InetAddress, int)

unregister()

CiscoObjectContainer

getObject()

setObject()

CiscoProvEv

None.

CiscoProvider

getCallbackGuardEnabled()

getMediaTerminal()

getMediaTerminals()

setCallbackGuardEnabled()

CiscoProviderObserver

None.

CiscoRouteSession

getCall()

selectRoute(String[] routeSelected, int)

CiscoRTPBitRate

None.

CiscoRTPInputProperties

getBitRate()

getEchoCancellation()

getLocalAddress()

getLocalPort()

getPacketSize()

getPayloadType()

CiscoRTPInputStartedEv

getRTPInputProperties()

CiscoRTPInputStoppedEv

None.

CiscoRTPOutputProperties

getBitRate()

getMaxFramesPerPacket()

getPacketSize()

getPayloadType()

getPrecedenceValue()

getRemoteAddress()

getRemotePort()

getSilenceSuppression()

CiscoRTPOutputStartedEv

getRTPOutputProperties()

CiscoRTPOutputStoppedEv

None.

CiscoRTPPayload

None.

CiscoSynchronousObserver

None.

CiscoTermCreatedEv

getTerminal()

CiscoTermEv

None.

CiscoTerminal

getRegistrationState()

getRTPInputProperties()

getRTPOutputProperties()

getState()

CiscoTerminalConnection

None.

CiscoTerminalObserver

None.

CiscoTermInServiceEv

None.

CiscoTermOutOfServiceEv

None.

CiscoTransferEndEv

getFinalCall()

getTransferController()

getTransferControllerAddress()

getTransferredCall()

CiscoTransferStartEv

getFinalCall()

getTransferController()

getTransferControllerAddress()

getTransferredCall()


CiscoAddrCreatedEv

public interface CiscoAddrCreatedEv
extends CiscoProvEv

Interface Declaration

CiscoAddrCreatedEv

Description

The CiscoAddrCreatedEv event.

Variable Index

ID 

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getAddress() 

Methods inherited from interface javax.telephony.events.ProvEv

getProvider

Variable Details

ID

public static final int ID

Method Details

getAddress

public abstract Address getAddress()

CiscoAddress

public interface CiscoAddress
extends javax.telephony.Address, ObjectContainer

Interface Declaration

CiscoAddress

Description

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

See Also

javax.telephony.Address

Variable Index

EXTERNAL 

This is an external address with a valid name.

EXTERNAL_UNKNOWN 

This is an external address with an unknown name.

IN_SERVICE 

The address is out-of-service.

INTERNAL 

This is an internal address.

OUT_OF_SERVICE 

The address is in-service.

UNKNOWN 

This is an external address with an unknown name.

Method Index

getRegistrationState() 

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

getState() 

Returns the state of this address.

getType() 

Returns the type of this address.

Methods inherited from interface javax.telephony.Address

addCallObserver, addObserver, getAddressCapabilities, getCallObservers, getCapabilities,
getConnections, getName, getObservers, getProvider, getTerminals, removeCallObserver,
removeObserver

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Variable Detail

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

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.

Method Detail

getRegistrationState

public abstract int getRegistrationState()

getState

public int getState()
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()
The type may be any of the following constants

CiscoAddress.INTERNAL

CiscoAddress.EXTERNAL

CiscoAddress.EXTERNAL_UNKNOWN

CiscoAddress.UNKNOWN

Returns

The type of address

CiscoAddressObserver

public interface CiscoAddressObserver 
extends javax.telephony.AddressObserver

Interface Declaration

CiscoAddressObserver

Description

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

Methods inherited from interface javax.telephony.AddressObserver

addressChangedEvent

See Also

CiscoAddrInServiceEv

CiscoAddrOutOfServiceEv

CiscoAddrEv

public interface CiscoAddrEv
extends javax.events.AddrEv, CiscoEv

Interface Declaration

CiscoAddrEv

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.

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.AddrEv

getAddress

See Also

AddrEv

CiscoAddrInServiceEv

public interface CiscoAddrInServiceEv 
extends CiscoAddrEv

Interface Declaration

CiscoAddrInServiceEv

Description

The CiscoAddrInServiceEv event

Variable Index

ID

Fields inherited from interface javax.telephony.events.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 

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.AddrEv

getAddress

Variable Detail

ID

public static final int ID

CiscoAddrOutOfServiceEv

public interface CiscoAddrOutOfServiceEv 
extends CiscoAddrEv

Interface Declaration

CiscoAddrOutOfServiceEv

Description

The CiscoAddrOutOfServiceEv event

Variable Index

ID

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.AddrEv

getAddress

Variable Detail

ID

public static final int ID

CiscoCall

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

Interface Declaration

CiscoCall

Description

The CiscoCall interface extends the CallControlCall interface with additional Cisco 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 Cisco 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.

Fields inherited from interface javax.telephony.Call

ACTIVE, IDLE, INVALID

See Also

Call

Method Index

getCallID() 

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

Methods inherited from interface javax.telephony.callcontrol.CallControlCall

addParty, conference, consult, consult, drop, getCalledAddress, getCallingAddress,
getCallingTerminal, getConferenceController, getConferenceEnable, 
getLastRedirectedAddress,getTransferController, getTransferEnable, offHook, 
setConferenceController, setConferenceEnable, setTransferController, setTransferEnable, 
transfer, transfer

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Methods inherited from interface javax.telephony.Call

addObserver, connect, getCallCapabilities, getCapabilities, getConnections, getObservers, 
getProvider, getState, removeObserver

Method Detail

getCallID

public abstract int getCallID()

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

Returns

The CallID property of this Call

CiscoCallEv

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

Interface Declaration

CiscoCallEv

Description

The CiscoCallEv interface, which extends JTAPI's core javax.telephony.events.Ev 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

CallEv

Variable Index

CAUSE_ACCESSINFORMATIONDISCARDED 
CAUSE_BCBPRESENTLYAVAIL 
CAUSE_BCNAUTHORIZED 
CAUSE_BEARERCAPNIMPL 
CAUSE_CALLBEINGDELIVERED 
CAUSE_CALLIDINUSE 
CAUSE_CALLREJECTED 
CAUSE_CALLSPLIT 
CAUSE_CHANTYPENIMPL 
CAUSE_CHANUNACCEPTABLE 
CAUSE_DESTINATIONOUTOFORDER 
CAUSE_DESTNUMMISSANDDCNOTSUB 
CAUSE_FACILITYREJECTED 
CAUSE_IDENTIFIEDCHANDOESNOTEXIST 
CAUSE_IENIMPL 
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_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 javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getCiscoCause()

Returns the Cisco CallManager cause for this event.

Methods inherited from interface javax.telephony.events.CallEv

getCall

Variable Detail

CAUSE_ACCESSINFORMATIONDISCARDED

public static final int CAUSE_ACCESSINFORMATIONDISCARDED 

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_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_DESTNUMMISSANDDCNOTSUB

public static final int CAUSE_DESTNUMMISSANDDCNOTSUB 

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_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_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

Method Detail

getCiscoCause

public int getCiscoCause()

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 Cisco CallManager cause for this event

CiscoCallID

public interface CiscoCallID
extends ObjectContainer

Interface Declaration

CiscoCallID

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.

Method Index

getCall()
intValue() 

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

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Method Detail

getCall

public CiscoCall getCall()

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)

CiscoConferenceEndEv

public interface CiscoConferenceEndEv 
extends CiscoCallEv

Interface Declaration

CiscoConferenceEndEv

Description

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

Variable Index

ID

Fields inherited from interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, 
CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLREJECTED, 
CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, 
CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, 
CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, 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_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 javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getConferenceControllerAddress() 

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

getConferencedCall()

Returns the call that has been merged.

getFinalCall() 

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

getHeldConferenceController() 

Returns the TerminalConnection which currently acts as the conference controller for this call —the final call.

getTalkingConferenceController()

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

Methods inherited from interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause

Methods inherited from interface javax.telephony.events.CallEv

getCall

Variable Detail

ID

public static final int ID

Method Detail

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.

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. It is the Terminal Connection that was in held state when conference was initiated.

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 conference controller (terminal connection) that was in talking state.

CiscoConferenceStartEv

public interface CiscoConferenceStartEv 
extends CiscoCallEv

Interface Declaration

CiscoConferenceStartEv

Description

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

Variable Index

ID

Fields inherited from interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED,
CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLREJECTED,
CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, 
CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, 
CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, 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_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 javax.telephony.events.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 

Fields inherited from interface javax.telephony.events.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

Method Index

getConferenceControllerAddress() 

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

getConferencedCall()

Returns the call that has been conferenced.

getFinalCall() 

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

getHeldConferenceController() 

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

getTalkingConferenceController()

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

Methods inherited from interface com.cisco.jtapi.extensions.CiscoCallEv

getCiscoCause

Methods inherited from interface javax.telephony.events.CallEv

getCall

Variable Detail

ID

public static final int ID

Method Detail

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

getFinalCall

public javax.telephony.Call getFinalCall()

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

getHeldConferenceController

public javax.telephony.TerminalConnection getHeldConferenceController()

Returns the TerminalConnection which currently acts as the conference controller for this call —the initiating call. This is the conference controller (terminal connection) that was in held state.

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 conference controller (terminal connection) that was in talking state.

CiscoConnection

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

Interface Declaration

CiscoConnection

Description

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

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

Variable Index

ADDRESS_SEARCH_SPACE 

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

CALLINGADDRESS_SEARCH_SPACE 

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

DEFAULT_SEARCH_SPACE 

This indicates that the redirect should be done using the search space that is the default for the implementation.

REASON_DIRECTCALL 

This connection was the result of a direct call.

REASON_FORWARDALL 

This connection was the result of unconditional forwarding.

REASON_FORWARDBUSY 

This connection was the result of a forwarding on busy.

REASON_FORWARDNOANSWER 

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

REASON_OUTBOUND 

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

REASON_REDIRECT 

This connection was the result of a redirection.

REASON_TRANSFERREDCALL 

This connection was the result of a transfer.

REDIRECT_DROP_ON_FAILURE 

This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination.

REDIRECT_NORMAL 

This redirect mode instructs the implementation to perform redirect if the destination is valid and available.

Fields inherited from interface javax.telephony.callcontrol.CallControlConnection

ALERTING, DIALING, DISCONNECTED, ESTABLISHED, FAILED, IDLE, INITIATED, NETWORK_ALERTING,
NETWORK_REACHED, OFFERED, OFFERING, QUEUED, UNKNOWN

Fields inherited from interface javax.telephony.Connection

ALERTING, CONNECTED, DISCONNECTED, FAILED, IDLE, INPROGRESS, UNKNOWN

Method Index

getConnectionID() 

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

getReason() 

Returns the reason for the creation of this connection.

redirect(java.lang.String destinationAddress, int mode) 

This method overloads the CallControlConnection.redirect() method.

redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace) 

This method overloads the CallControlConnection.redirect() method.

Methods inherited from interface javax.telephony.callcontrol.CallControlConnection

accept, addToAddress, getCallControlState, park, redirect, reject

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Methods inherited from interface javax.telephony.Connection

disconnect, getAddress, getCall, getCapabilities, getConnectionCapabilities, getState, 
getTerminalConnections

Variable Detail

REASON_DIRECTCALL

public static final int REASON_DIRECTCALL

This connection was the result of a direct call.

REASON_TRANSFERREDCALL

public static final int REASON_TRANSFERREDCALL

This connection was the result of a transfer.

REASON_FORWARDNOANSWER

public static final int REASON_FORWARDNOANSWER

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

REASON_FORWARDBUSY

public static final int REASON_FORWARDBUSY

This connection was the result of a forwarding on busy.

REASON_FORWARDALL

public static final int REASON_FORWARDALL

This connection was the result of unconditional forwarding.

REASON_REDIRECT

public static final int REASON_REDIRECT

This connection was the result of a redirection.

REASON_OUTBOUND

public static final int REASON_OUTBOUND

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

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 is 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.

Method Detail

getConnectionID

public CiscoConnectionID getConnectionID()

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

Returns

the CallID property of this Call

getReason

public abstract int getReason()

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's 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_OUTBOUND

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

Returns

The reason for the creation of this connection

redirect

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

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.

redirect

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

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

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.


CiscoConnectionID

public interface CiscoConnectionID

Interface Declaration

CiscoConnectionID

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.

Method Index

getConnection() 
intValue()

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

Method Detail

intValue

public int intValue()

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

getConnection

public CiscoConnection getConnection()

CiscoConsultCall

public interface CiscoConsultCall
extends CiscoCall

Interface Declaration

CiscoConsultCall

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.

Fields inherited from interface javax.telephony.Call

ACTIVE, IDLE, INVALID

See Also

Call

Method Index

getConsultingTerminalConnection() 

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

Methods inherited from interface javax.telephony.callcontrol.CallControlCall

addParty, conference, consult, consult, drop, getCalledAddress, getCallingAddress, 
getCallingTerminal, getConferenceController, getConferenceEnable, 
getLastRedirectedAddress, getTransferController, getTransferEnable, offHook, 
setConferenceController, setConferenceEnable, setTransferController, setTransferEnable, 
transfer, transfer

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Methods inherited from interface javax.telephony.Call

addObserver, connect, getCallCapabilities, getCapabilities, getConnections, getObservers, 
getProvider, getState, removeObserver

Method Detail

getConsultingTerminalConnection

public abstract 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

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

Interface Declaration

CiscoConsultCallActiveEv

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

Call

CallObserver

CallActiveEv

Variable Index

ID 
Fields inherited from interface com.cisco.jtapi.extensions.CiscoCallEv
CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, 
CAUSE_BCNAUTHORIZED,CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, 
CAUSE_CALLREJECTED,CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, 
CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, 
CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, 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_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 javax.telephony.events.CallActiveEv

ID

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getHeldTerminalConnection() 

Deprecated. replaced by CiscoConsultCall.getConsultingTerminalConnection ()

Variable Detail

ID

public static final int ID

Method Detail

getHeldTerminalConnection

public abstract TerminalConnection getHeldTerminalConnection()

Note getHeldTerminalConnection() is deprecated. It is 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 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

public interface CiscoEv
extends javax.telephony.events.Ev

Interface Declaration

CiscoEv

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.

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.Ev

getCause, getID, getMetaCode, getObserved, isNewMetaEvent

See Also

Ev

CiscoJtapiPeer

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

Interface Declaration

CiscoJtapiPeer

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.

Methods inherited from interface com.cisco.services.tracing.TraceModule

getTraceManager, getTraceModuleName

Methods inherited from interface javax.telephony.JtapiPeer

getName, getProvider, getServices

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

See Also

TraceModule

CiscoMediaCapability

java.lang.Object
  |
  +--com.cisco.jtapi.extensions.CiscoMediaCapability
Direct Known Subclasses: 
CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, 
CiscoGSMMediaCapability 

public class CiscoMediaCapability
extends java.lang.Object

Interface Declaration

CiscoMediaCapability

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

Variable Index

G711_64K_30_MILLISECONDS 

G.711 capability with default parameters

G723_6K_30_MILLISECONDS 

G.723 capability with default parameters

G729_30_MILLISECONDS 

G.729 capability with default parameters

GSM_80_MILLISECONDS 

GSM capability with default parameters

Constructor Index

CiscoMediaCapability(int payloadType, int maxFramesPerPacket) 

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

Method Index

getMaxFramesPerPacket() 

Returns the packet size specified by this object.

getPayloadType() 

Returns the payload type specified by this object.

toString() 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait.

Variable Detail

G711_64K_30_MILLISECONDS

public static final CiscoMediaCapability G711_64K_30_MILLISECONDS

G.711 capability with default parameters

See Also

CiscoG711MediaCapability

G723_6K_30_MILLISECONDS

public static final CiscoMediaCapability G723_6K_30_MILLISECONDS

G.723 capability with default parameters

See Also

CiscoG723MediaCapability

G729_30_MILLISECONDS

public static final CiscoMediaCapability G729_30_MILLISECONDS

G.729 capability with default parameters

See Also

CiscoG729MediaCapability

GSM_80_MILLISECONDS

public static final CiscoMediaCapability GSM_80_MILLISECONDS

GSM capability with default parameters

See Also

CiscoGSMMediaCapability

Constructor Detail

CiscoMediaCapability

public CiscoMediaCapability(int payloadType, int maxFramesPerPacket)

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

Method Detail

getPayloadType

public int getPayloadType()
Returns

A payload type from the RTPPayload interface

getMaxFramesPerPacket

public int getMaxFramesPerPacket()
Returns

The packet size, specified as the number of frames within a single packet.

toString

public java.lang.String toString()
Overrides

toString in class java.lang.Object

CiscoMediaTerminal

public interface CiscoMediaTerminal
extends CiscoTerminal

Interface Declaration

CiscoMediaTerminal

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 JTAPI Ports will 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

Method Index

isRegistered

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

register(InetAddress, int) 

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state. Deprecated.

register(InetAddress, int, CiscoMediaCapability[]) 

The CiscoMediaTerminal must be in the CiscoTerminal.UNREGISTERED state and its Provider must be in the Provider.IN_SERVICE state.

unregister() 

The CiscoMediaTerminal must be in the CiscoTerminal.REGISTERED state and its Provider must be in the Provider.IN_SERVICE state.

Methods inherited from interface com.cisco.jtapi.extensions.CiscoTerminal

getRegistrationState, getRTPInputProperties, getRTPOutputProperties, getState

Methods inherited from interface javax.telephony.Terminal

addCallObserver, addObserver, getAddresses, getCallObservers, getCapabilities, getName, 
getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, 
removeCallObserver, removeObserver

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Method Detail

isRegistered

public boolean isRegistered()

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

register

public void register(java.net.InetAddress address, int port, CiscoMediaCapability[] 
capabilities) throws RegistrationException

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

register

public abstract void register(InetAddress address, int port) throws RegistrationException

Note register() is deprecated.


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. Deprecated

Arguments:

This method has two arguments. The first argument specifies the internet address at which the RTP media stream for this Terminal will be terminated, and the second indicates the UDP port at which RTP packets will be directed.

Post-condition:

This method returns successfully when the MediaTerminal is registered.

unregister

public abstract void unregister() throws UnregistrationException

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

Post-conditions:

This method returns successfully when the MediaTerminal is unregistered.

CiscoObjectContainer

public interface CiscoObjectContainer

Interface Declaration

CiscoObjectContainer

Description

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

Method Index

getObject()

Gets the application-defined object.

setObject(Object) 

Sets an application-defined object.

Method Detail

setObject

public java.lang.Object setObject(Object reference)

Sets an application-defined object.

Returns

the CallManagerID property of this Call

getObject

public java.lang.Object getObject()

Gets the application-defined object.

Returns

the CallID property of this Call

CiscoProvEv

public interface CiscoProvEv
extends javax.events.ProvEv, CiscoEv

Interface Declaration

CiscoProvEv

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.Prov

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.ProvEv

 getProviderProv 

CiscoProvider

public interface CiscoProvider
extends javax.telephony.Provider, ObjectContainer

Interface Declaration

CiscoProvider

Description

Fields inherited from interface javax.telephony.Provider

IN_SERVICE, OUT_OF_SERVICE, SHUTDOWN

Method Index

getCallbackGuardEnabled() 

Returns the current state of the callback guard feature

getMediaTerminal(String) 

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

getMediaTerminals() 

Returns an array of CiscoMediaTerminals associated with the Provider and within the Provider's domain.

setCallbackGuardEnabled(boolean) 

Enables or disables try/catch logic for observer callbacks

Methods inherited from interface javax.telephony.Provider

addObserver, createCall, getAddress, getAddressCapabilities, getAddressCapabilities,
getAddresses, getCallCapabilities, getCallCapabilities, getCalls, getCapabilities,
getConnectionCapabilities, getConnectionCapabilities, getName, getObservers,
getProviderCapabilities, getProviderCapabilities, getState, getTerminal,
etTerminalCapabilities, getTerminalCapabilities, getTerminalConnectionCapabilities,
getTerminalConnectionCapabilities, getTerminals, removeObserver, shutdown

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Method Detail

setCallbackGuardEnabled

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.

In some cases, JTAPI's 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

getCallbackGuardEnabled

public boolean getCallbackGuardEnabled()

Returns the current state of the callback guard feature.

getMediaTerminals

public CiscoMediaTerminal[] getMediaTerminals() throws 
javax.telephony.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:

Let CiscoMediaTerminal[] terminals = this.getMediaTerminals()

terminals == null or terminals.length >= 1

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.

getMediaTerminal

public CiscoMediaTerminal getMediaTerminal(java.lang.String name) throws 
javax.telephony.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

Let CiscoMediaTerminal terminal = this.getMediaTerminal(name).

terminal is an element of this.getTerminals().

terminal is an element of this.getMediaTerminals().

Post-conditions

Let CiscoMediaTerminal terminal = this.getMediaTerminal(name).

terminal is an element of this.getTerminals().

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.

CiscoProviderObserver

public interface CiscoProviderObserver
extends javax.telephony.ProviderObserver

Interface Declaration

CiscoProviderObserver

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.

Methods inherited from interface javax.telephony.ProviderObserver

providerChangedEvent

See Also

CiscoAddrCreatedEv

CiscoTermCreatedEv

CiscoRegistrationException

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

Interface Declaration

CiscoRegistrationException

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(java.net.InetAddress, int, com.cisco.jtapi.extensions.CiscoMediaCapability[]), Serialized Form

Constructor Index

CiscoRegistrationException() 
CiscoRegistrationException(java.lang.String description) 

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, 
printStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CiscoRegistrationException

public CiscoRegistrationException()

CiscoRegistrationException

public CiscoRegistrationException(java.lang.String description)

CiscoRouteSession

public interface CiscoRouteSession
extends javax.telephony.callcenter.RouteSession

Interface Declaration

CiscoRouteSession

Description

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

JTAPI handles an endRoute(int validError) on a RouteSession by accepting the call, if the errorValue is a valid error. If Forward No Answer is configured on the RouteAddress, an endRoute(int validError) causes the call to be redirected to this default address.


Note This release does not handle calls to invalid addresses passed through javax.telephony.callcenter.RouteSession.selectRoute(String[] routeAddresses), here, routeAddresses is an array of addresses to which the call can be routed. The addresses are provided by the application. The first address in the array must be a valid address either in or outside the provider's domain. The RouteSession state machine can only be used for routing to a correct address.


See Also

Call

Variable Index

The following errors are exposed to applications via CiscorouteSession solely for debugging purposes. An application can debug a RouteEndEvent that has been triggered in the Callback if required:

CALLINGADDRESS_SEARCH_SPACE 

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

DEFAULT_SEARCH_SPACE 

This indicates that the redirect should be done using the search space that is the default for the implementation.

ERROR_INVALID_STATE 

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

ERROR_NO_CALLBACK 

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

ERROR_NONE 

ERRORS defined for internal successful endRoute call.

ERROR_ROUTESELECT_TIMEOUT 

Each routeEvent()/reRouteEvent() sent starts a timer for the application to respond with a routeSelect()/ endRoute().

ROUTEADDRESS_SEARCH_SPACE 

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

Fields inherited from interface javax.telephony.callcenter.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

Method Index

getCall() 

Returns the call associated with this RouteSession

selectRoute(java.lang.String[] routeSelected, int callingSearchSpace) 

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.

Methods inherited from interface javax.telephony.callcenter.RouteSession

endRoute, getCause, getRouteAddress, getState, selectRoute

Variable Detail

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.

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.

ERROR_INVALID_STATE

public static final int ERROR_INVALID_STATE

If an internal InvalidStateException occurred or some preconditions/post conditions 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 application, 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 application 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

Method Detail

getCall

public abstract Call getCall()

Returns the call associated with this RouteSession

selectRoute

public void selectRoute(java.lang.String[] routeSelected, int callingSearchSpace)
throws javax.telephony.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

CiscoRTPBitRate

public interface CiscoRTPBitRate

Interface Declaration

CiscoRTPBitRate

Description

The CiscoRTPBitRate 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()

Variable Index

R5_3 

5.3k G.723 bit rate

R6_4 

6.4k G.723 bit rate

Variable Detail

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

CiscoRTPInputProperties

public interface CiscoRTPInputProperties

Interface Declaration

CiscoRTPInputProperties

Method Index

getBitRate() 

Returns the media bit rate

getEchoCancellation() 
getLocalAddress() 
getLocalPort() 
getPacketSize() 
getPayloadType() 

Returns the payload format

Method Detail

getBitRate

public abstract int getBitRate()

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

RTPBitRate.R5_3

RTPBitRate.R6_4

Returns

payload type

getEchoCancellation

public abstract boolean getEchoCancellation()

Returns the echo cancellation

getLocalAddress

public abstract InetAddress getLocalAddress()

Returns the address to which media will be directed

getLocalPort

public int getLocalPort()
Returns

The 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:

RTPPayload.MEDIAPAYLOAD_NONSTANDARD

RTPPayload.MEDIAPAYLOAD_G711ALAW64K

RTPPayload.MEDIAPAYLOAD_G711ALAW56K

RTPPayload.MEDIAPAYLOAD_G711ULAW64K

RTPPayload.MEDIAPAYLOAD_G711ULAW56K

RTPPayload.MEDIAPAYLOAD_G722_64K

RTPPayload.MEDIAPAYLOAD_G722_56K

RTPPayload.MEDIAPAYLOAD_G722_48K

RTPPayload.MEDIAPAYLOAD_G7231

RTPPayload.MEDIAPAYLOAD_G728

RTPPayload.MEDIAPAYLOAD_G729

RTPPayload.MEDIAPAYLOAD_G729ANNEXA

RTPPayload.MEDIAPAYLOAD_IS11172AUDIOCAP

RTPPayload.MEDIAPAYLOAD_IS13818AUDIOCAP

RTPPayload.MEDIAPAYLOAD_ACY_G729AASSN

RTPPayload.MEDIAPAYLOAD_DATA64

RTPPayload.MEDIAPAYLOAD_DATA56

RTPPayload.MEDIAPAYLOAD_GSM

RTPPayload.MEDIAPAYLOAD_ACTIVEVOICE

Returns

payload type

CiscoRTPInputStartedEv

public interface CiscoRTPInputStartedEv
extends CiscoTermEv

Interface Declaration

CiscoRTPInputStartedEv

Variable Index

ID 

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getRTPInputProperties() 

Methods inherited from interface javax.telephony.events.TermEv

getTerminal

Variable Detail

ID

public static final int ID

Method Detail

getRTPInputProperties

public abstract CiscoRTPInputProperties getRTPInputProperties()

Returns the RTP input properties.

CiscoRTPInputStoppedEv

public interface CiscoRTPInputStoppedEv
extends CiscoTermEv

Interface Declaration

CiscoRTPInputStoppedEv

Variable Index

ID 

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.TermEv

getTerminal

Variable Detail

ID

public static final int ID

CiscoRTPOutputProperties

public interface CiscoRTPOutputProperties

Interface Declaration

CiscoRTPOutputProperties

Method Index

getBitRate() 

Returns the media bit rate

getMaxFramesPerPacket() 
getPacketSize() 
getPayloadType() 

Returns the payload format

getPrecedenceValue() 
getRemoteAddress() 
getRemotePort() 
getSilenceSuppression() 

Method Detail

getBitRate

public abstract int getBitRate()

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

RTPBitRate.R5_3

RTPBitRate.R6_4

getRemoteAddress

public abstract InetAddress getRemoteAddress()

Returns the address to which media is to be transmitted

getRemotePort

public abstract int getRemotePort()

Returns the port to which media is to be transmitted

getPacketSize

public abstract int getPacketSize()

Returns the packet size, in milliseconds

getPayloadType

public abstract int getPayloadType()

Returns the payload format, one of the following constants:

RTPPayload.MEDIAPAYLOAD_NONSTANDARD

RTPPayload.MEDIAPAYLOAD_G711ALAW64K

RTPPayload.MEDIAPAYLOAD_G711ALAW56K

RTPPayload.MEDIAPAYLOAD_G711ULAW64K

RTPPayload.MEDIAPAYLOAD_G711ULAW56K

RTPPayload.MEDIAPAYLOAD_G722_64K

RTPPayload.MEDIAPAYLOAD_G722_56K

RTPPayload.MEDIAPAYLOAD_G722_48K

RTPPayload.MEDIAPAYLOAD_G7231

RTPPayload.MEDIAPAYLOAD_G728

RTPPayload.MEDIAPAYLOAD_G729

RTPPayload.MEDIAPAYLOAD_G729ANNEXA

RTPPayload.MEDIAPAYLOAD_IS11172AUDIOCAP

RTPPayload.MEDIAPAYLOAD_IS13818AUDIOCAP

RTPPayload.MEDIAPAYLOAD_ACY_G729AASSN

RTPPayload.MEDIAPAYLOAD_DATA64

RTPPayload.MEDIAPAYLOAD_DATA56

RTPPayload.MEDIAPAYLOAD_GSM

RTPPayload.MEDIAPAYLOAD_ACTIVEVOICE

getPrecedenceValue

public abstract int getPrecedenceValue()

Returns the precedence value

getMaxFramesPerPacket

public abstract int getMaxFramesPerPacket()

Returns the maximum number of frames to send per packet

getSilenceSuppression

public boolean getSilenceSuppression()

Returns silence suppression

CiscoRTPOutputStartedEv

public interface CiscoRTPOutputStartedEv
extends CiscoTermEv

Interface Declaration

CiscoRTPOutputStartedEv

Variable Index

ID 

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getRTPOutputProperties() 

Methods inherited from interface javax.telephony.events.TermEv

getTerminal

Variable Detail

ID

public static final int ID

Method Detail

getRTPOutputProperties

public CiscoRTPOutputProperties getRTPOutputProperties()

Returns the RTP output properties

CiscoRTPOutputStoppedEv

public interface CiscoRTPOutputStoppedEv
extends CiscoTermEv

Interface Declaration

CiscoRTPOutputStoppedEv

Variable Index

ID 

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Variable Detail

ID

public static final int ID

CiscoRTPPayload

public interface CiscoRTPPayload

Interface Declaration

CiscoRTPPayload

Description

The RTPPayload interface contains constants describing RTP formats. These constants are returned by the CiscoRTPInputProperties.getPayloadType method and the CiscoRTPOutputProperties.getPayloadType method.

See Also

CiscoRTPInputProperties.getPayloadType(), CiscoRTPOutputProperties.getPayloadType()

Field Index

ACTIVEVOICE 

ACTIVEVOICE payload

ACY_G729AASSN 

ACY_G729AASSN payload

DATA56 

DATA56 payload

DATA64 

DATA64 payload

G711ALAW56K 

G.711 56K a-law payload

G711ALAW64K 

G.711 64K a-law payload

G711ULAW56K 

G.711 56K u-law payload

G711ULAW64K 

G.711 64K u-law payload

G722_48K 

G.722 48K payload

G722_56K 

G.722 56K payload

G722_64K 

G.722 64K payload

G7231 

G.723.1 payload

G728 

G.728 payload

G729 

G.729 payload

G729ANNEXA 

G.729a payload

GSM 

GSM payload

IS11172AUDIOCAP

IS11172AUDIOCAP payload

IS13818AUDIOCAP 

IS13818AUDIOCAP payload

NONSTANDARD 

A non-standard RTP payload

Field Detail

ACTIVEVOICE

public static final int ACTIVEVOICE

ACTIVEVOICE payload

ACY_G729AASSN

public static final int ACY_G729AASSN

ACY_G729AASSN payload

DATA56

public static final int DATA56

DATA56 payload

DATA64

public static final int DATA64

DATA64 payload

G711ALAW56K

public static final int G711ALAW56K

G.711 56K a-law payload

G711ALAW64K

public static final int G711ALAW64K

G.711 64K a-law payload

G711ULAW56K

public static final int G711ULAW56K

G.711 56K u-law payload

G711ULAW64K

public static final int G711ULAW64K

G.711 64K u-law payload

G722_48K

public static final int G722_48K

G.722 48K payload

G722_56K

public static final int G722_56K

G.722 56K payload

G722_64K

public static final int G722_64K

G.722 64K payload

G7231

public static final int G7231

G.723.1 payload

G728

public static final int G728

G.728 payload

G729

public static final int G729

G.729 payload

G729ANNEXA

public static final int G729ANNEXA

G.729a payload

GSM

public static final int GSM

GSM payload

IS11172AUDIOCAP

public static final int IS11172AUDIOCAP

IS11172AUDIOCAP payload

IS13818AUDIOCAP

public static final int IS13818AUDIOCAP

IS13818AUDIOCAP payload

NONSTANDARD

public static final int NONSTANDARD

A non-standard RTP payload

CiscoSynchronousObserver

public interface CiscoSynchronousObserver

Interface Declaration

CiscoSynchronousObserver

Description

The Cisco JTAPI implementation is designed to allow applications to invoke blocking JTAPI methods such as Call.connect() and TerminalConnection.answer() from within their observer callbacks. This means that applications are not subject to the restrictions imposed by the JTAPI specification, which cautions applications against using JTAPI methods from within observer callback.

Normally, when an application adds a new observer to a JTAPI object, the Cisco JTAPI implementation creates an event queue and an accompanying worker thread to service the new observer. If the same observer is added to another object, its queue and thread are reused; in effect, every unique observer object has a single queue and worker thread. As noted, the advantage of this arrangement is that an application may invoke blocking JTAPI methods from within its observer callback. A subtle disadvantage, however, is that accessor methods such as Call.getConnections() and Connection.getState() may not return results that are consistent with events when invoked from within the observer callback.

For example, suppose that an application creates and connects a call from address "A" to address "B". If the application is observing address "A", it might reasonably expect that when it receives the CallActiveEv, the state of the call will be Call.ACTIVE. This is not necessarily so, since the worker thread delivering events to the application is decoupled from the internal JTAPI thread that is updating object states. In fact, if "B" rejects the call from "A", the call object might be in either the Call.ACTIVE state or the Call.INVALID state, depending on the exact moment at which the worker thread delivers the CallActiveEv.

Many applications will not be adversely affected by this asynchronous behavior. Applications that would benefit from a coherent call model during observer callbacks, however, can selectively disable the queueing logic of the Cisco JTAPI implementation. By implementing the CiscoSynchronousObserver interface on its observer objects, an application declares that it wishes events to be delivered synchronously to its observers. Events delivered to synchronous observers will match the states of the call model objects queried from within the observer callback.

Usage Notes

Objects that implement the CiscoSynchronousObserver interface are strictly forbidden from invoking blocking JTAPI methods from within their event callbacks. The consequences of doing so are unpredictable, and may include deadlocking the JTAPI implementation. On the other hand, they may safely use the accessor methods of any JTAPI object, for instance Call.getConnections() or Connection.getState().

CiscoTelephonyException

public interface CiscoTelephonyException

Interface Declaration

CiscoTelephonyException

Description

The CiscoTelephonyException 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.

Field Index

ASSOCIATED_LINE_NOT_OPEN 
CALL_ALREADY_EXISTS 
CALLHANDLE_NOTINCOMINGCALL 
CANNOT_OPEN_DEVICE 
CANNOT_TERMINATE_MEDIA_ON_PHONE 
COMMAND_NOT_IMPLEMENTED_ON_DEVICE 
DB_ERROR 
DB_ILLEGAL_DEVICE_TYPE 
DB_NO_MORE_DEVICES 
DEVICE_NOT_OPEN 
DIRECTORY_LOGIN_FAILED 
EXISTING_FIRSTPARTY 
HOLDFAILED 
ILLEGAL_CALLINGPARTY 
ILLEGAL_CALLSTATE 
ILLEGAL_HANDLE 
ILLEGAL_MESSAGE_FORMAT 
LINECONTROL_FAILURE 
NO_ACTIVE_DEVICE_FOR_THIRDPARTY 
PROTOCOL_TIMEOUT 
PROVIDER_ALREADY_OPEN 
PROVIDER_CLOSED 
PROVIDER_NOT_OPEN 
REDIRECT_CALL_CALL_TABLE_FULL 
REDIRECT_CALL_DESTINATION_BUSY 
REDIRECT_CALL_DESTINATION_OUT_OF_ORDER 
REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT 
REDIRECT_CALL_DOES_NOT_EXIST 
REDIRECT_CALL_INCOMPATIBLE_STATE 
REDIRECT_CALL_MEDIA_CONNECTION_FAILED 
REDIRECT_CALL_NORMAL_CLEARING 
REDIRECT_CALL_ORIGINATOR_ABANDONED 
REDIRECT_CALL_PARTY_TABLE_FULL 
REDIRECT_CALL_PENDING_REDIRECT_TRANSACTION 
REDIRECT_CALL_PROTOCOL_ERROR 
REDIRECT_CALL_UNKNOWN_DESTINATION 
REDIRECT_CALL_UNKNOWN_ERROR 
REDIRECT_CALL_UNKNOWN_PARTY 
REDIRECT_CALL_UNRECOGNIZED_MANAGER 
REDIRECT_CALLINFO_ERR 
REDIRECT_ERR 
RETRIEVEFAILED 
SSAPI_NOT_REGISTERED 
TIMEOUT 
TRANSFERFAILED 
TRANSFERFAILED_CALLCONTROL_TIMEOUT 
TRANSFERFAILED_DESTINATION_BUSY 
TRANSFERFAILED_DESTINATION_UNALLOCATED 
TRANSFERFAILED_OUTSTANDING_TRANSFER 
UNDEFINED_LINE 
UNKNOWN_GLOBAL_CALL_HANDLE 
UNRECOGNIZABLE_PDU 
UNSPECIFIED 

Method Index

getDetailedCause()

Field Detail

ASSOCIATED_LINE_NOT_OPEN

public static final int ASSOCIATED_LINE_NOT_OPEN

CALL_ALREADY_EXISTS

public static final int CALL_ALREADY_EXISTS

CALLHANDLE_NOTINCOMINGCALL

public static final int CALLHANDLE_NOTINCOMINGCALL

CANNOT_OPEN_DEVICE

public static final int CANNOT_OPEN_DEVICE

CANNOT_TERMINATE_MEDIA_ON_PHONE

public static final int CANNOT_TERMINATE_MEDIA_ON_PHONE

COMMAND_NOT_IMPLEMENTED_ON_DEVICE

public static final int COMMAND_NOT_IMPLEMENTED_ON_DEVICE

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

DEVICE_NOT_OPEN

public static final int DEVICE_NOT_OPEN

DIRECTORY_LOGIN_FAILED

public static final int DIRECTORY_LOGIN_FAILED

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

LINECONTROL_FAILURE

public static final int LINECONTROL_FAILURE

NO_ACTIVE_DEVICE_FOR_THIRDPARTY

public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTY

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

SSAPI_NOT_REGISTERED

public static final int SSAPI_NOT_REGISTERED

TIMEOUT

public static final int TIMEOUT

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

Method Detail

getDetailedCause

public int getDetailedCause()

CiscoTermCreatedEv

public interface CiscoTermCreatedEv
extends CiscoProvEv

Interface Declaration

CiscoTermCreatedEv

Description

The CiscoTermCreatedEv event

Variable Index

ID

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getTerminal()

Methods inherited from interface javax.telephony.events.ProvEv

getProvider

Variable Detail

ID

public static final int ID

Method Detail

getTerminal()

public abstract Terminal getTerminal()

CiscoTermEv

public interface CiscoTermEv
extends CiscoEv, javax.telephony.events.TermEv

Interface Declaration

CiscoTermEv

Description

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

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.TermEv

getTerminal

See Also

CallEv

CiscoTerminal

public interface CiscoTerminal
extends javax.telephony.Terminal, ObjectContainer

Interface Declaration

CiscoTerminal

Description

Since JTAPI does not support the notion of dynamic terminal registration, the CiscoTerminal interface extends the standard Terminal interface to do so. All Cisco CallManager devices are represented by CiscoTerminals, and all CiscoTerminals may be queried to determine whether they are currently IN_SERVICE or OUT_OF_SERVICE.

If the Cisco CallManager device represented by the CiscoTerminal is an IP telephone, for instance, it would become OUT_OF_SERVICE if it were to lose its network connection. Other types of devices, such as JTAPI Ports, are registered on demand by applications, and may be IN_SERVICE or OUT_OF_SERVICE accordingly.

See Also

Terminal

CiscoMediaTerminal

Variable Index

IN_SERVICE 

OUT_OF_SERVICE 

Method Index

getRegistrationState() 

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

getRTPInputProperties() 

The CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state.

getRTPOutputProperties() 

The CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state.

getState() 

Returns the state of this terminal.

Methods inherited from interface javax.telephony.Terminal

addCallObserver, addObserver, getAddresses, getCallObservers, getCapabilities, getName, 
getObservers, getProvider, getTerminalCapabilities, getTerminalConnections, 
removeCallObserver, removeObserver

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Variable Detail

IN_SERVICE

public static final int IN_SERVICE

OUT_OF_SERVICE

public static final int OUT_OF_SERVICE

Method Detail

getRegistrationState

public int getRegistrationState()

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

Returns the state of this terminal.

The state may be any of the following constants:

CiscoTerminal.OUT_OF_SERVICE

CiscoTerminal.IN_SERVICE

Returns

the state of this terminal

getState

public int getState()

Returns the state of this terminal.

The state may be any of the following constants:

CiscoTerminal.OUT_OF_SERVICE

CiscoTerminal.IN_SERVICE

Returns

the state of this terminal

getRTPInputProperties

public CiscoRTPInputProperties getRTPInputProperties()
throws javax.telephony.InvalidStateException

The CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state. and Terminal.getTerminalConnections () must return at least one terminal connection in the TerminalConnection.ACTIVE state.

Returns

the properties to be used for the RTP input stream associated with the ACTIVE TerminalConnection on this Terminal

getRTPOutputProperties

public CiscoRTPOutputProperties getRTPOutputProperties()
throws javax.telephony.InvalidStateException

The CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state. and Terminal.getTerminalConnections () must return at least one terminal connection in the TerminalConnection.ACTIVE state.

Returns

the properties to be used for the RTP output stream associated with the ACTIVE TerminalConnection on this TerminalgetRegistrationState

CiscoTerminalConnection

public interface CiscoTerminalConnection 
extends javax.telephony.callcontrol.CallControlTerminalConnection, ObjectContainer

Interface Declaration

CiscoTerminalConnection

Description

The CiscoTerminalConnection interface extends the CallControlTerminalConnection interface with additional capabilities.

Applications can use the getReason method of the CiscoConnection interface to obtain the reason for the creation of this connection.

Fields inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection

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

Fields inherited from interface javax.telephony.TerminalConnection

ACTIVE, DROPPED, IDLE, PASSIVE, RINGING, UNKNOWN

Methods inherited from interface javax.telephony.callcontrol.CallControlTerminalConnection

getCallControlState, hold, join, leave, unhold

Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer

getObject, setObject

Methods inherited from interface javax.telephony.TerminalConnection

answer, getCapabilities, getConnection, getState, getTerminal, 
getTerminalConnectionCapabilities

CiscoTerminalObserver

public interface CiscoTerminalObserver
extends javax.telephony.TerminalObserver

Interface Declaration

CiscoTerminalObserver

Description

Applications implement this interface in order to receive CiscoTermEv events such as CiscoRTPInputStartedEv and CiscoRTPInputStoppedEv when observing Terminals via the Terminal.addObserver method.

Methods inherited from interface javax.telephony.TerminalObserver

terminalChangedEvent

See Also

CiscoTermInServiceEv

CiscoTermOutOfServiceEv

CiscoRTPInputStartedEv

CiscoRTPInputStoppedEv

CiscoRTPOutputStartedEv

CiscoRTPOutputStoppedEv

CiscoTermInServiceEv

public interface CiscoTermInService
extends CiscoTermEv

Interface Declaration

CiscoTermInServiceEv

Description

The CiscoTermInServiceEv event

Variable Index

ID

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.TermEv

getTerminal

Variable Detail

ID

public static final int ID

CiscoTermOutOfServiceEv

public interface CiscoTermOutOfService
extends CiscoTermEv

Interface Declaration

CiscoTermOutOfServiceEv

Description

The CiscoTermOutOfServiceEv event

Variable Index

ID

Fields inherited from interface javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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 javax.telephony.events.TermEv

getTerminal

Variable Detail

ID

public static final int ID

CiscoTransferEndEv

public interface CiscoTransferEndEv
extends CiscoCallEv

Interface Declaration

CiscoTransferEndEv

Description

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

Variable Index

ID 

Fields inherited from interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, 
CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLREJECTED, 
CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, 
CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, 
CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, 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_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 javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getFinalCall() 

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

getTransferController() 

Returns the TerminalConnection which currently acts as the transfer controller for this call —the final call.

getTransferControllerAddress() 

Returns the Address which currently acts as the transfer controller for this call -- the final call.

getTransferredCall() 

Returns the call that has been transferred.

Variable Detail

ID

public static final int ID

Method Detail

getFinalCall

public javax.telephony.Call getFinalCall()

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

getTransferController

public javax.telephony.TerminalConnection getTransferController()

Returns the TerminalConnection which currently acts as the transfer controller for this call, the final call.

getTransferControllerAddress

public javax.telephony.Address getTransferControllerAddress()

Returns the Address which currently acts as the transfer controller for this call -- the final call.

getTransferredCall

public javax.telephony.Call getTransferredCall()

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

CiscoTransferStartEv

public interface CiscoTransferStartEv
extends CiscoCallEv

Interface Declaration

CiscoTransferStartEv

Description

The CiscoTransferStartEv interface indicates that a transfer operation has started. This interface is reported via the CallControlCallObserver interface.

Variable Index

ID 

Fields inherited from interface com.cisco.jtapi.extensions.CiscoCallEv

CAUSE_ACCESSINFORMATIONDISCARDED, CAUSE_BCBPRESENTLYAVAIL, CAUSE_BCNAUTHORIZED, 
CAUSE_BEARERCAPNIMPL, CAUSE_CALLBEINGDELIVERED, CAUSE_CALLIDINUSE, CAUSE_CALLREJECTED, 
CAUSE_CALLSPLIT, CAUSE_CHANTYPENIMPL, CAUSE_CHANUNACCEPTABLE, 
CAUSE_DESTINATIONOUTOFORDER, CAUSE_DESTNUMMISSANDDCNOTSUB, CAUSE_FACILITYREJECTED, 
CAUSE_IDENTIFIEDCHANDOESNOTEXIST, CAUSE_IENIMPL, 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_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 javax.telephony.events.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

Fields inherited from interface javax.telephony.events.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

Method Index

getFinalCall() 

Returns the call that will remain active after the transfer is completed.

getTransferController() 

Returns the TerminalConnection which currently acts as the transfer controller for this call.

getTransferredCall() 

Returns the call that will be transferred.

Variable Detail

ID

public static final int ID

Method Detail

getFinalCall

public javax.telephony.Call getFinalCall()

Returns the call that will remain active after the transfer is completed.

getTransferController

public javax.telephony.TerminalConnection getTransferController()

Returns the TerminalConnection which currently acts as the transfer controller for this call, the final call.

getTransferControllerAddress()

Returns the Address which currently acts as the transfer controller for this call -- the final call.

getTransferredCall

public javax.telephony.Call getTransferredCall()

Returns the call that will be transferred.