Feedback
Table Of Contents
Cisco JTAPI Extensions Hierarchy
Class com.cisco.jtapi.extensions
CiscoProvFeatureUnRegisteredEv
Class com.cisco.services.alarm
All Known Implementing Classes
All Known Implementing Classes
Class com.cisco.services.tracing
All Known Implementing Classes
Cisco JTAPI Implementation
Cisco JTAPI Implementation describes interfaces and classes available. To create new applications, use these interfaces and classes with the standard JTAPI interfaces and classes described in the Cisco JTAPI v 1.2.
This chapter contains the following sections:
•
Cisco JTAPI Extensions Hierarchy
•
•
•
Cisco JTAPI Extensions Hierarchy
Class Hierarchy
class java.lang.Object
class com.cisco.services.alarm.AlarmManager
class com.cisco.services.tracing.BaseTraceWriter (implements com.cisco.services.tracing.TraceWriter)
class com.cisco.services.tracing.ConsoleTraceWriter
class com.cisco.services.tracing.LogFileTraceWriter
class com.cisco.services.tracing.OutputStreamTraceWriter
class com.cisco.services.tracing.SyslogTraceWriter
class com.cisco.jtapi.extensions.CiscoAddressCallInfo
class com.cisco.jtapi.extensions.CiscoJtapiVersion
class com.cisco.jtapi.extensions.CiscoMediaCapability
class com.cisco.jtapi.extensions.CiscoG711MediaCapability
class com.cisco.jtapi.extensions.CiscoG723MediaCapability
class com.cisco.jtapi.extensions.CiscoG729MediaCapability
class com.cisco.jtapi.extensions.CiscoGSMMediaCapability
class com.cisco.jtapi.extensions.CiscoRTPParams
class com.cisco.services.alarm.DefaultAlarm (implements com.cisco.services.alarm.Alarm)
class com.cisco.services.alarm.DefaultAlarmWriter (implements com.cisco.services.alarm.AlarmWriter)
class com.cisco.services.alarm.ParameterList
class java.lang.Throwable (implements java.io.Serializable)
class java.lang.Exception
class com.cisco.jtapi.extensions.CiscoRegistrationException
class com.cisco.jtapi.extensions.CiscoUnregistrationException
class com.cisco.services.tracing.TraceManagerFactory
Interface Hierarchy
interface javax.telephony.Address
interface com.cisco.jtapi.extensions.CiscoAddress (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)
interface javax.telephony.callcenter.RouteAddress
interface com.cisco.jtapi.extensions.CiscoRouteAddress
interface javax.telephony.AddressObserver
interface com.cisco.jtapi.extensions.CiscoAddressObserver
interface com.cisco.services.alarm.Alarm
interface com.cisco.services.alarm.AlarmWriter
interface javax.telephony.Call
interface javax.telephony.callcontrol.CallControlCall
interface com.cisco.jtapi.extensions.CiscoCall (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)
interface com.cisco.jtapi.extensions.CiscoConsultCall
interface com.cisco.jtapi.extensions.CiscoJtapiException
interface com.cisco.jtapi.extensions.CiscoJtapiProperties
interface com.cisco.jtapi.extensions.CiscoObjectContainer
interface com.cisco.jtapi.extensions.CiscoAddress (also extends javax.telephony.Address)
interface com.cisco.jtapi.extensions.CiscoCall (also extends javax.telephony.callcontrol.CallControlCall)
interface com.cisco.jtapi.extensions.CiscoConsultCall
interface com.cisco.jtapi.extensions.CiscoCallID
interface com.cisco.jtapi.extensions.CiscoConnection (also extends javax.telephony.callcontrol.CallControlConnection)
interface com.cisco.jtapi.extensions.CiscoConnectionID
interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModule)
interface com.cisco.jtapi.extensions.CiscoProvider (also extends javax.telephony.Provider)
interface com.cisco.jtapi.extensions.CiscoTerminal (also extends javax.telephony.Terminal)
interface com.cisco.jtapi.extensions.CiscoMediaTerminal
interface com.cisco.jtapi.extensions.CiscoTerminalConnection (also extends javax.telephony.callcontrol.CallControlTerminalConnection)
interface com.cisco.jtapi.extensions.CiscoProvFeatureID
interface com.cisco.jtapi.extensions.CiscoRTPBitRate
interface com.cisco.jtapi.extensions.CiscoRTPInputProperties
interface com.cisco.jtapi.extensions.CiscoRTPOutputProperties
interface com.cisco.jtapi.extensions.CiscoRTPPayload
interface com.cisco.jtapi.extensions.CiscoSynchronousObserver
interface javax.telephony.Connection
interface javax.telephony.callcontrol.CallControlConnection
interface com.cisco.jtapi.extensions.CiscoConnection (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)
interface javax.telephony.events.Ev
interface javax.telephony.events.AddrEv
interface com.cisco.jtapi.extensions.CiscoAddrEv (also extends com.cisco.jtapi.extensions.CiscoEv)
interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv
interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)
interface javax.telephony.events.CallEv
interface javax.telephony.events.CallActiveEv
interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends com.cisco.jtapi.extensions.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.CiscoEv
interface com.cisco.jtapi.extensions.CiscoAddrEv (also extends javax.telephony.events.AddrEv)
interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv
interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)
interface com.cisco.jtapi.extensions.CiscoCallEv (also extends javax.telephony.events.CallEv)
interface com.cisco.jtapi.extensions.CiscoConferenceEndEv
interface com.cisco.jtapi.extensions.CiscoConferenceStartEv
interface com.cisco.jtapi.extensions.CiscoConsultCallActiveEv (also extends javax.telephony.events.CallActiveEv)
interface com.cisco.jtapi.extensions.CiscoTransferEndEv
interface com.cisco.jtapi.extensions.CiscoTransferStartEv
interface com.cisco.jtapi.extensions.CiscoOutOfServiceEv
interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoAddrEv)
interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoTermEv)
interface com.cisco.jtapi.extensions.CiscoProvEv (also extends javax.telephony.events.ProvEv)
interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv
interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureEv
interface com.cisco.jtapi.extensions.CiscoProvCallParkEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv
interface com.cisco.jtapi.extensions.CiscoTermCreatedEv
interface com.cisco.jtapi.extensions.CiscoTermRemovedEv
interface com.cisco.jtapi.extensions.CiscoTermEv (also extends javax.telephony.events.TermEv)
interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv
interface com.cisco.jtapi.extensions.CiscoTermDataEv
interface com.cisco.jtapi.extensions.CiscoTermInServiceEv
interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)
interface javax.telephony.events.ProvEv
interface com.cisco.jtapi.extensions.CiscoProvEv (also extends com.cisco.jtapi.extensions.CiscoEv)
interface com.cisco.jtapi.extensions.CiscoAddrCreatedEv
interface com.cisco.jtapi.extensions.CiscoAddrRemovedEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureEv
interface com.cisco.jtapi.extensions.CiscoProvCallParkEv
interface com.cisco.jtapi.extensions.CiscoProvFeatureUnRegisteredEv
interface com.cisco.jtapi.extensions.CiscoTermCreatedEv
interface com.cisco.jtapi.extensions.CiscoTermRemovedEv
interface javax.telephony.events.TermEv
interface com.cisco.jtapi.extensions.CiscoTermEv (also extends com.cisco.jtapi.extensions.CiscoEv)
interface com.cisco.jtapi.extensions.CiscoRTPInputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPInputStoppedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStartedEv
interface com.cisco.jtapi.extensions.CiscoRTPOutputStoppedEv
interface com.cisco.jtapi.extensions.CiscoTermDataEv
interface com.cisco.jtapi.extensions.CiscoTermInServiceEv
interface com.cisco.jtapi.extensions.CiscoTermOutOfServiceEv (also extends com.cisco.jtapi.extensions.CiscoOutOfServiceEv)
interface javax.telephony.JtapiPeer
interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends com.cisco.jtapi.extensions.CiscoObjectContainer, com.cisco.services.tracing.TraceModule)
interface javax.telephony.Provider
interface com.cisco.jtapi.extensions.CiscoProvider (also extends com.cisco.jtapi.extensions.CiscoObjectContainer)
interface javax.telephony.capabilities.ProviderCapabilities
interface com.cisco.jtapi.extensions.CiscoProviderCapabilities
interface javax.telephony.ProviderObserver
interface com.cisco.jtapi.extensions.CiscoProviderObserver
interface javax.telephony.callcenter.RouteSession
interface com.cisco.jtapi.extensions.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.Trace
interface com.cisco.services.tracing.ConditionalTrace
interface com.cisco.services.tracing.UnconditionalTrace
interface com.cisco.services.tracing.TraceManager
interface com.cisco.services.tracing.TraceModule
interface com.cisco.jtapi.extensions.CiscoJtapiPeer (also extends com.cisco.jtapi.extensions.CiscoObjectContainer, javax.telephony.JtapiPeer)
interface com.cisco.services.tracing.TraceWriter
interface com.cisco.services.tracing.TraceWriterManager
Class com.cisco.jtapi.extensions
The Cisco JTAPI extension consists of a set of classes and interfaces that expose the functionality available in the Cisco IP Telephony. This API allows programmers to create independent applications for Cisco CallManager. The Cisco JTAPI implementation offers additional functionality not readily exposed through the JTAPI 1.2 interfaces. Applications can use the interfaces and classes in the com.cisco.jtapi.extensions package with the standard JTAPI interfaces and classes described in the Cisco JTAPI v 1.2 Specification manual to create new applications.
CiscoAddrCreatedEv
Declaration
public interface CiscoAddrCreatedEv extends CiscoProvEvAll Superinterfaces
Description
The CiscoAddrCreatedEv event
Fields
ID
public static final int IDMethods
getAddress()
publicjavax.telephony.AddressgetAddress()CiscoAddress
Declaration
All Superinterfaces
javax.telephony.Address, CiscoObjectContainerDescription
The CiscoAddress interface extends the Address interface with additional CallManager-specific capabilities.See Also
javax.telephony.Address
addCallObserver(CallObserver),addObserver(AddressObserver),getAddressCapabilities(Terminal),getCallObservers(),getCapabilities(),getConnections(),getName(),getObservers(),getProvider(),getTerminals(),removeCallObserver(CallObserver),removeObserver(AddressObserver)
Fields
EXTERNAL
public static final int EXTERNALThis 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_UNKNOWNThis 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_SERVICEThe address is out-of-serviceINTERNAL
public static final int INTERNALThis is an internal address.OUT_OF_SERVICE
public static final int OUT_OF_SERVICEThe address is in-serviceRINGER_DEFAULT
public static final int RINGER_DEFAULTSets the ringer status to configured valueRINGER_DISABLE
public static final int RINGER_DISABLEDisables the ringer for the addressRINGER_ENABLE
public static final int RINGER_ENABLEEnables the ringer for the addressUNKNOWN
public static final int UNKNOWNThis is an external address with an unknown name. An address of this type is created to represent an endpoint for which there is insufficient information.Methods
clearCallConnections()
public void clearCallConnections()
throws PrivilegeViolationExceptionUse this interface to clear off any phantom calls on the addressThrows:javax.telephony.PrivilegeViolationExceptiongetAddressCallInfo(Terminal)
public com.cisco.jtapi.extensions.CiscoAddressCallInfo getAddressCallInfo(javax.telephony.Terminaliterminal)Use this Interface to get info of calls present at the terminalgetRegistrationState()
public int getRegistrationState()Deprecated.This method has been replaced by the getState() method.Returns the state of this address.The state may be any of the following constants:· CiscoAddress.OUT_OF_SERVICE· CiscoAddress.IN_SERVICEReturns:the state of this addressgetState()
public int getState()Returns the state of this address.The state may be any of the following constants:· CiscoAddress.OUT_OF_SERVICE· CiscoAddress.IN_SERVICEReturns:the state of this addressgetType()
public int getType()Returns the type of this address.The type may be any of the following constants:· CiscoAddress.INTERNAL· CiscoAddress.EXTERNAL· CiscoAddress.EXTERNAL_UNKNOWNReturns:the type of addresssetMessageWaiting(String, boolean)
public void setMessageWaiting(java.lang.Stringdestination, boolean enable)
throws MethodNotSupportedException, InvalidStateException, PrivilegeViolationExceptionSpecifies whether the message-waiting indicator should be activated or deactivated for the Address specified by the destination. If enable is true, message-waiting is activated if not already activated. If enable is false, message-waiting is deactivated if not already deactivated.Pre-conditions:1. (this.getProvider()).getState() == Provider.IN_SERVICEPost-conditions:1. (this.getProvider()).getState() == Provider.IN_SERVICENote: The following postconditions as specified in CallControlAddress are currently not enforced by this implementation.1. this.getMessageWaiting() == enable2. CallCtlAddrMessageWaitingEv is delivered for this AddressParameters:destination - DN whose message waiting indicator should be activatedenable - True to activate message-waiting, false to deactivate.Throws:javax.telephony.MethodNotSupportedException - This method is not supported by the given implementation.javax.telephony.InvalidStateException - The Provider is not "in service".javax.telephony.PrivilegeViolationException - The Provider user has insufficient privleges to invoke the message waiting indicator for this destinationsetRingerStatus(int)
public void setRingerStatus(int status)
throws MethodNotSupportedException, InvalidStateException, InvalidArgumentExceptionchanges the ringer status on this addressAccepts on of the following constants: CiscoAddress.RINGER_DEFAULT CiscoAddress.RINGER_DISABLE CiscoAddress.RINGER_ENABLEThrows:javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedExceptionCiscoAddressCallInfo
Declaration
public class CiscoAddressCallInfojava.lang.Object|+--com.cisco.jtapi.extensions.CiscoAddressCallInfo
clone(),equals(Object),finalize(),getClass(),hashCode(),notify(),notifyAll(),toString(),wait(),wait(),wait()
Constructors
CiscoAddressCallInfo(int, int, int, int)
public CiscoAddressCallInfo(int inumActiveCalls, int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold)CiscoAddressCallInfo(int, int, int, int, CiscoCall[])
public CiscoAddressCallInfo(int inumActiveCalls, int imaxActiveCalls, int inumCallsOnHold, int imaxCallsOnHold, com.cisco.jtapi.extensions.CiscoCall[] icalls)Methods
getCalls()
public com.cisco.jtapi.extensions.CiscoCall[] getCalls()getMaxActiveCalls()
public int getMaxActiveCalls()•
public int getMaxCallsOnHold()getNumActiveCalls()
public int getNumActiveCalls()getNumCallsOnHold()
public int getNumCallsOnHold()CiscoAddressObserver
Declaration
public interface CiscoAddressObserver extendsjavax.telephony.AddressObserverAll Superinterfaces
javax.telephony.AddressObserverDescription
Applications implement this interface in order to receive CiscoAddrEv events such as CiscoAddrInServiceEv and CiscoAddrOutOfServiceEv when observing Addresses via the Address.addObserver method.See Also:
addressChangedEvent(AddrEv[])
CiscoAddrEv
Declaration
All Superinterfaces
All Known Subinterfaces
Description
The CiscoAddrEv interface, which extends JTAPI's core javax.telephony.events.AddrEv interface, serves as the base interface for all Cisco-extended JTAPI Address events. Every Address-related event in this package extends this interface, directly or indirectly.See Also:
javax.telephony.events.AddrEv
CiscoAddrInServiceEv
Declaration
public interface CiscoAddrInServiceEv extends CiscoAddrEvAll Superinterfaces
Description
The CiscoAddrInServiceEv event
Fields
ID
public static final int IDCiscoAddrOutOfServiceEv
Declaration
All Superinterfaces
Description
The CiscoAddrOutOfServiceEv event
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_UNKNOWNgetAddress()getCause(),getID(),getMetaCode(),getObserved(),isNewMetaEvent()
Fields
ID
public static final int IDCiscoAddrRemovedEv
Declaration
public interface CiscoAddrRemovedEv extends CiscoProvEvAll Superinterfaces
CiscoEv,CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEvDescription
The CiscoAddrRemovedEv event
Fields
ID
public static final int IDMethods
getAddress()
publicjavax.telephony.AddressgetAddress()CiscoCall
Declaration
public interface CiscoCall extendsjavax.telephony.callcontrol.CallControlCall, CiscoObjectContainerAll Superinterfaces
All Known Subinterfaces
Description
The CiscoCall interface extends the CallControlCall interface with additional CallManager-specific capabilities.In CallManager terms, every Call object comprises a set of call legs that share a common identifier: the global call handle. Connection objects represent call legs in JTAPI, and the Call object that relates a set of Connections contains the global call handle that the underlying call legs share.The global call handle within a CiscoCall is accessible via its CallManagerID and CallID properties. Taken together, the CallManagerID and CallID form the global call handle maintained by the CallManager. This pair of properties is guaranteed to be unique among all ACTIVE Call objects, but when an ACTIVE call becomes INACTIVE, its CallManagerID and CallID may be reused to identify a newly-created Call object. Therefore, it is possible for an INACTIVE Call to have identical CallManagerID and CallID properties to those of a currently ACTIVE Call object.See Also:
javax.telephony.Call
ACTIVE,IDLE,INVALIDaddObserver(CallObserver),connect(Terminal, Address, String),getCallCapabilities(Terminal, Address),getCapabilities(Terminal, Address),getConnections(),getObservers(),getProvider(),getState(),removeObserver(CallObserver)addParty(String),conference(Call),consult(TerminalConnection),consult(TerminalConnection),drop(),getCalledAddress(),getCallingAddress(),getCallingTerminal(),getConferenceController(),getConferenceEnable(),getLastRedirectedAddress(),getTransferController(),getTransferEnable(),offHook(Address, Terminal),setConferenceController(TerminalConnection),setConferenceEnable(boolean),setTransferController(TerminalConnection),setTransferEnable(boolean),transfer(String),transfer(String)
Methods
getCallID()
public com.cisco.jtapi.extensions.CiscoCallID getCallID()CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.Returns:the CallID property of this CallgetCurrentCalledAddress()
publicjavax.telephony.AddressgetCurrentCalledAddress()getCurrentCalledPartyDisplayName()
publicjava.lang.StringgetCurrentCalledPartyDisplayName()This interface returns the display of the called party in the call. It returns null if display name is unknown.getCurrentCallingAddress()
publicjavax.telephony.AddressgetCurrentCallingAddress()This interface returns current called address for the call this will return updated calling address every every time call is redirected or transferred
NOTE:
In the CiscoJtapi implementation CallControlCall.getCallingAddress()returns the first calling party of the call i.e. the original calling party
Usage:if ( call instanceof CiscoCall ) {Address currentCalled = ((CiscoCall)call).getCurrentCalling ();}See Also:
javax.telephony.callcontrol.CallControlCallgetCurrentCallingPartyDisplayName()
publicjava.lang.StringgetCurrentCallingPartyDisplayName()This interface returns the display name of the calling party. It returns null if display name is unknown.CiscoCallEv
Declaration
All Superinterfaces
All Known Subinterfaces
CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoTransferEndEv, CiscoTransferStartEvDescription
The CiscoCallEv interface, which extends JTAPI's core javax.telephony.events.CallEv interface, serves as the base interface for all Cisco-extended JTAPI Call events. Every Call-related event in this package extends this interface, directly or indirectly.See Also:
javax.telephony.events.CallEv
Fields
CAUSE_ACCESSINFORMATIONDISCARDED
public static final int CAUSE_ACCESSINFORMATIONDISCARDEDCAUSE_BCBPRESENTLYAVAIL
public static final int CAUSE_BCBPRESENTLYAVAILCAUSE_BCNAUTHORIZED
public static final int CAUSE_BCNAUTHORIZEDCAUSE_BEARERCAPNIMPL
public static final int CAUSE_BEARERCAPNIMPLCAUSE_CALLBEINGDELIVERED
public static final int CAUSE_CALLBEINGDELIVEREDCAUSE_CALLIDINUSE
public static final int CAUSE_CALLIDINUSECAUSE_CALLMANAGER_FAILURE
public static final int CAUSE_CALLMANAGER_FAILURECAUSE_CALLREJECTED
public static final int CAUSE_CALLREJECTEDCAUSE_CALLSPLIT
public static final int CAUSE_CALLSPLITCAUSE_CHANTYPENIMPL
public static final int CAUSE_CHANTYPENIMPLCAUSE_CHANUNACCEPTABLE
public static final int CAUSE_CHANUNACCEPTABLECAUSE_CTIMANAGER_FAILURE
public static final int CAUSE_CTIMANAGER_FAILURECAUSE_DESTINATIONOUTOFORDER
public static final int CAUSE_DESTINATIONOUTOFORDERCAUSE_DESTNUMMISSANDDCNOTSUB
public static final int CAUSE_DESTNUMMISSANDDCNOTSUBCAUSE_FACILITYREJECTED
public static final int CAUSE_FACILITYREJECTEDCAUSE_IDENTIFIEDCHANDOESNOTEXIST
public static final int CAUSE_IDENTIFIEDCHANDOESNOTEXISTCAUSE_IENIMPL
public static final int CAUSE_IENIMPLCAUSE_INBOUNDBLINDTRANSFER
public static final int CAUSE_INBOUNDBLINDTRANSFERCAUSE_INBOUNDCONFERENCE
public static final int CAUSE_INBOUNDCONFERENCECAUSE_INBOUNDTRANSFER
public static final int CAUSE_INBOUNDTRANSFERCAUSE_INCOMINGCALLBARRED
public static final int CAUSE_INCOMINGCALLBARREDCAUSE_INCOMPATABLEDDESTINATION
public static final int CAUSE_INCOMPATABLEDDESTINATIONCAUSE_INTERWORKINGUNSPECIFIED
public static final int CAUSE_INTERWORKINGUNSPECIFIEDCAUSE_INVALIDCALLREFVALUE
public static final int CAUSE_INVALIDCALLREFVALUECAUSE_INVALIDIECONTENTS
public static final int CAUSE_INVALIDIECONTENTSCAUSE_INVALIDMESSAGEUNSPECIFIED
public static final int CAUSE_INVALIDMESSAGEUNSPECIFIEDCAUSE_INVALIDNUMBERFORMAT
public static final int CAUSE_INVALIDNUMBERFORMATCAUSE_INVALIDTRANSITNETSEL
public static final int CAUSE_INVALIDTRANSITNETSELCAUSE_MANDATORYIEMISSING
public static final int CAUSE_MANDATORYIEMISSINGCAUSE_MSGNCOMPATABLEWCS
public static final int CAUSE_MSGNCOMPATABLEWCSCAUSE_MSGTYPENCOMPATWCS
public static final int CAUSE_MSGTYPENCOMPATWCSCAUSE_MSGTYPENIMPL
public static final int CAUSE_MSGTYPENIMPLCAUSE_NETOUTOFORDER
public static final int CAUSE_NETOUTOFORDERCAUSE_NOANSWERFROMUSER
public static final int CAUSE_NOANSWERFROMUSERCAUSE_NOCALLSUSPENDED
public static final int CAUSE_NOCALLSUSPENDEDCAUSE_NOCIRCAVAIL
public static final int CAUSE_NOCIRCAVAILCAUSE_NOERROR
public static final int CAUSE_NOERRORCAUSE_NONSELECTEDUSERCLEARING
public static final int CAUSE_NONSELECTEDUSERCLEARINGCAUSE_NORMALCALLCLEARING
public static final int CAUSE_NORMALCALLCLEARINGCAUSE_NORMALUNSPECIFIED
public static final int CAUSE_NORMALUNSPECIFIEDCAUSE_NOROUTETODDESTINATION
public static final int CAUSE_NOROUTETODDESTINATIONCAUSE_NOROUTETOTRANSITNET
public static final int CAUSE_NOROUTETOTRANSITNETCAUSE_NOUSERRESPONDING
public static final int CAUSE_NOUSERRESPONDINGCAUSE_NUMBERCHANGED
public static final int CAUSE_NUMBERCHANGEDCAUSE_ONLYRDIVEARERCAPAVAIL
public static final int CAUSE_ONLYRDIVEARERCAPAVAILCAUSE_OUTBOUNDCONFERENCE
public static final int CAUSE_OUTBOUNDCONFERENCECAUSE_OUTBOUNDTRANSFER
public static final int CAUSE_OUTBOUNDTRANSFERCAUSE_PROTOCOLERRORUNSPECIFIED
public static final int CAUSE_PROTOCOLERRORUNSPECIFIEDCAUSE_QUALOFSERVNAVAIL
public static final int CAUSE_QUALOFSERVNAVAILCAUSE_RECOVERYONTIMEREXPIRY
public static final int CAUSE_RECOVERYONTIMEREXPIRYCAUSE_REDIRECTED
public static final int CAUSE_REDIRECTEDCAUSE_REQCALLIDHASBEENCLEARED
public static final int CAUSE_REQCALLIDHASBEENCLEAREDCAUSE_REQCIRCNAVIL
public static final int CAUSE_REQCIRCNAVILCAUSE_REQFACILITYNIMPL
public static final int CAUSE_REQFACILITYNIMPLCAUSE_REQFACILITYNOTSUBSCRIBED
public static final int CAUSE_REQFACILITYNOTSUBSCRIBEDCAUSE_RESOURCESNAVAIL
public static final int CAUSE_RESOURCESNAVAILCAUSE_RESPONSETOSTATUSENQUIRY
public static final int CAUSE_RESPONSETOSTATUSENQUIRYCAUSE_SERVNOTAVAILUNSPECIFIED
public static final int CAUSE_SERVNOTAVAILUNSPECIFIEDCAUSE_SERVOPERATIONVIOLATED
public static final int CAUSE_SERVOPERATIONVIOLATEDCAUSE_SERVOROPTNAVAILORIMPL
public static final int CAUSE_SERVOROPTNAVAILORIMPLCAUSE_SUSPCALLBUTNOTTHISONE
public static final int CAUSE_SUSPCALLBUTNOTTHISONECAUSE_SWITCHINGEQUIPMENTCONGESTION
public static final int CAUSE_SWITCHINGEQUIPMENTCONGESTIONCAUSE_TEMPORARYFAILURE
public static final int CAUSE_TEMPORARYFAILURECAUSE_UNALLOCATEDNUMBER
public static final int CAUSE_UNALLOCATEDNUMBERCAUSE_USERBUSY
public static final int CAUSE_USERBUSYMethods
getCiscoCause()
public int getCiscoCause()Returns the CallManager cause for this event.In order to function properly, some applications need to know the reason why an event happened at an endpoint that the application is observing. For example, a Connection may be disconnected because the call was not answered (CAUSE_NOANSWERFROMUSER), or whether the caller it was disconnected because it was rejected (CAUSE_CALLREJECTED).Returns:the CallManager cause for this eventCiscoCallID
Declaration
public interface CiscoCallID extends CiscoObjectContainerAll Superinterfaces
Description
The CiscoCallID object repreents a unique object associated with each call. Aplications may use the object itself or the integer representation of the object returned by the intValue() method.
Methods
getCall()
public com.cisco.jtapi.extensions.CiscoCall getCall()getCallManagerID()
public int getCallManagerID()returns the call manager nodeID of the callgetGlobalCallID()
public int getGlobalCallID()returns the GlobalCallID of the callintValue()
public int intValue()Returns an integer representation of this object, currently a bitwise OR of the CallManagerID and GlobalCallID properties (shifted and truncated appropriately)Returns:an integer representation of this objectCiscoConferenceEndEv
Declaration
public interface CiscoConferenceEndEv extends CiscoCallEvAll Superinterfaces
Description
The CiscoConferenceEndEv event indicates that a transfer operation has completed. This event is reported via the CallControlCallObserver interface.
Fields
ID
public static final int IDMethods
getConferenceControllerAddress()
publicjavax.telephony.AddressgetConferenceControllerAddress()Returns the Address which currently acts as the conference controller for this call —- the initiating call.getConferencedCall()
publicjavax.telephony.CallgetConferencedCall()Returns the call that has been merged. This call is in the Call.INVALID state.getFinalCall()
publicjavax.telephony.CallgetFinalCall()Returns the call that remains active after the conference is completed.getHeldConferenceController()
publicjavax.telephony.TerminalConnectiongetHeldConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the final call. This is the TerminalConnection that was in HELD state when conference was initiated. This method returns null if the conference controller is not being observed.getTalkingConferenceController()
publicjavax.telephony.TerminalConnectiongetTalkingConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.CiscoConferenceStartEv
Declaration
public interface CiscoConferenceStartEv extends CiscoCallEvAll Superinterfaces
Description
The CiscoConferenceStartEv event indicates that a conference operation has started. This event is reported via the CallControlCallObserver interface.
Fields
ID
public static final int IDMethods
getConferenceControllerAddress()
publicjavax.telephony.AddressgetConferenceControllerAddress()Returns the Address which currently acts as the conference controller for this call —- the initiating call.getConferencedCall()
publicjavax.telephony.CallgetConferencedCall()Returns the call that will be conferenced. This is the call that will be merged into the initiating callgetFinalCall()
publicjavax.telephony.CallgetFinalCall()Returns the call that will remain active after the conference is completed. This is the call all calls are finally merged intogetHeldConferenceController()
publicjavax.telephony.TerminalConnectiongetHeldConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed.getTalkingConferenceController()
publicjavax.telephony.TerminalConnectiongetTalkingConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.CiscoConnection
Declaration
public interface CiscoConnection extendsjavax.telephony.callcontrol.CallControlConnection, CiscoObjectContainerAll Superinterfaces
Description
The CiscoConnection interface extends the CallControlConnection interface with additional CallManager-specific capabilities.Applications can use the getReason method to obtain the reason for the creation of this Connection.
ALERTING,DIALING,DISCONNECTED,ESTABLISHED,FAILED,IDLE,INITIATED,NETWORK_ALERTING,NETWORK_REACHED,OFFERED,OFFERING,QUEUED,UNKNOWNCONNECTED,INPROGRESSaccept(),addToAddress(String),getCallControlState(),park(String),redirect(String),reject()disconnect(),getAddress(),getCall(),getCapabilities(),getConnectionCapabilities(Terminal, Address),getState(),getTerminalConnections()
Fields
ADDRESS_SEARCH_SPACE
public static final int ADDRESS_SEARCH_SPACEThis indicates that the redirect should be done using the search space of the redirect controller's address.CALLED_ADDRESS_DEFAULT
public static final int CALLED_ADDRESS_DEFAULTThis option indicates that the default behavior for Cisco JTAPI should apply. Cisco JTAPI's default behavior is the same as CALLED_ADDRESS_UNCHANGED.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
public static final int CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATIONThis option indicates that the calledAddress should be reset to the redirect destination.CALLED_ADDRESS_UNCHANGED
public static final int CALLED_ADDRESS_UNCHANGEDThis option indicates that the calledAddress should remain unchanged after the redirect operation.CALLINGADDRESS_SEARCH_SPACE
public static final int CALLINGADDRESS_SEARCH_SPACEThis indicates that the redirect should be done using the search space of the calling address.DEFAULT_SEARCH_SPACE
public static final int DEFAULT_SEARCH_SPACEThis indicates that the redirect should be done using the search space that is the default for the implementation. The default is to use the calling address's search space.REASON_DIRECTCALL
public static final int REASON_DIRECTCALLThis Connection was the result of a direct call.REASON_FORWARDALL
public static final int REASON_FORWARDALLThis Connection was the result of unconditional forwarding.REASON_FORWARDBUSY
public static final int REASON_FORWARDBUSYThis Connection was the result of a forwarding on busy.REASON_FORWARDNOANSWER
public static final int REASON_FORWARDNOANSWERThis Connection was the result of a forwarding on no answer.REASON_OUTBOUND
public static final int REASON_OUTBOUNDThis Connection is an originating Connection, not a destination Connection.REASON_REDIRECT
public static final int REASON_REDIRECTThis Connection was the result of a redirection.REASON_TRANSFERREDCALL
public static final int REASON_TRANSFERREDCALLThis Connection was the result of a transfer.REDIRECT_DROP_ON_FAILURE
public static final int REDIRECT_DROP_ON_FAILUREThis redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The original call will be dropped if the destination is not valid or if it's busy.REDIRECT_NORMAL
public static final int REDIRECT_NORMALThis redirect mode instructs the implementation to perform redirect if the destination is valid and available. Otherwise, the request will return error. The original call will not be dropped on failure.Methods
getConnectionID()
public com.cisco.jtapi.extensions.CiscoConnectionID getConnectionID()CiscoConnectionID is a unique object that identifier among all ACTIVE calls with the same CallManagerID.Returns:the CallID property of this CallgetReason()
public int getReason()Returns the reason for the creation of this Connection.In order to function properly, some applications need to know the reason why a Connection is created at an endpoint that the application is observing. For example, a voice mail application may want to know whether a caller is someone that wants to leave a message in a voice mailbox (REASON_FORWARDNOANSWER), or whether the caller is trying to access a voice mail box (REASON_DIRECTCALL).The reason for a Connection'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_NORMALAll of the reasons except for REASON_TRANSFERORIGINATION and REASON_NORMAL are associated with inbound, or destination Connections. The REASON_NORMAL reason is associated without outbound, or originating Connections.Returns:the reason for the creation of this Connectionpark()
publicjava.lang.Stringpark()
throws InvalidArgumentException, PrivilegeViolationException, ResourceUnavailableException, InvalidStateExceptionThis method parks the call at a system park port and returns the address of the port. The call can be unparked using this address.Throws:javax.telephony.InvalidStateException, javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidArgumentExceptionredirect(String, int)
publicjavax.telephony.Connectionredirect(java.lang.StringdestinationAddress, int mode)
throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableExceptionThis method overloads the CallControlConnection.redirect() method. It takes a new parameter —- redirectMode. When this parameter is:1. CiscoConnection.REDIRECT_DROP_ON_FAILURE This mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The original call will be dropped if the destination is not valid or if it's busy.2. CiscoConnection.REDIRECT_NORMAL This mode instructs the implementation to perform redirect only after checking the validity or availability of the destination. This is the same as the CallControlConnection.redirect() method. The original call will not be dropped on failure.Throws:javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateExceptionredirect(String, int, int)
publicjavax.telephony.Connectionredirect(java.lang.StringdestinationAddress, int mode, int callingSearchSpace)
throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableExceptionThis 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_FAILURE2. CiscoConnection.REDIRECT_NORMALRead above for a description of what each of these means.
The callingSearchSpace parameter may be:1. CiscoConnection.DEFAULT_SEARCH_SPACE2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE3. CiscoConnection.ADDRESS_SEARCH_SPACERead above for a description of what each of these means.
NOTE: The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.Throws:javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateExceptionredirect(String, int, int, int)
publicjavax.telephony.Connectionredirect(java.lang.StringdestinationAddress, int mode, int callingSearchSpace, int calledAddressOption)
throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, PrivilegeViolationException, ResourceUnavailableExceptionThis method overloads the CallControlConnection.redirect() method. It takes three new parameters —- redirectMode, callingSearchSpace and calledAddressOption. The redirectMode is used to select which type of redirect to perform, and the callingSearchSpace is used to instruct the implementation to use either the calling party's search space or the redirect controller's search space. The calledAddressOption parameter is used to decide whether to reset the original called fiels or not.
The redirectMode parameter may be:1. CiscoConnection.REDIRECT_DROP_ON_FAILURE2. CiscoConnection.REDIRECT_NORMALRead above for a description of what each of these means.
The callingSearchSpace parameter may be:1. CiscoConnection.DEFAULT_SEARCH_SPACE2. CiscoConnection.CALLINGADDRESS_SEARCH_SPACE3. CiscoConnection.ADDRESS_SEARCH_SPACERead above for a description of what each of these means.
NOTE: The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.
* The calledAddressOption parameter may be:1. CiscoConnection.CALLED_ADDRESS_DEFAULT2. CiscoConnection.CALLED_ADDRESS_UNCHANGED3. CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATIONRead above for a description of what each of these means.
Throws:javax.telephony.ResourceUnavailableException, javax.telephony.PrivilegeViolationException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidPartyException, javax.telephony.InvalidStateExceptionCiscoConnectionID
Declaration
public interface CiscoConnectionID extends CiscoObjectContainerAll Superinterfaces
Description
The CiscoConnectionID object represents a unique object associated with each connection. Aplications may use the object itself or the integer representation of the object returned by the intValue() method.
Methods
getConnection()
public com.cisco.jtapi.extensions.CiscoConnection getConnection()intValue()
public int intValue()Returns an integer representation of this object, currently the CallManager CallLeg ID.Returns:an integer representation of this objectCiscoConsultCall
Declaration
public interface CiscoConsultCall extends CiscoCallAll Superinterfaces
Description
The CiscoConsultCall interface extends the CiscoCall interface to expose certain properties of Calls that have been created as part of a consultative transfer or consultative conference.See Also:
javax.telephony.Call
ACTIVE,IDLE,INVALIDaddObserver(CallObserver),connect(Terminal, Address, String),getCallCapabilities(Terminal, Address),getCapabilities(Terminal, Address),getConnections(),getObservers(),getProvider(),getState(),removeObserver(CallObserver)addParty(String),conference(Call),consult(TerminalConnection),consult(TerminalConnection),drop(),getCalledAddress(),getCallingAddress(),getCallingTerminal(),getConferenceController(),getConferenceEnable(),getLastRedirectedAddress(),getTransferController(),getTransferEnable(),offHook(Address, Terminal),setConferenceController(TerminalConnection),setConferenceEnable(boolean),setTransferController(TerminalConnection),setTransferEnable(boolean),transfer(String),transfer(String)
Methods
consultWithoutMedia(TerminalConnection, String)
publicjavax.telephony.Connection[]consultWithoutMedia(javax.telephony.TerminalConnectiontc,java.lang.StringdialedDigits)
throws InvalidStateException, InvalidArgumentException, MethodNotSupportedException, ResourceUnavailableException, PrivilegeViolationException, InvalidPartyExceptionFrom CallEvent perspective, this method behaves similar to CallControlCall.consult(TerminalConnection tc, String dialedDigits). Creates a consultation between this Call and an active Call without establishing the media. This consult call may only be transferred, not conferenced.The Consultation PurposeThis method does not support if invoked with CallControlCall.setConferneceEnable(). It only supports if invoked with CallControlCall.setTransferEnable().Throws:javax.telephony.InvalidPartyException, javax.telephony.PrivilegeViolationException, javax.telephony.ResourceUnavailableException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException, javax.telephony.InvalidStateExceptiongetConsultingTerminalConnection()
publicjavax.telephony.TerminalConnectiongetConsultingTerminalConnection()Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.If this Call was created as part of a consultative transfer or consultative conference, the TerminalConnection which was used to perform the consultation on the original Call is returned by the getConsultingTerminalConnection method. This may be useful to applications that wish to correlate a ConsultCall with its original Call. Note that the original Call does not have any methods which may be used to determine the ConsultCall, if any, to which it is related.Returns:null if this Call is not the result of a consultation, or the consulting TerminalConnection of the original Call if this Call is the result of a consultation.CiscoConsultCallActiveEv
Declaration
All Superinterfaces
javax.telephony.events.CallActiveEv, javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.EvDescription
The CiscoConsultCallActiveEv event interface extends the JTAPI CallActiveEv. It indicates that the state of the Call object has changed to Call.ACTIVE and that the call was initiated as a result of a consultative transfer or consultative conference operation (manual or programmatic). Applications can obtain the consulting TerminalConnection on the original (consulting) call by using the CiscoConsultCall.getConsultingTerminalConnection method.This event is reported to applications via the CallObserver interface.See Also:
javax.telephony.Call, javax.telephony.CallObserver, javax.telephony.events.CallActiveEv
Fields
ID
public static final int IDMethods
getHeldTerminalConnection()
publicjavax.telephony.TerminalConnectiongetHeldTerminalConnection()Deprecated.replaced by CiscoConsultCall.getConsultingTerminalConnection ()Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.This may be useful to applications that wish to correlate a consultation Call with its original Call. Note that the original Call does not have any methods which may be used to determine the consultation Call, if any, to which it is related.Returns:the consulting TerminalConnection of the Call that created the Call referenced by this eventCiscoEv
Declaration
public interface CiscoEv extendsjavax.telephony.events.EvAll Superinterfaces
javax.telephony.events.EvAll Known Subinterfaces
CiscoAddrCreatedEv, CiscoAddrEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv, CiscoAddrRemovedEv, CiscoCallEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoOutOfServiceEv, CiscoProvCallParkEv, CiscoProvEv, CiscoProvFeatureEv, CiscoProvFeatureUnRegisteredEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputStartedEv, CiscoRTPOutputStoppedEv, CiscoTermCreatedEv, CiscoTermDataEv, CiscoTermEv, CiscoTermInServiceEv, CiscoTermOutOfServiceEv, CiscoTermRemovedEv, CiscoTransferEndEv, CiscoTransferStartEvDescription
The CiscoEv interface, which extends JTAPI's core javax.telephony.events.Ev interface, serves as the base interface for all Cisco-extended JTAPI events. Every event in this package extends this interface, directly or indirectly.See Also:
javax.telephony.events.Ev
CiscoG711MediaCapability
Declaration
public class CiscoG711MediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoG711MediaCapabilityDescription
The CiscoG711MediaCapability object specifies the properties for a G.711 encoded RTP stream. Applications that support G.711 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.The default packet size is thirty milliseconds.
clone(),equals(Object),finalize(),getClass(),hashCode(),notify(),notifyAll(),wait(),wait(),wait()
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packetsFRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packetsFRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packetsConstructors
CiscoG711MediaCapability()
public CiscoG711MediaCapability()Constructs a CiscoG711MediaCapability</CODE object with a default thirty millisecond packet size.CiscoG711MediaCapability(int)
public CiscoG711MediaCapability(int maxFramesPerPacket)Constructs a CiscoG711MediaCapability</CODE object with the specified packet size.CiscoG723MediaCapability
Declaration
public class CiscoG723MediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoG723MediaCapabilityDescription
The CiscoG723MediaCapability object specifies the properties for a G.723 encoded RTP stream. Applications that support G.723 media termination use this object to specify their preferred packet size and bit rate when registering a CiscoMediaTerminal.The default packet size is thirty milliseconds and the default bit rate is 6.4k.
clone(),equals(Object),finalize(),getClass(),hashCode(),notify(),notifyAll(),wait(),wait(),wait()
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packetsFRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packetsFRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packetsConstructors
CiscoG723MediaCapability()
public CiscoG723MediaCapability()Constructs a CiscoG723MediaCapability</CODE object with a default thirty millisecond packet size and 6.4k bit rate.CiscoG723MediaCapability(int, int)
public CiscoG723MediaCapability(int maxFramesPerPacket, int bitRate)Constructs a CiscoG723MediaCapability</CODE object with the specified packet size and bit rate.Methods
getBitRate()
public int getBitRate()Returns the bit rate specified by this capability object.Returns:a bit rate from the RTPBitRate interfacetoString()
publicjava.lang.StringtoString()Overrides:toString in class CiscoMediaCapabilityCiscoG729MediaCapability
Declaration
public class CiscoG729MediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoG729MediaCapabilityDescription
The CiscoG729MediaCapability object specifies the properties for a G.729 encoded RTP stream. Applications that support G.729 media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.The default packet size is thirty milliseconds.
clone(),equals(Object),finalize(),getClass(),hashCode(),notify(),notifyAll(),wait(),wait(),wait()
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packetsFRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets•
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packetsConstructors
CiscoG729MediaCapability()
public CiscoG729MediaCapability()Constructs a CiscoG729MediaCapability</CODE object with a default G729 payload and thirty millisecond packet size.CiscoG729MediaCapability(int, int)
public CiscoG729MediaCapability(int payload, int maxFramesPerPacket)Constructs a CiscoG729MediaCapability</CODE object with the specified packet size and payload. Choice of payload is specified in CiscoRTPPayload with the options CiscoRTPPayload.G729 and CiscoRTPPayload.G729ANNEXACiscoGSMMediaCapability
Declaration
public class CiscoGSMMediaCapability extends CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapability|+--com.cisco.jtapi.extensions.CiscoGSMMediaCapabilityDescription
The CiscoGSMMediaCapability object specifies the properties for a GSM encoded RTP stream. Applications that support GSM media termination use this object to specify their preferred packet size when registering a CiscoMediaTerminal.The default packet size is thirty milliseconds.
clone(),equals(Object),finalize(),getClass(),hashCode(),notify(),notifyAll(),wait(),wait(),wait()
Fields
FRAMESIZE_EIGHTY_MILLISECOND_PACKET
public static final int FRAMESIZE_EIGHTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packetsConstructors
CiscoGSMMediaCapability()
public CiscoGSMMediaCapability()Constructs a CiscoGSMMediaCapability</CODE object with a default eighty millisecond packet size.CiscoGSMMediaCapability(int)
public CiscoGSMMediaCapability(int maxFramesPerPacket)Constructs a CiscoGSMMediaCapability</CODE object with the specified packet size.CiscoJtapiException
Declaration
public interface CiscoJtapiExceptionDescription
The CiscoJtapiException interface defines CTI error codes. These are the error codes that may be returned by CTI requests. All the JTAPI exceptions have been extended to implement this interface. The Error codes can be got by casting the exception to CiscoJtapiException and calling the method getErrorCode(). if e is any exception caught in an application, then try to see if its an instanceof CiscoJtapiException.
try {
// some code here }
catch ( Exception e ) {
if( e instanceof CiscoJtapiException){
CiscoJtapiException ce = com.cisco.cti.client.CTIFAILURE.(CiscoJtapiException) e
int errorCode = com.cisco.cti.client.CTIFAILURE.ce.getErrorCode() //returns the ErrorCode.
}
}
Fields
ASSOCIATED_LINE_NOT_OPEN
public static final int ASSOCIATED_LINE_NOT_OPENCALL_ALREADY_EXISTS
public static final int CALL_ALREADY_EXISTSCALLHANDLE_NOTINCOMINGCALL
public static final int CALLHANDLE_NOTINCOMINGCALLCALLHANDLE_UNKNOWN_TO_LINECONTROL
public static final int CALLHANDLE_UNKNOWN_TO_LINECONTROLCANNOT_OPEN_DEVICE
public static final int CANNOT_OPEN_DEVICECANNOT_TERMINATE_MEDIA_ON_PHONE
public static final int CANNOT_TERMINATE_MEDIA_ON_PHONECFWDALL_ALREADY_OFF
public static final int CFWDALL_ALREADY_OFFCFWDALL_ALREADY_SET
public static final int CFWDALL_ALREADY_SETCFWDALL_DESTN_INVALID
public static final int CFWDALL_DESTN_INVALIDCLUSTER_LINK_FAILURE
public static final int CLUSTER_LINK_FAILURECOMMAND_NOT_IMPLEMENTED_ON_DEVICE
public static final int COMMAND_NOT_IMPLEMENTED_ON_DEVICECONFERENCE_ALREADY_PRESENT
public static final int CONFERENCE_ALREADY_PRESENTCONFERENCE_FAILED
public static final int CONFERENCE_FAILEDCONFERENCE_FULL
public static final int CONFERENCE_FULLCONFERENCE_INACTIVE
public static final int CONFERENCE_INACTIVECONFERENCE_INVALID_PARTICIPANT
public static final int CONFERENCE_INVALID_PARTICIPANTCTIERR_INCORRECT_MEDIA_CAPABILITY
public static final int CTIERR_INCORRECT_MEDIA_CAPABILITYCTIERR_INVALID_DTMFDIGITS
public static final int CTIERR_INVALID_DTMFDIGITSCTIERR_OPERATION_FAILED_QUIETCLEAR
public static final int CTIERR_OPERATION_FAILED_QUIETCLEARDARES_INVALID_REQ_TYPE
public static final int DARES_INVALID_REQ_TYPEDATA_SIZE_LIMIT_EXCEEDED
public static final int DATA_SIZE_LIMIT_EXCEEDEDDB_ERROR
public static final int DB_ERRORDB_ILLEGAL_DEVICE_TYPE
public static final int DB_ILLEGAL_DEVICE_TYPEDB_NO_MORE_DEVICES
public static final int DB_NO_MORE_DEVICESDESTINATION_BUSY
public static final int DESTINATION_BUSYDESTINATION_UNKNOWN
public static final int DESTINATION_UNKNOWNDEVICE_ALREADY_REGISTERED
public static final int DEVICE_ALREADY_REGISTEREDDEVICE_NOT_OPEN
public static final int DEVICE_NOT_OPENDEVICE_OUT_OF_SERVICE
public static final int DEVICE_OUT_OF_SERVICEDIGIT_GENERATION_ALREADY_IN_PROGRESS
public static final int DIGIT_GENERATION_ALREADY_IN_PROGRESSDIGIT_GENERATION_CALLSTATE_CHANGED
public static final int DIGIT_GENERATION_CALLSTATE_CHANGEDDIGIT_GENERATION_WRONG_CALL_HANDLE
public static final int DIGIT_GENERATION_WRONG_CALL_HANDLEDIGIT_GENERATION_WRONG_CALL_STATE
public static final int DIGIT_GENERATION_WRONG_CALL_STATEDIRECTORY_LOGIN_FAILED
public static final int DIRECTORY_LOGIN_FAILEDDIRECTORY_LOGIN_NOT_ALLOWED
public static final int DIRECTORY_LOGIN_NOT_ALLOWEDDIRECTORY_TEMPORARY_UNAVAILABLE
public static final int DIRECTORY_TEMPORARY_UNAVAILABLEEXISTING_FIRSTPARTY
public static final int EXISTING_FIRSTPARTYHOLDFAILED
public static final int HOLDFAILEDILLEGAL_CALLINGPARTY
public static final int ILLEGAL_CALLINGPARTYILLEGAL_CALLSTATE
public static final int ILLEGAL_CALLSTATEILLEGAL_HANDLE
public static final int ILLEGAL_HANDLEILLEGAL_MESSAGE_FORMAT
public static final int ILLEGAL_MESSAGE_FORMATINCOMPATIBLE_PROTOCOL_VERSION
public static final int INCOMPATIBLE_PROTOCOL_VERSIONINVALID_LINE_HANDLE
public static final int INVALID_LINE_HANDLEINVALID_RING_OPTION
public static final int INVALID_RING_OPTIONLINE_INFO_DOES_NOT_EXIST
public static final int LINE_INFO_DOES_NOT_EXISTLINE_NOT_PRIMARY
public static final int LINE_NOT_PRIMARYLINECONTROL_FAILURE
public static final int LINECONTROL_FAILUREMAX_NUMBER_OF_CTI_CONNECTIONS_REACHED
public static final int MAX_NUMBER_OF_CTI_CONNECTIONS_REACHEDMSGWAITING_DESTN_INVALID
public static final int MSGWAITING_DESTN_INVALIDNO_ACTIVE_DEVICE_FOR_THIRDPARTY
public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTYNO_CONFERENCE_BRIDGE
public static final int NO_CONFERENCE_BRIDGENOT_INITIALIZED
public static final int NOT_INITIALIZEDPROTOCOL_TIMEOUT
public static final int PROTOCOL_TIMEOUTPROVIDER_ALREADY_OPEN
public static final int PROVIDER_ALREADY_OPENPROVIDER_CLOSED
public static final int PROVIDER_CLOSEDPROVIDER_NOT_OPEN
public static final int PROVIDER_NOT_OPENREDIRECT_CALL_CALL_TABLE_FULL
public static final int REDIRECT_CALL_CALL_TABLE_FULLREDIRECT_CALL_DESTINATION_BUSY
public static final int REDIRECT_CALL_DESTINATION_BUSYREDIRECT_CALL_DESTINATION_OUT_OF_ORDER
public static final int REDIRECT_CALL_DESTINATION_OUT_OF_ORDERREDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUT
public static final int REDIRECT_CALL_DIGIT_ANALYSIS_TIMEOUTREDIRECT_CALL_DOES_NOT_EXIST
public static final int REDIRECT_CALL_DOES_NOT_EXISTREDIRECT_CALL_INCOMPATIBLE_STATE
public static final int REDIRECT_CALL_INCOMPATIBLE_STATEREDIRECT_CALL_MEDIA_CONNECTION_FAILED
public static final int REDIRECT_CALL_MEDIA_CONNECTION_FAILEDREDIRECT_CALL_NORMAL_CLEARING
public static final int REDIRECT_CALL_NORMAL_CLEARINGREDIRECT_CALL_ORIGINATOR_ABANDONED
public static final int REDIRECT_CALL_ORIGINATOR_ABANDONEDREDIRECT_CALL_PARTY_TABLE_FULL
public static final int REDIRECT_CALL_PARTY_TABLE_FULLREDIRECT_CALL_PENDING_REDIRECT_TRANSACTION
public static final int REDIRECT_CALL_PENDING_REDIRECT_TRANSACTIONREDIRECT_CALL_PROTOCOL_ERROR
public static final int REDIRECT_CALL_PROTOCOL_ERRORREDIRECT_CALL_UNKNOWN_DESTINATION
public static final int REDIRECT_CALL_UNKNOWN_DESTINATIONREDIRECT_CALL_UNKNOWN_ERROR
public static final int REDIRECT_CALL_UNKNOWN_ERRORREDIRECT_CALL_UNKNOWN_PARTY
public static final int REDIRECT_CALL_UNKNOWN_PARTYREDIRECT_CALL_UNRECOGNIZED_MANAGER
public static final int REDIRECT_CALL_UNRECOGNIZED_MANAGERREDIRECT_CALLINFO_ERR
public static final int REDIRECT_CALLINFO_ERRREDIRECT_ERR
public static final int REDIRECT_ERRRETRIEVEFAILED
public static final int RETRIEVEFAILEDRETRIEVEFAILED_ACTIVE_CALL_ON_LINE
public static final int RETRIEVEFAILED_ACTIVE_CALL_ON_LINESSAPI_NOT_REGISTERED
public static final int SSAPI_NOT_REGISTEREDTEMPORARY_FAILURE
public static final int TEMPORARY_FAILURETIMEOUT
public static final int TIMEOUTTRANSFER_INACTIVE
public static final int TRANSFER_INACTIVETRANSFERFAILED
public static final int TRANSFERFAILEDTRANSFERFAILED_CALLCONTROL_TIMEOUT
public static final int TRANSFERFAILED_CALLCONTROL_TIMEOUTTRANSFERFAILED_DESTINATION_BUSY
public static final int TRANSFERFAILED_DESTINATION_BUSYTRANSFERFAILED_DESTINATION_UNALLOCATED
public static final int TRANSFERFAILED_DESTINATION_UNALLOCATEDTRANSFERFAILED_OUTSTANDING_TRANSFER
public static final int TRANSFERFAILED_OUTSTANDING_TRANSFERUNDEFINED_LINE
public static final int UNDEFINED_LINEUNKNOWN_GLOBAL_CALL_HANDLE
public static final int UNKNOWN_GLOBAL_CALL_HANDLEUNRECOGNIZABLE_PDU
public static final int UNRECOGNIZABLE_PDUUNSPECIFIED
public static final int UNSPECIFIEDThe CTI error codes. These are the error codes that may be returned by CTI requests.Methods
getErrorCode()
public int getErrorCode()Returns the errorCode for this exceptionReturns:errorCode in an integer representationgetErrorDescription()
publicjava.lang.StringgetErrorDescription()This method returns the detail description of the errorCodeReturns:String detail description of the errorCodegetErrorDescription(int)
publicjava.lang.StringgetErrorDescription(int errorCode)Deprecated.instead use String getErrorDescription ();This method returns the detail description of the errorCodeReturns:String detail description of the errorCodegetErrorName()
publicjava.lang.StringgetErrorName()This method returns an exception in the string format.Returns:String representation of the error codegetErrorName(int)
publicjava.lang.StringgetErrorName(int errorCode)Deprecated.instead use String getErrorName ();This method will return an exception in the string format.Returns:String representation of the error codeCiscoJtapiPeer
Declaration
public interface CiscoJtapiPeer extendscom.cisco.services.tracing.TraceModule,javax.telephony.JtapiPeer, CiscoObjectContainerAll Superinterfaces
Description
By extending the com.cisco.services.tracing.TraceModule interface, the CiscoJtapiPeer exposes trace information to applications. All instances of JtapiPeer objects created by the Cisco JTAPI implementation implement this interface. Applications that wish to manipulate the trace settings of the Cisco JTAPI implementation may use the CiscoJtapiPeer.getTraceManager method to obtain its TraceManager object. The TraceManager object may then be manipulated as described in the com.cisco.services.tracing package.See Also:
com.cisco.services.tracing.TraceModule
getName(),getProvider(String),getServices()getTraceManager(),getTraceModuleName()
Methods
getJtapiProperties()
public com.cisco.jtapi.extensions.CiscoJtapiProperties getJtapiProperties()CiscoJtapiProperties defines the various methods that applications can use to modify the parameters that the JTAPI layer will use.See Also:CiscoJtapiProperties
Declaration
public interface CiscoJtapiPropertiesDescription
Cisco JTAPI's behaviour and functionality is tailored by many parameters which are read in from the jtapi.ini file when an instance of CiscoJtapiPeer is instantiated. These parameters are now exposed to applications for control via this CiscoJtapiproperties interface.
Applications can query the CiscoJtapiproperties properties object and change these parameters to better suit the application functionality. Exposing these properties via the CiscoJtapiproperties interface also allows applications to have a single point of administration (at the application end) for these parameters.
The most visible parameters are those describing the tracing levels and tracing destinations.
Usage:
JtapiPeer peer = JtapiPeerFactory.getJtapiPeer ( null );
if(peer instanceof CiscoJtapiPeer){
CiscoJtapiProperties jProps = ((CiscoJtapiPeer)peer).getJtapiProperties();
jProps.setTracePath("\\D:\\Traces\\WorkFlow");
jProps.setUseJavaConsoleTrace(false);
MyProviderObserver providerObserver = new MyProviderObserver ();
provider = peer.getProvider ( providerName );
}
In the above example an application has set the java console tracing to off and set the trace path to D:\Traces\WorkFlowApp1
When the peer is obtained an object implementing CiscoJtapiProperties is created by reading parameters set in the jtapi.ini file. If no jtapi.ini file exists in the classpath default settings are used to create this object.
The parameters used by Cisco Jtapi are read in and frozen when the first getProvider () call is made.
Methods
getAlarmServiceHostname()
publicjava.lang.StringgetAlarmServiceHostname()get the alarm service host namegetAlarmServicePort()
public int getAlarmServicePort()get the port number for the alarm servicegetCtiRequestTimeout()
public int getCtiRequestTimeout()get the timout for cti requests, other than the provider open (seconds)getDebuggingNames()
publicjava.lang.String[]getDebuggingNames()get names of supported debugging level jtapi tracesgetDebuggingValue(String)
public boolean getDebuggingValue(java.lang.StringdebuggingName)get the enabled or disabled state of a debugging level tracegetDesiredServerHeartbeatInterval()
public int getDesiredServerHeartbeatInterval()get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.getFileNameBase()
publicjava.lang.StringgetFileNameBase()the filename for individual log files.getFileNameExtension()
publicjava.lang.StringgetFileNameExtension()get the filename extension for log filesgetNumTraceFiles()
public int getNumTraceFiles()number of trace files before rollovergetPeriodicWakeupEnabled()
public boolean getPeriodicWakeupEnabled()get the enabled state of periodic wake upgetPeriodicWakeupInterval()
public int getPeriodicWakeupInterval()get the interval for periodic wakeup (milliseconds)getProviderOpenRequestTimeout()
public int getProviderOpenRequestTimeout()get the timout for a provider open request (seconds)getProviderRetryInterval()
public int getProviderRetryInterval()get the interval at which the connection to the CTI Manager will ge retried (seconds)getQueueSizeThreshold()
public int getQueueSizeThreshold()Get the threshold for the event queue size to trigger alarmsgetQueueStatsEnabled()
public boolean getQueueStatsEnabled()get the enabled state of event queue statsgetRouteSelectTimeout()
public int getRouteSelectTimeout()get the route select timeout (milliseconds)getServices()
publicjava.lang.String[]getServices()Returns the services that this implementation supports. Note: This is a static list administered in the jtapi.ini file. There is no automatic discovery mechanism to locate available cti servicesgetSyslogCollector()
publicjava.lang.StringgetSyslogCollector()get the syslog collector hostnamegetSyslogCollectorUDPPort()
public int getSyslogCollectorUDPPort()get the syslog collector UDP portgetTraceDirectory()
publicjava.lang.StringgetTraceDirectory()The directory in the path where trace files will be writtengetTraceFileSize()
public int getTraceFileSize()The size of the tracefiles before rollovergetTraceNames()
publicjava.lang.String[]getTraceNames()get the names of supported jtapi tracesgetTracePath()
publicjava.lang.StringgetTracePath()get the path where the trace files will be locatedgetTraceValue(String)
public boolean getTraceValue(java.lang.StringtraceName)get the enabled or disabled state of a tracegetUseAlarmService()
public boolean getUseAlarmService()get the enabled/disabled state of the alarm servicegetUseFileTrace()
public boolean getUseFileTrace()get the enabled or disabled state of jtapi log file tracinggetUseJavaConsoleTrace()
public boolean getUseJavaConsoleTrace()get the enabled or disabled state of jtapi console tracinggetUseSameDir()
public boolean getUseSameDir()if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a seperate directory, indexed in sequence from the last directory written or available.getUseSyslog()
public boolean getUseSyslog()get the enabled or disabled state of syslog tracingsetAlarmServiceHostname(String)
public void setAlarmServiceHostname(java.lang.Stringhostname)set the alarm service host namesetAlarmServicePort(int)
public void setAlarmServicePort(int portNumber)set the port number the alarm service is listening onsetCtiRequestTimeout(int)
public void setCtiRequestTimeout(int seconds)set the timeout for cti requests other than provider open (seconds)setDebuggingValue(String, boolean)
public void setDebuggingValue(java.lang.StringdebuggingName, boolean value)enable or disable a particular debugging level tracesetDesiredServerHeartbeatInterval(int)
public void setDesiredServerHeartbeatInterval(int seconds)set the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.setFileNameBase(String)
public void setFileNameBase(java.lang.Stringbase)set the filename for log filessetFileNameExtension(String)
public void setFileNameExtension(java.lang.Stringextn)set the filename extension for log filessetNumTraceFiles(int)
public void setNumTraceFiles(int val)set the number of trace files before rolloversetPeriodicWakeupEnabled(boolean)
public void setPeriodicWakeupEnabled(boolean enabled)set the enable/disable state for periodic wake upsetPeriodicWakeupInterval(int)
public void setPeriodicWakeupInterval(int milliseconds)set the periodic wake up interval (milliseconds)setProviderOpenRequestTimeout(int)
public void setProviderOpenRequestTimeout(int seconds)set the timeout for a provider open request (seconds)setProviderRetryInterval(int)
public void setProviderRetryInterval(int seconds)set the interval at which the connection to the CTI Manager will ge retried (seconds)setQueueSizeThreshold(int)
public void setQueueSizeThreshold(int size)Set the threshold for the event queue size to trigger alarmssetQueueStatsEnabled(boolean)
public void setQueueStatsEnabled(boolean enabled)enable / disable event queue statisticssetRouteSelectTimeout(int)
public void setRouteSelectTimeout(int milliseconds)set the route select timeout millisecondssetServices(String[])
public void setServices(java.lang.String[]services)set a list of available servicessetSyslogCollector(String)
public void setSyslogCollector(java.lang.Stringvalue)set the syslog collector hostnamesetSyslogCollectorUDPPort(int)
public void setSyslogCollectorUDPPort(int port)set the syslog collector UDP portsetTraceDirectory(String)
public void setTraceDirectory(java.lang.Stringdir)Set the directory where jtapi trace files should be writtensetTraceFileSize(int)
public void setTraceFileSize(int val)Set the size of the trace filesetTracePath(String)
public void setTracePath(java.lang.Stringpath)set the directory root where jtapi traces will be writtensetTraceValue(String, boolean)
public void setTraceValue(java.lang.StringtraceName, boolean value)enable or disable a particular tracesetUseAlarmService(boolean)
public void setUseAlarmService(boolean value)enable the alarm servicesetUseFileTrace(boolean)
public void setUseFileTrace(boolean value)enable or disable jtapi log file tracingsetUseJavaConsoleTrace(boolean)
public void setUseJavaConsoleTrace(boolean value)enable or disable jtapi console tracingsetUseSameDir(boolean)
public void setUseSameDir(boolean value)if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a seperate directory, indexed in sequence from the last directory written or available.setUseSyslog(boolean)
public void setUseSyslog(boolean value)enable or disable syslog tracingCiscoJtapiVersion
Declaration
public class CiscoJtapiVersionjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoJtapiVersionDescription
This class gives the version information of the installed Cisco JTAPI . Programs can get the version number using the accessor methods. Cisco Jtapi Version is in a.b(x.y) format where a indicates the major version b indicates the minor version x indicates the revision number y indicates the build number
clone(),equals(Object),finalize(),getClass(),hashCode(),notify(),notifyAll(),wait(),wait(),wait()
Constructors
CiscoJtapiVersion()
public CiscoJtapiVersion()Methods
getBuildDescription()
publicjava.lang.StringgetBuildDescription()Returns 'release' if it is a release version or debug if it is not a release versiongetBuildNumber()
public int getBuildNumber()This returns the build number of the vesiongetMajorVersion()
public int getMajorVersion()This method returns the major version numbergetMinorVersion()
public int getMinorVersion()This method returns the minor version numbergetRevisionNumber()
public int getRevisionNumber()This method returns the revision number of the versiongetVersion()
publicjava.lang.StringgetVersion()returns the version information in a.b(x.y) format without nametoString()
publicjava.lang.StringtoString()returns the version information in a.b(x.y) formatOverrides:toString in class ObjectCiscoMediaCapability
Declaration
public class CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.CiscoMediaCapabilityDirect Known Subclasses
CiscoG711MediaCapability, CiscoG723MediaCapability, CiscoG729MediaCapability, CiscoGSMMediaCapabilityDescription
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
clone(),equals(Object),finalize(),getClass(),hashCode(),notify(),notifyAll(),wait(),wait(),wait()
Fields
G711_64K_30_MILLISECONDS
public static final com.cisco.jtapi.extensions.CiscoMediaCapability G711_64K_30_MILLISECONDSG.711 capability with default parametersSee Also:
G723_6K_30_MILLISECONDS
public static final com.cisco.jtapi.extensions.CiscoMediaCapability G723_6K_30_MILLISECONDSG.723 capability with default parametersSee Also:
G729_30_MILLISECONDS
public static final com.cisco.jtapi.extensions.CiscoMediaCapability G729_30_MILLISECONDSG.729 capability with default parametersSee Also:
GSM_80_MILLISECONDS
public static final com.cisco.jtapi.extensions.CiscoMediaCapability GSM_80_MILLISECONDSGSM capability with default parametersSee Also:
Constructors
CiscoMediaCapability(int, int)
public CiscoMediaCapability(int payloadType, int maxFramesPerPacket)Constructs a CiscoMediaCapability object for the specified payload type and packet size.Methods
getMaxFramesPerPacket()
public int getMaxFramesPerPacket()Returns the packet size specified by this object.Returns:the packet size, specified as a the number of frames within a single packetgetPayloadType()
public int getPayloadType()Returns the payload type specified by this object.Returns:a payload type from the RTPPayload interfacetoString()
publicjava.lang.StringtoString()Overrides:toString in class ObjectCiscoMediaTerminal
Declaration
public interface CiscoMediaTerminal extends CiscoTerminalAll Superinterfaces
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
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:
addCallObserver(CallObserver),addObserver(TerminalObserver),getAddresses(),getCallObservers(),getCapabilities(),getName(),getObservers(),getProvider(),getTerminalCapabilities(Terminal, Address),getTerminalConnections(),removeCallObserver(CallObserver),removeObserver(TerminalObserver)
Methods
changeRTPDefaults(InetAddress, int)
public void changeRTPDefaults(java.net.InetAddressaddress, int port)
throws CiscoRegistrationExceptionChanges the default registration parameters to specified address and port. Only Registered application may invoke this method.Parameters:address - the internet address for inbound RTP streams on this terminalport - the UDP port for inbound RTP streams on this terminalThrows:isRegistered()
public boolean isRegistered()This method returns true if the CiscoMediaTerminal is registered and false otherwise.register(InetAddress, int)
public void register(java.net.InetAddressaddress, int port)
throws CiscoRegistrationExceptionDeprecated.Registers a Terminal with the specified address and port, defaulting to G.711 64KHz u-law encoding with a thirty millisecond packet size.Parameters:address - the internet address for inbound RTP streams on this terminalport - the UDP port for inbound RTP streams on this terminalThrows:register(InetAddress, int, CiscoMediaCapability[])
public void register(java.net.InetAddressaddress, int port, com.cisco.jtapi.extensions.CiscoMediaCapability[] capabilities)
throws CiscoRegistrationExceptionThe 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 ArgumentsThis 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-conditionsThis method returns successfully when the MediaTerminal is registered.Parameters:address - the internet address for inbound RTP streams on this terminalport - the UDP port for inbound RTP streams on this terminalcapabilities - the list of RTP encodings supported by this terminalThrows:unregister()
public void unregister()
throws CiscoUnregistrationExceptionThe CiscoMediaTerminal must not be registered and its Provider must be in the Provider.IN_SERVICE state. The successful effect of this method is to unregister the MediaTerminal.Method Post-conditionsThis method returns successfully when the MediaTerminal is unregistered.Throws:CiscoObjectContainer
Declaration
public interface CiscoObjectContainerAll Known Subinterfaces
CiscoAddress, CiscoCall, CiscoCallID, CiscoConnection, CiscoConnectionID, CiscoConsultCall, CiscoJtapiPeer, CiscoMediaTerminal, CiscoProvider, CiscoTerminal, CiscoTerminalConnectionDescription
The ApplicationObject interface allows applications to associate an application defined object to objects that implement this interface.
Methods
getObject()
publicjava.lang.ObjectgetObject()Gets the application-defined object.Returns:the CallID property of this CallsetObject(Object)
publicjava.lang.ObjectsetObject(java.lang.Objectreference)Sets an application-defined object.Returns:the CallManagerID property of this CallCiscoOutOfServiceEv
Declaration
public interface CiscoOutOfServiceEv extends CiscoEvAll Superinterfaces
CiscoEv, javax.telephony.events.EvAll Known Subinterfaces
Description
The CiscoAddrOutOfServiceEv event
Fields
CAUSE_CALLMANAGER_FAILURE
public static final int CAUSE_CALLMANAGER_FAILURECAUSE_CTIMANAGER_FAILURE
public static final int CAUSE_CTIMANAGER_FAILURECAUSE_DEVICE_FAILURE
public static final int CAUSE_DEVICE_FAILURECAUSE_DEVICE_UNREGISTERED
public static final int CAUSE_DEVICE_UNREGISTEREDCAUSE_NOCALLMANAGER_AVAILABLE
public static final int CAUSE_NOCALLMANAGER_AVAILABLECAUSE_REHOME_TO_HIGHER_PRIORITY_CM
public static final int CAUSE_REHOME_TO_HIGHER_PRIORITY_CMCAUSE_REHOMING_FAILURE
public static final int CAUSE_REHOMING_FAILUREID
public static final int IDCiscoProvCallParkEv
Declaration
public interface CiscoProvCallParkEv extends CiscoProvFeatureEvAll Superinterfaces
CiscoEv, CiscoProvEv, CiscoProvFeatureEv, javax.telephony.events.Ev, javax.telephony.events.ProvEvDescription
IntroductionThe CiscoTermSoftKeyPressedEv event
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_UNKNOWNgetCause(),getID(),getMetaCode(),getObserved(),isNewMetaEvent()getProvider()
Fields
ID
public static final int IDPARK_STATE_ACTIVE
public static final int PARK_STATE_ACTIVEIndicates that a call is parkedPARK_STATE_IDLE
public static final int PARK_STATE_IDLEIndicates that a call is unparkedREASON_CALLPARK
public static final int REASON_CALLPARKThis event is due to call parkREASON_CALLPARKREMAINDER
public static final int REASON_CALLPARKREMAINDERThis event is due to call park remainderREASON_CALLUNPARK
public static final int REASON_CALLUNPARKThis event is due to call being unparkedMethods
getintCallIDValue()
public int getintCallIDValue()Returns an integer representation of this objectgetParkDN()
publicjava.lang.StringgetParkDN()This returns where the call is parkedgetParkedParty()
publicjava.lang.StringgetParkedParty()This returns the DN of the parked partygetParkingParty()
publicjava.lang.StringgetParkingParty()This returns the DN of the parking partygetReason()
public int getReason()This returns the reason of the event. Possible states are : CiscoProvCallParkEv.REASON_CALLPARK CiscoProvCallParkEv.REASON_CALLUNPARK CiscoProvCallParkEv.REASON_CALLPARKREMAINDERgetState()
public int getState()This returns the state of the call Possible states are CiscoProvCallParkEv.PARK_STATE_IDLE CiscoProvCallParkEv.PARK_STATE_ACTIVECiscoProvEv
Declaration
All Superinterfaces
All Known Subinterfaces
CiscoAddrCreatedEv, CiscoAddrRemovedEv, CiscoProvCallParkEv, CiscoProvFeatureEv, CiscoProvFeatureUnRegisteredEv, CiscoTermCreatedEv, CiscoTermRemovedEvDescription
The CiscoProvEv interface, which extends JTAPI's core javax.telephony.events.ProvEv interface, serves as the base interface for all Cisco-extended JTAPI Provider events. Every Provider-related event in this package extends this interface, directly or indirectly.See Also:
javax.telephony.events.ProvEv
CiscoProvFeatureEv
Declaration
public interface CiscoProvFeatureEv extends CiscoProvEvAll Superinterfaces
All Known Subinterfaces
Methods
getFeatureID()
public int getFeatureID()Feature ID for which application is interested in receiving eventsCiscoProvFeatureID
Declaration
public interface CiscoProvFeatureID
Fields
MONITOR_CALLPARK_DN
public static final int MONITOR_CALLPARK_DNCiscoProvFeatureUnRegisteredEv
Declaration
public interface CiscoProvFeatureUnRegisteredEv extends CiscoProvEvAll Superinterfaces
Description
The CiscoProvFeatureUnRegisteredEv event This event indicates the unregistration of a particular feature by Cisco CallManager
Fields
ID
public static final int IDMethods
getFeatureID()
public int getFeatureID()FeatureID for which application will no longer receive eventsCiscoProvider
Declaration
All Superinterfaces
CiscoObjectContainer, javax.telephony.ProviderDescription
IN_SERVICE,OUT_OF_SERVICE,SHUTDOWNaddObserver(ProviderObserver),createCall(),getAddress(String),getAddressCapabilities(Terminal),getAddressCapabilities(Terminal),getAddresses(),getCallCapabilities(Terminal, Address),getCallCapabilities(Terminal, Address),getCalls(),getCapabilities(),getConnectionCapabilities(Terminal, Address),getConnectionCapabilities(Terminal, Address),getName(),getObservers(),getProviderCapabilities(Terminal),getProviderCapabilities(Terminal),getState(),getTerminal(String),getTerminalCapabilities(Terminal),getTerminalCapabilities(Terminal),getTerminalConnectionCapabilities(Terminal),getTerminalConnectionCapabilities(Terminal),getTerminals(),removeObserver(ProviderObserver),shutdown()
Methods
deleteCall(Call)
public void deleteCall(javax.telephony.Callcall)
throws InvalidStateExceptionDeletes an un used call created by createCall(). An exception is generated if the call is not in IDLE state or if provider is not in Provider.IN_SERVICE state. Applications may use this interface to move un used calls to INVALID state and reclaim resources alloacated to the call.Pre-conditions:1. this.getState() == Provider.IN_SERVICE2. call.getState() == Call.IDLEPost-conditions:1. call.getState() == Call.INVALIDThrows:javax.telephony.InvalidStateExceptiongetCallbackGuardEnabled()
public boolean getCallbackGuardEnabled()Returns the current state of the callback guard featureReturns:the current state of the callback guard featuregetMediaTerminal(String)
public com.cisco.jtapi.extensions.CiscoMediaTerminal getMediaTerminal(java.lang.Stringname)
throws InvalidArgumentExceptionReturns an instance of the CiscoMediaTerminal class which corresponds to the given name. Each CiscoMediaTerminal has a unique name associated with it, which is assigned to it by the JTAPI implementation. If no CiscoMediaTerminal is available for the given name within the Provider's domain, this method throws the InvalidArgumentException. This CiscoMediaTerminal is contained in the arrays generated by Provider.getTerminals() and CiscoProvider.getMediaTerminals().Pre-conditions:1. Let CiscoMediaTerminal terminal = this.getMediaTerminal(name);2. terminal is an element of this.getTerminals();3. terminal is an element of this.getMediaTerminals();Post-conditions:1. Let CiscoMediaTerminal terminal = this.getMediaTerminal(name);2. terminal is an element of this.getTerminals();3. terminal is an element of this.getMediaTerminals();Parameters:name - The name of desired CiscoMediaTerminal object.Returns:The CiscoMediaTerminal object associated with the given name.Throws:javax.telephony.InvalidArgumentException - The name provided does not correspond to a name of any CiscoMediaTerminal known to the Provider or within the Provider's domain.getMediaTerminals()
public com.cisco.jtapi.extensions.CiscoMediaTerminal[] getMediaTerminals()
throws ResourceUnavailableExceptionReturns an array of CiscoMediaTerminals associated with the Provider and within the Provider's domain. Each CiscoMediaTerminal possesses a unique name, which is assigned to it by the JTAPI implementation. If there are no CiscoMediaTerminals associated with this Provider, then this method returns null. This array is a subset of the array returned by Provider.getTerminals().Post-conditions:1. Let CiscoMediaTerminal[] terminals = this.getMediaTerminals()2. terminals == null or terminals.length >= 13. if terminals != null, terminals is a subset of this.getTerminals ()Returns:An array of Terminals in the Provider's local domain.Throws:javax.telephony.ResourceUnavailableException - Indicates the number of media terminals present in the Provider is too great to return as a static array.getVersion()
publicjava.lang.StringgetVersion()Returns the current version of provider running if provider is inservice otherwise it will return empty stringregisterFeature(int)
public void registerFeature(int featureID)
throws InvalidStateException, PrivilegeViolationException, InvalidArgumentExceptionused to register for a particular feature for which application will get Provider events. Applications should pass in the featureID of the softkey. Current supported features are listed in CiscoProvFeatureID interfaceThrows:javax.telephony.InvalidArgumentException, javax.telephony.PrivilegeViolationException, javax.telephony.InvalidStateExceptionsetCallbackGuardEnabled(boolean)
public void setCallbackGuardEnabled(boolean enabled)Enables or disables try/catch logic for observer callbacksIn order to protect itself from application exceptions in observer callbacks, the Provider normally guards all invocations of application interfaces (e.g. observers) with the following code:try {
observer.callStateChanged ( ... );
} catch ( Throwable t ) {
// log the exception here
}This isolates application errors from the JTAPI implementation, allowing easier troubleshooting, since the JTAPI implementation can note the unhandled exception and continue operating. Some errors are considered non-recoverable and will be re-thrown by JTAPI, generally resulting in application exit. Such errors include ThreadDeath, OutOfMemoryError, and StackOverflowError. Applications wishing to trap errors within JTAPI threads should create a subclass of ThreadGroup and initialize JTAPI from a thread within that ThreadGroup. By overriding the ThreadGroup.uncaughtException () method, the application can be made aware of all unrecoverable errors thrown on JTAPI threads.In some cases, JTAPI'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
Parameters:enabled - if true, callback guard will be enbled; if false, callback guard will be disabledunregisterFeature(int)
public void unregisterFeature(int featureID)
throws InvalidStateExceptionused to unregister a particular feature. Provider events for the feature will stop after unregistering the featureThrows:javax.telephony.InvalidStateExceptionCiscoProviderCapabilities
Declaration
public interface CiscoProviderCapabilities extendsjavax.telephony.capabilities.ProviderCapabilitiesAll Superinterfaces
javax.telephony.capabilities.ProviderCapabilitiesDescription
This interface defines the specific capabilities offered by the Cisco Jtapi implementation.
CiscoProviderObserver
Declaration
public interface CiscoProviderObserver extendsjavax.telephony.ProviderObserverAll Superinterfaces
javax.telephony.ProviderObserverDescription
Applications implement this interface in order to receive CiscoProvEv events such as CiscoAddrCreatedEv and CiscoTermCreatedEv when observing a Provider via the Provider.addObserver method.See Also:
providerChangedEvent(ProvEv[])
CiscoRegistrationException
Declaration
public class CiscoRegistrationException extendsjava.lang.Exceptionjava.lang.Object|+--java.lang.Throwable|+--java.lang.Exception|+--com.cisco.jtapi.extensions.CiscoRegistrationExceptionAll Implemented Interfaces
java.io.SerializableDescription
The CiscoMediaTerminal.register method throws this exception when the registration process fails for any reason. For example, registration would fail if the Provider were OUT_OF_SERVICE or if the device were already registered.See Also:CiscoMediaTerminal.register(InetAddress, int, CiscoMediaCapability[])
Constructors
CiscoRegistrationException()
public CiscoRegistrationException()CiscoRegistrationException(String)
public CiscoRegistrationException(java.lang.Stringdescription)CiscoRouteAddress
Declaration
public interface CiscoRouteAddress extendsjavax.telephony.callcenter.RouteAddressAll Superinterfaces
javax.telephony.Address, javax.telephony.callcenter.RouteAddress
Methods
registerRouteCallback(RouteCallback, boolean)
public void registerRouteCallback(javax.telephony.callcenter.RouteCallbackrouteCallback, boolean disableAutoRehoming)
throws ResourceUnavailableException, MethodNotSupportedExceptionThrows:javax.telephony.MethodNotSupportedException, javax.telephony.ResourceUnavailableExceptionCiscoRouteSession
Declaration
public interface CiscoRouteSession extendsjavax.telephony.callcenter.RouteSessionAll Superinterfaces
javax.telephony.callcenter.RouteSessionDescription
IntroductionThe CiscoRouteSession supports application access to underlying call associated with a RouteSession. Also, various internal ERRORs where endRoute is called internally are exposed to the app, should they wish to handle endRouteEvent() in any special way for these cases.See Also:
javax.telephony.Call
Fields
CALLINGADDRESS_SEARCH_SPACE
public static final int CALLINGADDRESS_SEARCH_SPACEThis indicates that the redirect should be done using the search space of the calling address.DEFAULT_SEARCH_SPACE
public static final int DEFAULT_SEARCH_SPACEThis 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.ERROR_INVALID_STATE
public static final int ERROR_INVALID_STATEIf an internal InvalidStateException occured or some precondions/postconditions were not met during routing endRoute is called with this ERROR_INVALID_STATE error.ERROR_NO_CALLBACK
public static final int ERROR_NO_CALLBACKFor now, since there is no default route mechanism in place, if there is no callback retgisered for this app, an endRoute with this error is called.ERROR_NONE
public static final int ERROR_NONEERRORS defined for internal successful endRoute call. Error value set for no error.ERROR_ROUTESELECT_TIMEOUT
public static final int ERROR_ROUTESELECT_TIMEOUTEach routeEvent()/reRouteEvent() sent starts a timer for the app to respond with a routeSelect()/ endRoute(). The default value of this timer is 5secs. Should the application not respond within this time, an endRoute is called with this error = ERROR_ROUTESELECT_TIMOUTROUTEADDRESS_SEARCH_SPACE
public static final int ROUTEADDRESS_SEARCH_SPACEThis indicates that the redirect should be done using the search space of the route point address.Methods
getCall()
publicjavax.telephony.CallgetCall()Returns the call associated with this RouteSession.Returns:the call associated with this RouteSessionselectRoute(String[], int)
public void selectRoute(java.lang.String[]routeSelected, int callingSearchSpace)
throws MethodNotSupportedExceptionThis 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_SPACE2. CiscoRouteSession.CALLINGADDRESS_SEARCH_SPACE3. CiscoRouteSession.ROUTEADDRESS_SEARCH_SPACERead above for a description of what each of these means.Throws:javax.telephony.MethodNotSupportedExceptionCiscoRTPBitRate
Declaration
public interface CiscoRTPBitRateDescription
The RTPBitRate interface contains constants describing G.723 RTP bitrates. These constants are returned by the CiscoRTPInputProperties.getBitRate method and the CiscoRTPOutputProperties.getBitRate method.See Also:
CiscoRTPInputProperties.getBitRate(), CiscoRTPOutputProperties.getBitRate()
Fields
R5_3
public static final int R5_35.3k G.723 bit rateR6_4
public static final int R6_46.4k G.723 bit rateCiscoRTPInputProperties
Declaration
public interface CiscoRTPInputPropertiesDescription
