Feedback
Table Of Contents
Cisco JTAPI Extensions Hierarchy
Cisco Services Alarm Hierarchy
Cisco Services Tracing Hierarchy
Class com.cisco.jtapi.extensions
Interface com.cisco.jtapi.extensions
Cisco JTAPI Extension Interfaces
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
Introduction
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.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 java.lang.Throwable (implements java.io.Serializable)
class java.lang.Exception
class com.cisco.jtapi.extensions.CiscoRegistrationException
class com.cisco.jtapi.extensions.CiscoUnregistrationException
Interface Hierarchy
interface javax.telephony.Address
interface com.cisco.jtapi.extensions.CiscoAddress(also 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 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.CiscoRTPBitRate
interface com.cisco.jtapi.extensions.CiscoRTPInputProperties
interface com.cisco.jtapi.extensions.CiscoRTPOutputProperties
interface com.cisco.jtapi.extensions.CiscoRTPPayload
interface com.cisco.jtapi.extensions.CiscoSynchronousObserver
interface com.cisco.jtapi.extensions.CiscoTelephonyException
interface javax.telephony.Connection
interface javax.telephony.callcontrol.CallControlConnection
interface com.cisco.jtapi.extensions.CiscoConnection(also extends
com.cisco.jtapi.extensions.CiscoObjectContainer)
interface javax.telephony.events.Ev
interface javax.telephony.events.AddrEv
interface com.cisco.jtapi.extensions.CiscoAddrEv(also extends
com.cisco.jtapi.extensions.CiscoEv)
interface com.cisco.jtapi.extensions.CiscoAddrInServiceEv
interface com.cisco.jtapi.extensions.CiscoAddrOutOfServiceEv(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.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.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.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.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.ProviderObserver
interface com.cisco.jtapi.extensions.CiscoProviderObserver
interface javax.telephony.callcenter.RouteSession
interface com.cisco.jtapi.extensions.CiscoRouteSession
interface javax.telephony.Terminal
interface com.cisco.jtapi.extensions.CiscoTerminal(also extends
com.cisco.jtapi.extensions.CiscoObjectContainer)
interface com.cisco.jtapi.extensions.CiscoMediaTerminal
interface javax.telephony.TerminalConnection
interface javax.telephony.callcontrol.CallControlTerminalConnection
interface com.cisco.jtapi.extensions.CiscoTerminalConnection(also extends
com.cisco.jtapi.extensions.CiscoObjectContainer)
interface javax.telephony.TerminalObserver
interface com.cisco.jtapi.extensions.CiscoTerminalObserver
interface com.cisco.services.tracing.TraceModule
interface com.cisco.jtapi.extensions.CiscoJtapiPeer(also extends
com.cisco.jtapi.extensions.CiscoObjectContainer, javax.telephony.JtapiPeer)
Cisco Services Alarm Hierarchy
Class Hierarchy
class java.lang.Object
class com.cisco.services.alarm.AlarmManager
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
Interface Hierarchy
interface com.cisco.services.alarm.Alarm
interface com.cisco.services.alarm.AlarmWriter
Cisco Services Tracing Hierarchy
Class Hierarchy
class java.lang.Object
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.services.tracing.TraceManagerFactory
Interface Hierarchy
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.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.
Cisco JTAPI Extension Classes
Table 2-1 Cisco JTAPI extension classes and their methods
getBitRate()
toString()
getMaxFramesPerPacket()
getPayloadType()
toString()
None
None
CiscoG711MediaCapability
Declaration
public class CiscoG711MediaCapability extends com.cisco.jtapi.extensions.CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.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.
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packets
FRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
FRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packets
Constructors
CiscoG711MediaCapability()
public CiscoG711MediaCapability()Constructs a CiscoG711MediaCapability</CODE object with a default thirty millisecond packet size.
CiscoG711MediaCapability(int)
public CiscoG711MediaCapability(int maxFramesPerPacket)Constructs a CiscoG711MediaCapability</CODE object with the specified packet size.
CiscoG723MediaCapability
Declaration
public class CiscoG723MediaCapability extends com.cisco.jtapi.extensions.CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.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.
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packets
FRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
FRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packets
Constructors
CiscoG723MediaCapability()
public CiscoG723MediaCapability()Constructs a CiscoG723MediaCapability</CODE object with a default thirty millisecond packet size and 6.4k bit rate.
CiscoG723MediaCapability(int, int)
public CiscoG723MediaCapability(int maxFramesPerPacket, int bitRate)Constructs a CiscoG723MediaCapability</CODE object with the specified packet size and bit rate.
Methods
getBitRate()
public int getBitRate()Returns the bit rate specified by this capability object.
Returnsa bit rate from the RTPBitRate interface
toString()
public java.lang.String toString()OverridesCiscoMediaCapability.toString() in class CiscoMediaCapability
CiscoG729MediaCapability
Declaration
public class CiscoG729MediaCapability extends com.cisco.jtapi.extensions.CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.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.
Fields
FRAMESIZE_SIXTY_MILLISECOND_PACKET
public static final int FRAMESIZE_SIXTY_MILLISECOND_PACKETThe frames-per-packet value for 60 millisecond packets
FRAMESIZE_THIRTY_MILLISECOND_PACKET
public static final int FRAMESIZE_THIRTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
FRAMESIZE_TWENTY_MILLISECOND_PACKET
public static final int FRAMESIZE_TWENTY_MILLISECOND_PACKETThe frames-per-packet value for 20 millisecond packets
Constructors
CiscoG729MediaCapability()
public CiscoG729MediaCapability()Constructs a CiscoG729MediaCapability</CODE object with a default G729 payload and thirty millisecond packet size.
CiscoG729MediaCapability(int, int)
public CiscoG729MediaCapability(int payload, int maxFramesPerPacket)Constructs a CiscoG729MediaCapability</CODE object with the specified packet size and payload. Choice of payload is specified in CiscoRTPPayload with the options CiscoRTPPayload.G729 and CiscoRTPPayload.G729ANNEXA
CiscoGSMMediaCapability
Declaration
public class CiscoGSMMediaCapability extends com.cisco.jtapi.extensions.CiscoMediaCapabilityjava.lang.Object|+--com.cisco.jtapi.extensions.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.
Fields
FRAMESIZE_EIGHTY_MILLISECOND_PACKET
public static final int FRAMESIZE_EIGHTY_MILLISECOND_PACKETThe frames-per-packet value for 30 millisecond packets
Constructors
CiscoGSMMediaCapability()
public CiscoGSMMediaCapability()Constructs a CiscoGSMMediaCapability</CODE object with a default eighty millisecond packet size.
CiscoGSMMediaCapability(int)
public CiscoGSMMediaCapability(int maxFramesPerPacket)Constructs a CiscoGSMMediaCapability</CODE object with the specified packet size.
CiscoMediaCapability
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
Fields
G711_64K_30_MILLISECONDS
public static final CiscoMediaCapability G711_64K_30_MILLISECONDSG.711 capability with default parameters
See AlsoCiscoG711MediaCapability
G723_6K_30_MILLISECONDS
public static final CiscoMediaCapability G723_6K_30_MILLISECONDSG.723 capability with default parameters
See AlsoCiscoG723MediaCapability
G729_30_MILLISECONDS
public static final CiscoMediaCapability G729_30_MILLISECONDSG.729 capability with default parameters
See AlsoCiscoG729MediaCapability
GSM_80_MILLISECONDS
public static final CiscoMediaCapability GSM_80_MILLISECONDSGSM capability with default parameters
See AlsoCiscoGSMMediaCapability
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.
Returnsthe packet size, specified as a the number of frames within a single packet
getPayloadType()
public int getPayloadType()Returns the payload type specified by this object.
Returnsa payload type from the RTPPayload interface
toString()
public java.lang.String toString()Overridesjava.lang.Object.toString() in class java.lang.Object
CiscoRegistrationException
Declaration
public class CiscoRegistrationException extends java.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.String description)CiscoUnregistrationException
Declaration
public class CiscoUnregistrationException extends java.lang.Exceptionjava.lang.Object|+--java.lang.Throwable|+--java.lang.Exception|+--com.cisco.jtapi.extensions.CiscoUnregistrationExceptionAll Implemented Interfaces:
java.io.SerializableDescription
The CiscoMediaTerminal.unregister method throws this exception when the unregistration process fails for any reason. For example, registration would fail if the Provider were OUT_OF_SERVICE or if the device were already unregistered.
See Also:
CiscoMediaTerminal.unregister()
Constructors
CiscoUnregistrationException()
public CiscoUnregistrationException()CiscoUnregistrationException(String)
public CiscoUnregistrationException(java.lang.String description)Interface com.cisco.jtapi.extensions
Cisco JTAPI Extension Interfaces
CiscoAddrCreatedEv
Declaration
public interface CiscoAddrCreatedEv extends com.cisco.jtapi.extensions.CiscoProvEvAll Superinterfaces:
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEvDescription
The CiscoAddrCreatedEv event
Fields
ID
public static final int IDMethods
getAddress()
public javax.telephony.Address getAddress()CiscoAddress
Declaration
public interface CiscoAddress extends javax.telephony.Address, com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
javax.telephony.Address, CiscoObjectContainerDescription
The CiscoAddress interface extends the Address interface with additional CallManager-specific capabilities.
See Also:
javax.telephony.Address
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-service
INTERNAL
public static final int INTERNALThis is an internal address.
OUT_OF_SERVICE
public static final int OUT_OF_SERVICEThe address is in-service
UNKNOWN
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
getRegistrationState()
public int getRegistrationState()Deprecated.This method has been replaced by the getState() method.
Returns the state of this address.
The state may be any of the following constants:
CiscoAddress.OUT_OF_SERVICE
CiscoAddress.IN_SERVICE
Returnsthe state of this address
getState()
public int getState()Returns the state of this address.
The state may be any of the following constants:
CiscoAddress.OUT_OF_SERVICE
CiscoAddress.IN_SERVICE
Returnsthe state of this address
getType()
public int getType()Returns the type of this address.
The type may be any of the following constants:
CiscoAddress.INTERNAL
CiscoAddress.EXTERNAL
CiscoAddress.EXTERNAL_UNKNOWN
Returnsthe type of address
CiscoAddressObserver
Declaration
public interface CiscoAddressObserver extends javax.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:
CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv
CiscoAddrEv
Declaration
public interface CiscoAddrEv extends com.cisco.jtapi.extensions.CiscoEv, javax.telephony.events.AddrEvAll Superinterfaces:
javax.telephony.events.AddrEv, CiscoEv, javax.telephony.events.EvAll Known Subinterfaces:
CiscoAddrInServiceEv, CiscoAddrOutOfServiceEvDescription
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 com.cisco.jtapi.extensions.CiscoAddrEvAll Superinterfaces:
javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, javax.telephony.events.EvDescription
The CiscoAddrInServiceEv event
Fields
ID
public static final int IDCiscoAddrOutOfServiceEv
Declaration
public interface CiscoAddrOutOfServiceEv extends com.cisco.jtapi.extensions.CiscoAddrEv, com.cisco.jtapi.extensions.CiscoOutOfServiceEvAll Superinterfaces:
javax.telephony.events.AddrEv, CiscoAddrEv, CiscoEv, CiscoOutOfServiceEv, javax.telephony.events.EvDescription
The CiscoAddrOutOfServiceEv event
Fields
ID
public static final int IDCiscoAddrRemovedEv
Declaration
public interface CiscoAddrRemovedEv extends com.cisco.jtapi.extensions.CiscoProvEvAll Superinterfaces:
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEvDescription
The CiscoAddrRemovedEv event
Fields
ID
public static final int IDMethods
getAddress()
public javax.telephony.Address getAddress()CiscoCall
Declaration
public interface CiscoCall extends javax.telephony.callcontrol.CallControlCall, com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoObjectContainerAll Known Subinterfaces:
CiscoConsultCallDescription
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
CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.
Methods
getCallID()
public CiscoCallID getCallID()CallID is a unique identifier among all ACTIVE calls with the same CallManagerID.
Returnsthe CallID property of this Call
CiscoCallEv
Declaration
public interface CiscoCallEv extends com.cisco.jtapi.extensions.CiscoEv, javax.telephony.events.CallEvAll Superinterfaces:
javax.telephony.events.CallEv, CiscoEv, javax.telephony.events.EvAll 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_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_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_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_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).
Returnsthe CallManager cause for this event
CiscoCallID
Declaration
public interface CiscoCallID extends com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
CiscoObjectContainerDescription
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 CiscoCall getCall()intValue()
public int intValue()Returns an integer representation of this object, currently a bitwise OR of the CallManagerID and GlobalCallID properties (shifted and truncated appropriately)
Returnsan integer representation of this object
CiscoConferenceEndEv
Declaration
public interface CiscoConferenceEndEv extends com.cisco.jtapi.extensions.CiscoCallEvAll Superinterfaces:
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.EvDescription
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()
public javax.telephony.Address getConferenceControllerAddress()Returns the Address which currently acts as the conference controller for this call —- the initiating call.
getConferencedCall()
public javax.telephony.Call getConferencedCall()Returns the call that has been merged. This call is in the Call.INVALID state.
getFinalCall()
public javax.telephony.Call getFinalCall()Returns the call that remains active after the conference is completed.
getHeldConferenceController()
public javax.telephony.TerminalConnection getHeldConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the final call. 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()
public javax.telephony.TerminalConnection getTalkingConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.
CiscoConferenceStartEv
Declaration
public interface CiscoConferenceStartEv extends com.cisco.jtapi.extensions.CiscoCallEvAll Superinterfaces:
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.EvDescription
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()
public javax.telephony.Address getConferenceControllerAddress()Returns the Address which currently acts as the conference controller for this call —- the initiating call.
getConferencedCall()
public javax.telephony.Call getConferencedCall()Returns the call that will be conferenced. This is the call that will be merged into the initiating call
getFinalCall()
public javax.telephony.Call getFinalCall()Returns the call that will remain active after the conference is completed. This is the call all calls are finally merged into
getHeldConferenceController()
public javax.telephony.TerminalConnection getHeldConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in HELD state. This method returns null if the conference controller is not being observed.
getTalkingConferenceController()
public javax.telephony.TerminalConnection getTalkingConferenceController()Returns the TerminalConnection which currently acts as the conference controller for this call —- the initiating call. This is the TerminalConnection that was in TALKING state. This method returns null if the conference controller is not being observed.
CiscoConnection
Declaration
public interface CiscoConnection extends javax.telephony.callcontrol.CallControlConnection, com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer, javax.telephony.ConnectionDescription
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.
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 CiscoConnectionID getConnectionID()CiscoConnectionID is a unique object that identifier among all ACTIVE calls with the same CallManagerID.
Returnsthe CallID property of this Call
getReason()
public int getReason()Returns the reason for the creation of this Connection.
In order to function properly, some applications need to know the reason why a Connection is created at an endpoint that the application is observing. For example, a voice mail application may want to know whether a caller is someone that wants to leave a message in a voice mailbox (REASON_FORWARDNOANSWER), or whether the caller is trying to access a voice mail box (REASON_DIRECTCALL).
The reason for a Connection'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_NORMAL
All of the reasons except for REASON_TRANSFERORIGINATION and REASON_NORMAL are associated with inbound, or destination Connections. The REASON_NORMAL reason is associated without outbound, or originating Connections.
Returnsthe reason for the creation of this Connection
redirect(String, int)
public javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode) throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, Privileg eViolationException, ResourceUnavailableExceptionThis method overloads the CallControlConnection.redirect() method. It takes a new parameter —- redirectMode. When this parameter is:
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.
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.
ThrowsResourceUnavailableException, PrivilegeViolationException, MethodNotSupportedException, InvalidPartyException, InvalidStateException
redirect(String, int, int)
public javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace) throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, Privileg eViolationException, 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:CiscoConnection.REDIRECT_DROP_ON_FAILURE
CiscoConnection.REDIRECT_NORMAL
Read above for a description of what each of these means.
The callingSearchSpace parameter may be:CiscoConnection.DEFAULT_SEARCH_SPACE
CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
CiscoConnection.ADDRESS_SEARCH_SPACE
Read above for a description of what each of these means.
NOTE: The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.ThrowsResourceUnavailableException, PrivilegeViolationException, MethodNotSupportedException, InvalidPartyException, InvalidStateException
redirect(String, int, int, int)
public javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption) throws InvalidStateException, InvalidPartyException, MethodNotSupportedException, Privileg eViolationException, 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:CiscoConnection.REDIRECT_DROP_ON_FAILURE
CiscoConnection.REDIRECT_NORMAL
Read above for a description of what each of these means.
The callingSearchSpace parameter may be:CiscoConnection.DEFAULT_SEARCH_SPACE
CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
CiscoConnection.ADDRESS_SEARCH_SPACE
Read above for a description of what each of these means.
NOTE: The callingSearchSpace parameter may be specified when the redirect controller is a RouteAddress. It will be ignored for all other address types.
* The calledAddressOption parameter may be:CiscoConnection.CALLED_ADDRESS_DEFAULT
CiscoConnection.CALLED_ADDRESS_UNCHANGED
CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
Read above for a description of what each of these means.
ThrowResourceUnavailableException, PrivilegeViolationException, MethodNotSupportedException, InvalidPartyException, InvalidStateException
CiscoConnectionID
Declaration
public interface CiscoConnectionID extends com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
CiscoObjectContainerDescription
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.
Returns an integer representation of this object, currently the CallManager CallLeg ID.
Methods
getConnection()
public CiscoConnection getConnection()intValue()
public int intValue()Returns an integer representation of this object, currently the CallManager CallLeg ID.
Returnsan integer representation of this object
CiscoConsultCall
Declaration
public interface CiscoConsultCall extends com.cisco.jtapi.extensions.CiscoCallAll Superinterfaces:
javax.telephony.Call, javax.telephony.callcontrol.CallControlCall, CiscoCall, CiscoObjectContainerDescription
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
Methods
consultWithoutMedia(TerminalConnection, String)
public javax.telephony.Connection[] consultWithoutMedia(javax.telephony.TerminalConnection tc, java.lang.String dialedDigits) throws InvalidStateException, InvalidArgumentException, MethodNotSupportedException, Resou rceUnavailableException, 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 Purpose
This method does not support if invoked with CallControlCall.setConferneceEnable(). It only supports if invoked with CallControlCall.setTransferEnable().
ThrowsInvalidPartyException, PrivilegeViolationException, ResourceUnavailableException, MethodNotSupportedException, InvalidArgumentException, InvalidStateException
getConsultingTerminalConnection()
public javax.telephony.TerminalConnection getConsultingTerminalConnection()Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.
If this Call was created as part of a consultative transfer or consultative conference, the TerminalConnection which was used to perform the consultation on the original Call is returned by the getConsultingTerminalConnection method. This may be useful to applications that wish to correlate a ConsultCall with its original Call. Note that the original Call does not have any methods which may be used to determine the ConsultCall, if any, to which it is related.
Returnsnull if this Call is not the result of a consultation, or the consulting TerminalConnection of the original Call if this Call is the result of a consultation.
CiscoConsultCallActiveEv
Declaration
public interface CiscoConsultCallActiveEv extends com.cisco.jtapi.extensions.CiscoCallEv, javax.telephony.events.CallActiveEvAll 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
Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.
Fields
ID
public static final int IDMethods
getHeldTerminalConnection()
public javax.telephony.TerminalConnection getHeldTerminalConnection()Deprecated.replaced by CiscoConsultCall.getConsultingTerminalConnection ()
Returns the consulting TerminalConnection that was used to create this CiscoConsultCall.
This may be useful to applications that wish to correlate a consultation Call with its original Call. Note that the original Call does not have any methods which may be used to determine the consultation Call, if any, to which it is related.
Returnsthe consulting TerminalConnection of the Call that created the Call referenced by this event
CiscoEv
Declaration
public interface CiscoEv extends javax.telephony.events.EvAll Superinterfaces:
javax.telephony.events.EvAll Known Subinterfaces:
CiscoAddrCreatedEv, CiscoAddrEv, CiscoAddrInServiceEv, CiscoAddrOutOfServiceEv, CiscoAddrRemovedEv, CiscoCallEv, CiscoConferenceEndEv, CiscoConferenceStartEv, CiscoConsultCallActiveEv, CiscoOutOfServiceEv, CiscoProvEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputStartedEv, CiscoRTPOutputStoppedEv, CiscoTermCreatedEv, 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
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 = (CiscoJtapiException) e int errorCode = 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_FULL
public static final int CONFERENCE_FULLDB_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_DEVICESDEVICE_NOT_OPEN
public static final int DEVICE_NOT_OPENDIGIT_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_ALLOWEDEXISTING_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_HANDLELINE_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_REACHEDNO_ACTIVE_DEVICE_FOR_THIRDPARTY
public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTYNOT_INITIALIZED
public static final int NOT_INITIALIZEDOPERATION_NOT_AVAILABLE_IN_CURRENT_STATE
public static final int OPERATION_NOT_AVAILABLE_IN_CURRENT_STATEPROTOCOL_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_REGISTEREDTIMEOUT
public static final int TIMEOUTTRANSFERFAILED
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()CiscoJtapiPeer
Declaration
public interface CiscoJtapiPeer extends com.cisco.services.tracing.TraceModule, javax.telephony.JtapiPeer, com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
CiscoObjectContainer, javax.telephony.JtapiPeer, com.cisco.services.tracing.TraceModuleDescription
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
Methods
getJtapiProperties()
public CiscoJtapiProperties getJtapiProperties()CiscoJtapiProperties defines the various methods that applications can use to modify the parameters that the JTAPI layer will use.
•
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()
public java.lang.String getAlarmServiceHostname()get the alarm service host name
getAlarmServicePort()
public int getAlarmServicePort()get the port number for the alarm service
getCtiRequestTimeout()
public int getCtiRequestTimeout()get the timout for cti requests, other than the provider open (seconds)
getDebuggingNames()
public java.lang.String[] getDebuggingNames()get names of supported debugging level jtapi traces
getDebuggingValue(String)
public boolean getDebuggingValue(java.lang.String debuggingName)get the enabled or disabled state of a debugging level trace
getDesiredServerHeartbeatInterval()
public int getDesiredServerHeartbeatInterval()get the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.
getFileNameBase()
public java.lang.String getFileNameBase()the filename for individual log files.
getFileNameExtension()
public java.lang.String getFileNameExtension()get the filename extension for log files
getNumTraceFiles()
public int getNumTraceFiles()number of trace files before rollover
getPeriodicWakeupEnabled()
public boolean getPeriodicWakeupEnabled()get the enabled state of periodic wake up
getPeriodicWakeupInterval()
public int getPeriodicWakeupInterval()get the interval for periodic wakeup (milliseconds)
getProviderOpenRequestTimeout()
public int getProviderOpenRequestTimeout()get the timout for a provider open request (seconds)
getProviderRetryInterval()
public int getProviderRetryInterval()get the interval at which the connection to the CTI Manager will ge retried (seconds)
getQueueSizeThreshold()
public int getQueueSizeThreshold()Get the threshold for the event queue size to trigger alarms
getQueueStatsEnabled()
public boolean getQueueStatsEnabled()get the enabled state of event queue stats
getRouteSelectTimeout()
public int getRouteSelectTimeout()get the route select timeout (milliseconds)
getServices()
public java.lang.String[] getServices()Returns the services that this implementation supports. Note: This is a static list administered in the jtapi.ini file. There is no automatic discovery mechanism to locate available cti services
getSyslogCollector()
public java.lang.String getSyslogCollector()get the syslog collector hostname
getSyslogCollectorUDPPort()
public int getSyslogCollectorUDPPort()get the syslog collector UDP port
getTraceDirectory()
public java.lang.String getTraceDirectory()The directory in the path where trace files will be written
getTraceFileSize()
public int getTraceFileSize()The size of the tracefiles before rollover
getTraceNames()
public java.lang.String[] getTraceNames()get the names of supported jtapi traces
getTracePath()
public java.lang.String getTracePath()get the path where the trace files will be located
getTraceValue(String)
public boolean getTraceValue(java.lang.String traceName)get the enabled or disabled state of a trace
getUseAlarmService()
public boolean getUseAlarmService()get the enabled/disabled state of the alarm service
getUseFileTrace()
public boolean getUseFileTrace()get the enabled or disabled state of jtapi log file tracing
getUseJavaConsoleTrace()
public boolean getUseJavaConsoleTrace()get the enabled or disabled state of jtapi console tracing
getUseSameDir()
public boolean getUseSameDir()if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a seperate directory, indexed in sequence from the last directory written or available.
getUseSyslog()
public boolean getUseSyslog()get the enabled or disabled state of syslog tracing
setAlarmServiceHostname(String)
public void setAlarmServiceHostname(java.lang.String hostname)set the alarm service host name
setAlarmServicePort(int)
public void setAlarmServicePort(int portNumber)set the port number the alarm service is listening on
setCtiRequestTimeout(int)
public void setCtiRequestTimeout(int seconds)set the timeout for cti requests other than provider open (seconds)
setDebuggingValue(String, boolean)
public void setDebuggingValue(java.lang.String debuggingName, boolean value)enable or disable a particular debugging level trace
setDesiredServerHeartbeatInterval(int)
public void setDesiredServerHeartbeatInterval(int seconds)set the desired interval at which the CTI Manager must send heartbeats to JTAPI (seconds). The actual interval is decided by the server at connect time.
setFileNameBase(String)
public void setFileNameBase(java.lang.String base)set the filename for log files
setFileNameExtension(String)
public void setFileNameExtension(java.lang.String extn)set the filename extension for log files
setNumTraceFiles(int)
public void setNumTraceFiles(int val)set the number of trace files before rollover
setPeriodicWakeupEnabled(boolean)
public void setPeriodicWakeupEnabled(boolean enabled)set the enable/disable state for periodic wake up
setPeriodicWakeupInterval(int)
public void setPeriodicWakeupInterval(int milliseconds)set the periodic wake up interval (milliseconds)
setProviderOpenRequestTimeout(int)
public void setProviderOpenRequestTimeout(int seconds)set the timeout for a provider open request (seconds)
setProviderRetryInterval(int)
public void setProviderRetryInterval(int seconds)set the interval at which the connection to the CTI Manager will ge retried (seconds)
setQueueSizeThreshold(int)
public void setQueueSizeThreshold(int size)Set the threshold for the event queue size to trigger alarms
setQueueStatsEnabled(boolean)
public void setQueueStatsEnabled(boolean enabled)enable / disable event queue statistics
setRouteSelectTimeout(int)
public void setRouteSelectTimeout(int milliseconds)set the route select timeout milliseconds
setServices(String[])
public void setServices(java.lang.String[] services)set a list of available services
setSyslogCollector(String)
public void setSyslogCollector(java.lang.String value)set the syslog collector hostname
setSyslogCollectorUDPPort(int)
public void setSyslogCollectorUDPPort(int port)set the syslog collector UDP port
setTraceDirectory(String)
public void setTraceDirectory(java.lang.String dir)Set the directory where jtapi trace files should be written
setTraceFileSize(int)
public void setTraceFileSize(int val)Set the size of the trace file
setTracePath(String)
public void setTracePath(java.lang.String path)set the directory root where jtapi traces will be written
setTraceValue(String, boolean)
public void setTraceValue(java.lang.String traceName, boolean value)enable or disable a particular trace
setUseAlarmService(boolean)
public void setUseAlarmService(boolean value)enable the alarm service
setUseFileTrace(boolean)
public void setUseFileTrace(boolean value)enable or disable jtapi log file tracing
setUseJavaConsoleTrace(boolean)
public void setUseJavaConsoleTrace(boolean value)enable or disable jtapi console tracing
setUseSameDir(boolean)
public void setUseSameDir(boolean value)if UseSameDir is true this will cause the traces to go to a single directory. Otherwise each instance of a jtapi application will cause the traces to go to a seperate directory, indexed in sequence from the last directory written or available.
setUseSyslog(boolean)
public void setUseSyslog(boolean value)enable or disable syslog tracing
CiscoMediaTerminal
Declaration
public interface CiscoMediaTerminal extends com.cisco.jtapi.extensions.CiscoTerminalAll Superinterfaces:CiscoObjectContainer, CiscoTerminal, javax.telephony.Terminal
Description
A CiscoMediaTerminal is a special kind of CiscoTerminal that allows applications to terminate RTP media streams. Unlike a CiscoTerminal, a CiscoMediaTerminal does not represent a physical telephony endpoint, which is observable and controllable in a third-party manner. Instead, a CiscoMediaTerminal is a logical telephony endpoint, which may be associated with any application that desires to terminate media. Such applications include voice mail systems, interactive voice response (IVR), and "soft" phones.
Note
Terminating media is a two-step process. To terminate media for a particular terminal, an application adds an observer that implements the CiscoTerminalObserver interface using the Terminal.addObserver method. Finally, the application registers its IP address and port number to which the Terminal's incoming RTP streams are to be directed using the CiscoMediaTerminal.register method.
See Also:
CiscoTerminal
Methods
isRegistered()
public boolean isRegistered()This method returns true if the CiscoMediaTerminal is registered and false otherwise.
register(InetAddress, int)
public void register(java.net.InetAddress address, int port) throws CiscoRegistrationExceptionDeprecatedRegisters a Terminal with the specified address and port, defaulting to G.711 64KHz u-law encoding with a thirty millisecond packet size.
Parametersaddress - the internet address for inbound RTP streams on this terminal
port - the UDP port for inbound RTP streams on this terminal
Throws:CiscoRegistrationException
register(InetAddress, int, CiscoMediaCapability[])
public void register(java.net.InetAddress address, int port, 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 terminal
port - the UDP port for inbound RTP streams on this terminal
capabilities - the list of RTP encodings supported by this terminal
Throws:CiscoRegistrationException
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:CiscoUnregistrationException
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.
Gets the application-defined object.
Sets an application-defined object.
Methods
getObject()
public java.lang.Object getObject()Gets the application-defined object.
Returnsthe CallID property of this Call
setObject(Object)
public java.lang.Object setObject(java.lang.Object reference)Sets an application-defined object.
Returnsthe CallManagerID property of this Call
CiscoOutOfServiceEv
Declaration
public interface CiscoOutOfServiceEv extends com.cisco.jtapi.extensions.CiscoEvAll Superinterfaces:
CiscoEv, javax.telephony.events.EvAll Known Subinterfaces:
CiscoAddrOutOfServiceEv, CiscoTermOutOfServiceEvDescription
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 IDCiscoProvEv
Declaration
public interface CiscoProvEv extends com.cisco.jtapi.extensions.CiscoEv, javax.telephony.events.ProvEvAll Superinterfaces:
CiscoEv, javax.telephony.events.Ev, javax.telephony.events.ProvEvAll Known Subinterfaces:
CiscoAddrCreatedEv, CiscoAddrRemovedEv, 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.Prov
CiscoProvider
Declaration
public interface CiscoProvider extends javax.telephony.Provider, com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
CiscoObjectContainer, javax.telephony.ProviderDescription
Methods
getCallbackGuardEnabled()
public boolean getCallbackGuardEnabled()Returns the current state of the callback guard feature
Returns:the current state of the callback guard feature
getMediaTerminal(String)
public CiscoMediaTerminal getMediaTerminal(java.lang.String name) 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:Let CiscoMediaTerminal terminal = this.getMediaTerminal(name);
terminal is an element of this.getTerminals();
terminal is an element of this.getMediaTerminals();
Post-conditions:Let CiscoMediaTerminal terminal = this.getMediaTerminal(name);
terminal is an element of this.getTerminals();
terminal is an element of this.getMediaTerminals();
Parameters:name - The name of desired CiscoMediaTerminal object.
Returns:The CiscoMediaTerminal object associated with the given name.
Throws: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 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:Let CiscoMediaTerminal[] terminals = this.getMediaTerminals()
terminals == null or terminals.length >= 1
if terminals != null, terminals is a subset of this.getTerminals ()
Returns:An array of Terminals in the Provider's local domain.
Throws:ResourceUnavailableException - Indicates the number of media terminals present in the Provider is too great to return as a static array.
setCallbackGuardEnabled(boolean)
public void setCallbackGuardEnabled(boolean enabled)Enables or disables try/catch logic for observer callbacks
In order to protect itself from application exceptions in observer callbacks, the Provider normally guards all invocations of application interfaces (e.g. observers) with the following code:
try { observer.callStateChanged ( ... ); } catch ( Throwable t ) { // log the exception here }This isolates application errors from the JTAPI implementation, allowing easier troubleshooting, since the JTAPI implementation can note the unhandled exception and continue operating. Some errors are considered non-recoverable and will be re-thrown by JTAPI, generally resulting in application exit. Such errors include ThreadDeath, OutOfMemoryError, and StackOverflowError. Applications wishing to trap errors within JTAPI threads should create a subclass of ThreadGroup and initialize JTAPI from a thread within that ThreadGroup. By overriding the ThreadGroup.uncaughtException () method, the application can be made aware of all unrecoverable errors thrown on JTAPI threads.
In some cases, JTAPI'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 disabled
CiscoProviderObserver
Declaration
public interface CiscoProviderObserver extends javax.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:
CiscoAddrCreatedEv, CiscoTermCreatedEv
CiscoRouteAddress
Declaration
public interface CiscoRouteAddress extends javax.telephony.callcenter.RouteAddressAll Superinterfaces:
javax.telephony.Address, javax.telephony.callcenter.RouteAddress
Methods
registerRouteCallback(RouteCallback, boolean)
public void registerRouteCallback(javax.telephony.callcenter.RouteCallback routeCallback, boolean disableAutoRehoming) throws ResourceUnavailableException, MethodNotSupportedExceptionThrows:MethodNotSupportedException, ResourceUnavailableException
CiscoRouteSession
Declaration
public interface CiscoRouteSession extends javax.telephony.callcenter.RouteSessionAll Superinterfaces:
javax.telephony.callcenter.RouteSessionDescription
The CiscoRouteSession supports application access to underlying call associated with a RouteSession. Also, various internal ERRORs where endRoute is called internally are exposed to the 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_TIMOUT
ROUTEADDRESS_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()
public javax.telephony.Call getCall()Returns the call associated with this RouteSession.
Returns:the call associated with this RouteSession
selectRoute(String[], int)
public void selectRoute(java.lang.String[] routeSelected, int callingSearchSpace) throws 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:CiscoRouteSession.DEFAULT_SEARCH_SPACE
CiscoRouteSession.CALLINGADDRESS_SEARCH_SPACE
CiscoRouteSession.ROUTEADDRESS_SEARCH_SPACE
Read above for a description of what each of these means.
Throws:MethodNotSupportedException
CiscoRTPBitRate
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 rate
R6_4
public static final int R6_46.4k G.723 bit rate
CiscoRTPInputProperties
Declaration
public interface CiscoRTPInputProperties
Methods
getBitRate()
public int getBitRate()Returns the media bit rate, one of the following constants:
RTPBitRate.R5_3
RTPBitRate.R6_4
Returns:payload type
getEchoCancellation()
public boolean getEchoCancellation()Returns:echo cancellation
getLocalAddress()
public java.net.InetAddress getLocalAddress()Returns:address to which media will be directed
getLocalPort()
public int getLocalPort()Returns:port to which media will be directed
getPacketSize()
public int getPacketSize()Returns:packet size, in milliseconds
getPayloadType()
public int getPayloadType()Returns the payload format, one of the following constants:
RTPPayload.MEDIAPAYLOAD_NONSTANDARD
RTPPayload.MEDIAPAYLOAD_G711ALAW64K
RTPPayload.MEDIAPAYLOAD_G711ALAW56K
RTPPayload.MEDIAPAYLOAD_G711ULAW64K
RTPPayload.MEDIAPAYLOAD_G711ULAW56K
RTPPayload.MEDIAPAYLOAD_G722_64K
RTPPayload.MEDIAPAYLOAD_G722_56K
RTPPayload.MEDIAPAYLOAD_G722_48K
RTPPayload.MEDIAPAYLOAD_G7231
RTPPayload.MEDIAPAYLOAD_G728
RTPPayload.MEDIAPAYLOAD_G729
RTPPayload.MEDIAPAYLOAD_G729ANNEXA
RTPPayload.MEDIAPAYLOAD_IS11172AUDIOCAP
RTPPayload.MEDIAPAYLOAD_IS13818AUDIOCAP
RTPPayload.MEDIAPAYLOAD_ACY_G729AASSN
RTPPayload.MEDIAPAYLOAD_DATA64
RTPPayload.MEDIAPAYLOAD_DATA56
RTPPayload.MEDIAPAYLOAD_GSM
RTPPayload.MEDIAPAYLOAD_ACTIVEVOICE
Returns:payload type
CiscoRTPInputStartedEv
Declaration
public interface CiscoRTPInputStartedEv extends com.cisco.jtapi.extensions.CiscoTermEvAll Superinterfaces:
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Fields
ID
public static final int IDMethods
getRTPInputProperties()
public CiscoRTPInputProperties getRTPInputProperties()Returns:RTP input properties
CiscoRTPInputStoppedEv
Declaration
public interface CiscoRTPInputStoppedEv extends com.cisco.jtapi.extensions.CiscoTermEvAll Superinterfaces:
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Fields
ID
public static final int IDCiscoRTPOutputProperties
Declaration
public interface CiscoRTPOutputProperties
Methods
getBitRate()
public int getBitRate()Returns the media bit rate, one of the following constants:
RTPBitRate.R5_3
RTPBitRate.R6_4
Returns:payload type
getMaxFramesPerPacket()
public int getMaxFramesPerPacket()Returns:the maximum number of frames to send per packet
getPacketSize()
public int getPacketSize()Returns:packet size, in milliseconds
getPayloadType()
public int getPayloadType()Returns the payload format, one of the following constants:
RTPPayload.MEDIAPAYLOAD_NONSTANDARD
RTPPayload.MEDIAPAYLOAD_G711ALAW64K
RTPPayload.MEDIAPAYLOAD_G711ALAW56K
RTPPayload.MEDIAPAYLOAD_G711ULAW64K
RTPPayload.MEDIAPAYLOAD_G711ULAW56K
RTPPayload.MEDIAPAYLOAD_G722_64K
RTPPayload.MEDIAPAYLOAD_G722_56K
RTPPayload.MEDIAPAYLOAD_G722_48K
RTPPayload.MEDIAPAYLOAD_G7231
RTPPayload.MEDIAPAYLOAD_G728
RTPPayload.MEDIAPAYLOAD_G729
RTPPayload.MEDIAPAYLOAD_G729ANNEXA
RTPPayload.MEDIAPAYLOAD_IS11172AUDIOCAP
RTPPayload.MEDIAPAYLOAD_IS13818AUDIOCAP
RTPPayload.MEDIAPAYLOAD_ACY_G729AASSN
RTPPayload.MEDIAPAYLOAD_DATA64
RTPPayload.MEDIAPAYLOAD_DATA56
RTPPayload.MEDIAPAYLOAD_GSM
RTPPayload.MEDIAPAYLOAD_ACTIVEVOICE
Returns:payload type
getPrecedenceValue()
public int getPrecedenceValue()Returns:precedence value
getRemoteAddress()
public java.net.InetAddress getRemoteAddress()Returns:address to which media is to be transmitted
getRemotePort()
public int getRemotePort()Returns:port to which media is to be transmitted
getSilenceSuppression()
public boolean getSilenceSuppression()Returns:silence suppression
CiscoRTPOutputStartedEv
Declaration
public interface CiscoRTPOutputStartedEv extends com.cisco.jtapi.extensions.CiscoTermEvAll Superinterfaces:
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Fields
ID
public static final int IDMethods
getRTPOutputProperties()
public CiscoRTPOutputProperties getRTPOutputProperties()Returns:RTP output properties
CiscoRTPOutputStoppedEv
Declaration
public interface CiscoRTPOutputStoppedEv extends com.cisco.jtapi.extensions.CiscoTermEvAll Superinterfaces:
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEv
Fields
ID
public static final int IDCiscoRTPPayload
Declaration
public interface CiscoRTPPayloadDescription
The RTPPayload interface contains constants describing RTP formats. These constants are returned by the CiscoRTPInputProperties.getPayloadType method and the CiscoRTPOutputProperties.getPayloadType method.
See Also:
CiscoRTPInputProperties.getPayloadType(), CiscoRTPOutputProperties.getPayloadType()
Fields
ACTIVEVOICE
public static final int ACTIVEVOICEACTIVEVOICE payload
ACY_G729AASSN
public static final int ACY_G729AASSNACY_G729AASSN payload
DATA56
public static final int DATA56DATA56 payload
DATA64
public static final int DATA64DATA64 payload
G711ALAW56K
public static final int G711ALAW56KG.711 56K a-law payload
G711ALAW64K
public static final int G711ALAW64KG.711 64K a-law payload
G711ULAW56K
public static final int G711ULAW56KG.711 56K u-law payload
G711ULAW64K
public static final int G711ULAW64KG.711 64K u-law payload
G722_48K
public static final int G722_48KG.722 48K payload
G722_56K
public static final int G722_56KG.722 56K payload
G722_64K
public static final int G722_64KG.722 64K payload
G7231
public static final int G7231G.723.1 payload
G728
public static final int G728G.728 payload
G729
public static final int G729G.729 payload
G729ANNEXA
public static final int G729ANNEXAG.729a payload
GSM
public static final int GSMGSM payload
IS11172AUDIOCAP
public static final int IS11172AUDIOCAPIS11172AUDIOCAP payload
IS13818AUDIOCAP
public static final int IS13818AUDIOCAPIS13818AUDIOCAP payload
NONSTANDARD
public static final int NONSTANDARDA non-standard RTP payload
CiscoSynchronousObserver
Declaration
public interface CiscoSynchronousObserverDescription
The Cisco JTAPI implementation is designed to allow applications to invoke blocking JTAPI methods such as Call.connect() and TerminalConnection.answer() from within their observer callbacks. This means that applications are not subject to the restrictions imposed by the JTAPI specification, which cautions applications against using JTAPI methods from within observer callbacks.
Normally, when an application adds a new observer to a JTAPI object, the Cisco JTAPI implementation creates an event queue and an accompanying worker thread to service the new observer. If the same observer is added to another object, its queue and thread are reused; in effect, every unique observer object has a single queue and worker thread. As noted, the advantage of this arrangement is that an application may invoke blocking JTAPI methods from within its observer callback. A subtle disadvantage, however, is that accessor methods such as Call.getConnections() and Connection.getState() may not return results that are consistent with events when invoked from within the observer callback.
For example, suppose that an application creates and connects a call from address "A" to address "B". If the application is observing address "A", it might reasonably expect that when it receives the CallActiveEv, the state of the call will be Call.ACTIVE. This is not necessarily so, since the worker thread delivering events to the application is decoupled from the internal JTAPI thread that is updating object states. In fact, if "B" rejects the call from "A", the call object might be in either the Call.ACTIVE state or the Call.INVALID state, depending on the exact moment at which the worker thread delivers the CallActiveEv.
Many applications will not be adversely affected by this asychronous behavior. Applications that would benefit from a coherent call model during observer callbacks, however, can selectively disable the queueing logic of the Cisco JTAPI implementation. By implementing the CiscoSynchronousObserver interface on its observer objects, an application declares that it wishes events to be delivered synchronously to its observers. Events delivered to synchronous observers will match the states of the call model objects queried from within the observer callback.
Usage Notes
Objects that implement the CiscoSynchronousObserver interface are strictly forbidden from invoking blocking JTAPI methods from within their event callbacks. The consequences of doing so are unpredictable, and may include deadlocking the JTAPI implementation. On the other hand, they may safely use the accessor methods of any JTAPI object, for instance Call.getConnections() or Connection.getState().
CiscoTelephonyException
Declaration
public interface CiscoTelephonyExceptionDescription
The CiscoTelephonyException interface defines CTI error codes. These are the error codes that may be returned by CTI requests. All the JTAPI exceptions have been extended to implement this interface.
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_NOTINCOMINGCALLCANNOT_OPEN_DEVICE
public static final int CANNOT_OPEN_DEVICECANNOT_TERMINATE_MEDIA_ON_PHONE
public static final int CANNOT_TERMINATE_MEDIA_ON_PHONECOMMAND_NOT_IMPLEMENTED_ON_DEVICE
public static final int COMMAND_NOT_IMPLEMENTED_ON_DEVICEDB_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_DEVICESDEVICE_NOT_OPEN
public static final int DEVICE_NOT_OPENDIRECTORY_LOGIN_FAILED
public static final int DIRECTORY_LOGIN_FAILEDEXISTING_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_FORMATLINECONTROL_FAILURE
public static final int LINECONTROL_FAILURENO_ACTIVE_DEVICE_FOR_THIRDPARTY
public static final int NO_ACTIVE_DEVICE_FOR_THIRDPARTYPROTOCOL_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 RETRIEVEFAILEDSSAPI_NOT_REGISTERED
public static final int SSAPI_NOT_REGISTEREDTIMEOUT
public static final int TIMEOUTTRANSFERFAILED
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 UNSPECIFIEDMethods
getDetailedCause()
public int getDetailedCause()CiscoTermCreatedEv
Declaration
public interface CiscoTermCreatedEv extends com.cisco.jtapi.extensions.CiscoProvEvAll Superinterfaces:
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEvDescription
The CiscoTermCreatedEv event
Fields
ID
public static final int IDMethods
getTerminal()
public javax.telephony.Terminal getTerminal()CiscoTermEv
Declaration
public interface CiscoTermEv extends com.cisco.jtapi.extensions.CiscoEv, javax.telephony.events.TermEvAll Superinterfaces:
CiscoEv, javax.telephony.events.Ev, javax.telephony.events.TermEvAll Known Subinterfaces:
CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputStartedEv, CiscoRTPOutputStoppedEv, CiscoTermInServiceEv, CiscoTermOutOfServiceEvDescription
The CiscoTermEv interface, which extends JTAPI's core javax.telephony.events.TermEv interface, serves as the base interface for all Cisco-extended JTAPI Terminal events. Every Call-related event in this package extends this interface, directly or indirectly.
See Also:
javax.telephony.events.CallEv
CiscoTerminal
Declaration
public interface CiscoTerminal extends javax.telephony.Terminal, com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
CiscoObjectContainer, javax.telephony.TerminalAll Known Subinterfaces:
CiscoMediaTerminalDescription
Since JTAPI does not support the notion of dynamic terminal registration, the CiscoTerminal interface extends the standard Terminal interface to do so. All CallMananger devices are represented by CiscoTerminals, and all CiscoTerminals may be queried to determine whether they are currently IN_SERVICE or OUT_OF_SERVICE.
If the CallManager device represented by the CiscoTerminal is an IP telephone, for instance, it would become OUT_OF_SERVICE if it were to lose its network connection. Other types of devices, such as CTIPorts, are registered on demand by applications, and may be IN_SERVICE or OUT_OF_SERVICE accordingly.
See Also:
javax.telephony.Terminal, CiscoMediaTerminal
Fields
IN_SERVICE
public static final int IN_SERVICEOUT_OF_SERVICE
public static final int OUT_OF_SERVICEMethods
getRegistrationState()
public int getRegistrationState()Deprecated.This method has been replaced by the getState() method.
Returns the state of this terminal.
The state may be any of the following constants:
CiscoTerminal.OUT_OF_SERVICE
CiscoTerminal.IN_SERVICE
Returns:the state of this terminal
getRTPInputProperties()
public CiscoRTPInputProperties getRTPInputProperties() throws InvalidStateExceptionThe CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state. and Terminal.getTerminalConnections () must return at least one terminal connection in the TerminalConnection.ACTIVE state.
Returns:the properties to be used for the RTP input stream associated with the ACTIVE TerminalConnection on this Terminal
Throws:InvalidStateException
getRTPOutputProperties()
public CiscoRTPOutputProperties getRTPOutputProperties() throws InvalidStateExceptionThe CiscoTerminal must be in the CiscoTerminal.REGISTERED state, its Provider must be in the Provider.IN_SERVICE state. and Terminal.getTerminalConnections () must return at least one terminal connection in the TerminalConnection.ACTIVE state.
Returns:the properties to be used for the RTP output stream associated with the ACTIVE TerminalConnection on this Terminal
Throws:InvalidStateException
getState()
public int getState()the state of this terminal.
The state may be any of the following constants:
CiscoTerminal.OUT_OF_SERVICE
CiscoTerminal.IN_SERVICE
Returnsthe state of this terminal
CiscoTerminalConnection
Declaration
public interface CiscoTerminalConnection extends javax.telephony.callcontrol.CallControlTerminalConnection, com.cisco.jtapi.extensions.CiscoObjectContainerAll Superinterfaces:
javax.telephony.callcontrol.CallControlTerminalConnection, CiscoObjectContainer, javax.telephony.TerminalConnectionDescription
The CiscoTerminalConnection interface extends the CallControlTerminalConnection interface with additional capabilities.
Applications can use the getReason method to obtain the reason for the creation of this Connection.
CiscoTerminalObserver
Declaration
public interface CiscoTerminalObserver extends javax.telephony.TerminalObserverAll Superinterfaces:
javax.telephony.TerminalObserverDescription
Applications implement this interface in order to receive CiscoTermEv events such as CiscoRTPInputStartedEv and CiscoRTPInputStoppedEv when observing Terminals via the Terminal.addObserver method.
See Also:
CiscoTermInServiceEv, CiscoTermOutOfServiceEv, CiscoRTPInputStartedEv, CiscoRTPInputStoppedEv, CiscoRTPOutputStartedEv, CiscoRTPOutputStoppedEv
CiscoTermInServiceEv
Declaration
public interface CiscoTermInServiceEv extends com.cisco.jtapi.extensions.CiscoTermEvAll Superinterfaces:
CiscoEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEvDescription
The CiscoTermInServiceEv event
Fields
ID
public static final int IDCiscoTermOutOfServiceEv
Declaration
public interface CiscoTermOutOfServiceEv extends com.cisco.jtapi.extensions.CiscoTermEv, com.cisco.jtapi.extensions.CiscoOutOfServiceEvAll Superinterfaces:
CiscoEv, CiscoOutOfServiceEv, CiscoTermEv, javax.telephony.events.Ev, javax.telephony.events.TermEvDescription
The CiscoTermOutOfServiceEv event
Fields
ID
public static final int IDCiscoTermRemovedEv
Declaration
public interface CiscoTermRemovedEv extends com.cisco.jtapi.extensions.CiscoProvEvAll Superinterfaces:
CiscoEv, CiscoProvEv, javax.telephony.events.Ev, javax.telephony.events.ProvEvDescription
The CiscoTermRemovedEv event
Fields
ID
public static final int IDMethods
getTerminal()
public javax.telephony.Terminal getTerminal()CiscoTransferEndEv
Declaration
public interface CiscoTransferEndEv extends com.cisco.jtapi.extensions.CiscoCallEvAll Superinterfaces:
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.EvDescription
The CiscoTransferEndEv event indicates that a transfer operation has completed. This event is reported via the CallControlCallObserver interface.
Fields
ID
public static final int IDMethods
getFinalCall()
public javax.telephony.Call getFinalCall()the call that remains active after the transfer is completed.
getTransferController()
public javax.telephony.TerminalConnection getTransferController()the TerminalConnection which currently acts as the transfer controller for this call —- the final call. This method null if the transfer controller is not being observed.
getTransferControllerAddress()
public javax.telephony.Address getTransferControllerAddress()the Address which currently acts as the transfer controller for this call —- the final call.
getTransferredCall()
public javax.telephony.Call getTransferredCall()the call that has been transferred. This call is in the Call.INVALID state.
CiscoTransferStartEv
Declaration
public interface CiscoTransferStartEv extends com.cisco.jtapi.extensions.CiscoCallEvAll Superinterfaces:
javax.telephony.events.CallEv, CiscoCallEv, CiscoEv, javax.telephony.events.EvDescription
The CiscoTransferStartEv event indicates that a transfer operation has started. This event is reported via the CallControlCallObserver interface.
Fields
ID
public static final int IDMethods
getFinalCall()
public javax.telephony.Call getFinalCall()the call that will remain active after the transfer is completed.
getTransferController()
public javax.telephony.TerminalConnection getTransferController()the TerminalConnection which currently acts as the transfer controller for this call —- the final call. This method null if the transfer controller is not being observed.
getTransferControllerAddress()
public javax.telephony.Address getTransferControllerAddress()the Address which currently acts as the transfer controller for this call —- the final call.
getTransferredCall()
public javax.telephony.Call getTransferredCall()the call that will be transferred.
Class com.cisco.services.alarm
The Cisco JTAPI alarm implementation consists a set of classes and interfaces that exposes the alarm capabilities in Cisco JTAPI. Applications can use the interfaces and classes in this package to generate XML form alarms that can be dispatched to an Alarm Service on the network that establishes a TCP link with buffering capability and connection retry logic. More details can be found in the detailed class description and javadoc. Application developers can override the default implementation in the com.cisco.services.alarm package by implementing their own alarm classes. These alarm classes must conform to the interfaces to be deployed within the existing Alarm frameworks.
Table 2-3 Cisco JTAPI Alarm Classes and Their Methods
AlarmManager
Declaration
public class AlarmManagerjava.lang.Object|+--com.cisco.services.alarm.AlarmManagerDescription
The AlarmManager is used to create Alarm objects. The AlarmManager is created with a facility and AlarmService hostname and port. All alarms created by the factory will be associated with this facility. This class also maintains a reference to a single AlarmWriter that can be used system wide. JTAPI or an application can make use of this AlarmWriter. AlarmManager exposes a default implementation of an AlarmWriter. Applications can override this with a user defined implementaion of their own AlarmWriter.
Usage: AlarmManager AlarmManager = new AlarmManager(facilityName, alarmServiceHost, alarmServicePort, debugTrace, errorTrace);
Alarms are created by the factory by supplying the alarmName (mnemonic), subfacility and severity Alarms can be cached for use in different parts of the application. During a send alarm applications can specify the the variable parameters that offer specific information to the AlarmService.
Usage:
Typically applications wil maintian their own AlarmManager intance. Applications will also have to set a debug and error trace to enable the alarm tracing to also be sent to the existing trace destinations.
Setup the manager and writer classes:
AlarmWriter alarmWriter = new DefaultAlarmWriter(port, alarmServiceHost);
AlarmManager alarmManager = new AlarmManager("AA_IVR", alarmWriter, debugTrace, errorTrace);
Generating the Alarms:
create an alarm for the subfacility and a default severity.
Alarm alarm = alarmManager.createAlarm("JTAPISS", Alarm.INFORMATIONAL);
alarm.send("090T") sends the alarm with the mnemonic
alarm.send("090T", "Port is stuck", "CTIPort01") or with a mnemonic and parameter
Note
Constructors
AlarmManager(String, AlarmWriter, Trace, UnconditionalTrace)
public AlarmManager(java.lang.String facility, AlarmWriter writer, com.cisco.services.tracing.Trace debugTrace_, com.cisco.services.tracing.UnconditionalTrace errorTrace_)Create an instance of the AlarmManager for the facility. Applications specify an AlarmWriter to be used by this AlarmManager to send the Alarms to the AlarmService.
Methods
createAlarm(String, int)
public Alarm createAlarm(java.lang.String subfacility, int severity)Creates an Alarm of required severity for the subFacility
Returns:an object implementing the alarm interface
getAlarmWriter()
public AlarmWriter getAlarmWriter()Returns:an AlarmWriter object
setAlarmWriter(AlarmWriter)
public void setAlarmWriter(AlarmWriter writer)Allows applications to override the AlarmWriter to be used by this AlarmManager, with a user defined AlarmWriter
DefaultAlarm
Declaration
public class DefaultAlarm implements com.cisco.services.alarm.Alarmjava.lang.Object|+--com.cisco.services.alarm.DefaultAlarmAll Implemented Interfaces:
AlarmDescription
An Implementation of the Alarm interface. The AlarmManager creates these Alarms when the createAlarm() method is called.
Constructors
DefaultAlarm(String, String, int, AlarmWriter)
public DefaultAlarm(java.lang.String facility, java.lang.String subFacility, int severity, AlarmWriter alarmWriter)Methods
getFacility()
public java.lang.String getFacility()Specified By:Alarm.getFacility() in interface Alarm
getSeverity()
public int getSeverity()Specified By:Alarm.getSeverity() in interface Alarm
getSubFacility()
public java.lang.String getSubFacility()Specified By:Alarm.getSubFacility() in interface Alarm
send(String)
public void send(java.lang.String mnemonic)Send the alarm with the specified menmonic
Specified By:Alarm.send(String) in interface Alarm
send(String, ParameterList)
public void send(java.lang.String mnemonic, ParameterList paramList)Send the alarm with the specified name and list of parameters.
Specified By:Alarm.send(String, ParameterList) in interface Alarm
send(String, String, String)
public void send(java.lang.String mnemonic, java.lang.String paramName, java.lang.String paramValue)Send the alarm with the specified name and parameter
Specified By:Alarm.send(String, String, String) in interface Alarm:
DefaultAlarmWriter
Declaration
public class DefaultAlarmWriter implements com.cisco.services.alarm.AlarmWriterjava.lang.Object|+--com.cisco.services.alarm.DefaultAlarmWriterAll Implemented Interfaces:
AlarmWriterDescription
DefaultAlarmWriter implementation of the AlarmWriter interface.
DefaultAlarmWriter maintains a queue of a fixed size to which the alarms are written. The sending of the alarms to the alarm service takes place on a seperate thread. The queue is fixed size.
Constructors
DefaultAlarmWriter(int, String)
public DefaultAlarmWriter(int port, java.lang.String alarmServiceName) throws UnknownHostExceptionConstructor for the DefaultAlarmWriter which takes the AlarmService hostname, port and a queue size of fifty (50). The AlarmService is listening on this port for Alarm messages.
Parameters:port - port on which the alarm service is listening
alarmServiceName - The host name of the machine with the Alarm service
Throws:UnknownHostException
DefaultAlarmWriter(int, String, int)
public DefaultAlarmWriter(int port, java.lang.String alarmServiceName, int queueSize) throws UnknownHostExceptionConstructor for the DefaultAlarmWriter which takes the AlarmService hostname, port and queue size. The AlarmService is listening on this port for Alarm messages.
Parameters:port - port on which the alarm service is listening
alarmServiceName - The host name of the machine with the Alarm service
queueSize - the size of the queue to be maintained in the alarm writer
Throws:UnknownHostException
DefaultAlarmWriter(int, String, int, ConditionalTrace, UnconditionalTrace)
public DefaultAlarmWriter(int port, java.lang.String alarmServiceName, int queueSize, com.cisco.services.tracing.ConditionalTrace debugTrace_, com.cisco.services.tracing.UnconditionalTrace errorTrace_) throws UnknownHostExceptionConstructor for the DefaultAlarmWriter which takes the AlarmService hostname, port and queue size. The AlarmService is listening on this port for Alarm messages.
Parameters:port - port on which the alarm service is listening
alarmServiceName - The host name of the machine with the Alarm service
queueSize - the size of the queue to be maintained in the alarm writer
Throws:UnknownHostException
Methods
close()
public void close()Shutdown the send thread and close the socket
Specified By:AlarmWriter.close() in interface AlarmWriter
getDescription()
public java.lang.String getDescription()Specified By:AlarmWriter.getDescription() in interface AlarmWriter
Returns:a short description of the AlarmWriter
getEnabled()
public boolean getEnabled()Specified By:AlarmWriter.getEnabled() in interface AlarmWriter
Returns:the enabled state of the AlarmWriter
getName()
public java.lang.String getName()Specified By:AlarmWriter.getName() in interface AlarmWriter
Returns:the name of the AlarmWriter
main(String[])
public static void main(java.lang.String[] args)send(String)
public void send(java.lang.String alarmMessage)send the Alarm to the alarm service
Specified By:AlarmWriter.send(String) in interface AlarmWriter
setEnabled(boolean)
public void setEnabled(boolean enable)Applications can dynamically enable or disable the AlarmWriter
Specified By:AlarmWriter.setEnabled(boolean) in interface AlarmWriter
ParameterList
Declaration
public class ParameterListjava.lang.Object|+--com.cisco.services.alarm.ParameterListDescription
ParameterList is a list of name value pairs that is used to send additional (and optional) user defined parameters to the AlarmService. These parameters can contain the specifics of an Alarm As an example a LowResourceAlarm can have and parameter that informs the service which particular resource is low:
name="CPUUsage"
value="0.9"
These paramters are user definable but must, however, also be pre-defined in the AlarmService catalog.
Constructors
ParameterList()
public ParameterList()Default constructor for the ParameterList
ParameterList(String, String)
public ParameterList(java.lang.String name, java.lang.String value)Constructor that takes a name value pair.
Methods
addParameter(String, String)
public void addParameter(java.lang.String name, java.lang.String value)method used to add additional name value pairs (parameters) to the list
getParameterNames()
public java.lang.String[] getParameterNames()Get the parameter names in the list
Returns:array of parameters
getParameterValue(String)
public java.lang.String getParameterValue(java.lang.String parameterName)get the value for a parameter
Returns:value of a parameter
removeAllParameters()
public void removeAllParameters()remove all the parameters in the list
removeParameter(String)
public void removeParameter(java.lang.String parameterName)remove a particular parameter if it is in the list
toString()
public java.lang.String toString()Overrides:java.lang.Object.toString() in class java.lang.Object
Table 2-4
Cisco JTAPI Alarm Interfaces and Their Methods
Alarm
Declaration
public interface AlarmAll Known Implementing Classes:
DefaultAlarmDescription
The Alarm interface is used to define Alarms in Cisco JTAPI. An Alarm has an XML representation that it must adhere to in order to be recognized by the Alarm Service, with a DTD as shown below. An application can implement this interface or use the AlarmFactory to generate Alarms of the correct format. The Alarm is the a specification that needs to be sent to an AlarmService that will take some action based on the Alarm. Using this specification the AlarmService will access definitions available in a catalog. This catalog is maintained by the user requiring the Alarm function to effect the appropriate action for the Alarm. The severity specified the Alarm can over-ride the severity associated with this Alarm in the catalog. If no severity is specified in the Alarm the catalog severity is used.
Alarm severities are derived from Syslog and are defined as follows:0 = EMERGENCIES System unusable
1 = ALERTS Immediate action needed
2 = CRITICAL Critical conditions
3 = ERROR Error conditions
4 = WARNING Warning conditions
5 = NOTIFICATION Normal but significant condition
6 = INFORMATIONAL Informational messages only
7 = DEBUGGING Debugging messages
Fields
ALERTS
public static final int ALERTSThe application will continue working on the tasks but all functions may not be operational (one or more devices in the list are not accessible but others in the list can be accessed)
Syslog severity level = 1CRITICAL
public static final int CRITICALA critical failure, the application can not accomplish the tasks required due to this failure, eg: the app cant open the database to read the device list
Syslog severity level = 2DEBUGGING
public static final int DEBUGGINGVery detailed information regarding errors or processing status that is only generated when DEBUG mode has been enabled
Syslog severity level = 7EMERGENCIES
public static final int EMERGENCIESEmergency situation, a system shutdown is necessary
Syslog severity level = 0ERROR
public static final int ERRORAn error condition of some kind has occurred and the user needs to understand the nature of that failure
Syslog severity level = 3HIGHEST_LEVEL
public static final int HIGHEST_LEVELThe highest trace level, currently this is DEBUGGING with a trace level of 7
INFORMATIONAL
public static final int INFORMATIONALInformation of some form not relating to errors, warnings, audit, or debug
Syslog severity level =6LOWEST_LEVEL
public static final int LOWEST_LEVELThe lowest trace level, currently this is EMERGENCIES with a trace level of 0
NO_SEVERITY
public static final int NO_SEVERITYApplications can set this level to generate Alarms without a severity. NOTE: This is only intended for cases where an application wants the AlarmService to use the severity associated with the Alarm in the catalog
NOTIFICATION
public static final int NOTIFICATIONNotification denotes a normal but significant condition
Syslog severity level = 5UNKNOWN_MNEMONIC
public static final java.lang.String UNKNOWN_MNEMONICString used when a mnemonic is not specifed during an Alarm send
WARNING
public static final int WARNINGWarning that a problem of some form exists but is not keeping the application from completing its tasks
Syslog severity level = 4Methods
getFacility()
public java.lang.String getFacility()Returns:the facility name of this Alarm
getSeverity()
public int getSeverity()Returns:severity of the alarm, an integer in the range [0-7]
getSubFacility()
public java.lang.String getSubFacility()Returns:the subfacility of this Alarm
send(String)
public void send(java.lang.String mnemonic)send the Alarm with the specified mnemonic. If a null or empty String is passed a mnemonic UNK is sent
send(String, ParameterList)
public void send(java.lang.String mnemonic, ParameterList parameterList)send an Alarm with the specified mnemonic and supplied parameter list
send(String, String, String)
public void send(java.lang.String mnemonic, java.lang.String parameterName, java.lang.String parameterValue)send an Alarm with the specified mnemonic and with one parameter
AlarmWriter
Declaration
public interface AlarmWriterAll Known Implementing Classes:
DefaultAlarmWriterDescription
An AlarmWriter receives alarm messages and transmits it to the receiving AlarmService on a TCP link. This interface can be used to implement other AlarmWriters to be used with this implementation of com.cisco.service.alarm A DefaultAlarmWriter is provided with this implementation and can be obtained from the AlarmManager.
Methods
close()
public void close()close the AlarmWriter
getDescription()
public java.lang.String getDescription()Returns:the AlarmWriter description
getEnabled()
public boolean getEnabled()Returns:the current enabled or diabled state of the AlarmWriter
getName()
public java.lang.String getName()Returns:the AlarmWriter name
send(String)
public void send(java.lang.String alarmMessage)Send out the alarm message to the AlarmService.
Parameters:the - Alarm to be sent
setEnabled(boolean)
public void setEnabled(boolean enable)Enable or disable the AlarmWriter
Parameters:enable - or disable the AlarmWriter
Class com.cisco.services.tracing
The Cisco JTAPI tracing implementation provides an exception tracing facility for use both in debugging your applications and in logging exceptions in the released application. Three main levels of trace are defined: WARNING, INFORMATIONAL and DEBUGGING. DEBUGGING represents the high level tracing. In addition, the DEBUGGING levels from specific JTAPI subareas can be selectively turned on or off. (Trace flags can be enabled or disabled using the jtprefs application or by editing the jtapi.ini file in the jdk 1.2 environments.) The message format is:
yyyy mmm dd hh:mm:ss TimeZone <-/+>hh:mm :%FACILITY-[SUBFACILITY-]SEVERITY-MNEMONIC:Message-textCisco JTAPI Tracing Classes
Table 2-5 Cisco JTAPI Tracing Classes and their Methods
BaseTraceWriter
Declaration
public abstract class BaseTraceWriter implements com.cisco.services.tracing.TraceWriterjava.lang.Object|+--com.cisco.services.tracing.BaseTraceWriterAll Implemented Interfaces
TraceWriterDirect Known Subclasses
ConsoleTraceWriter, LogFileTraceWriter, OutputStreamTraceWriter, SyslogTraceWriterDescription
This abstract class is useful for supplying a default, non-printing TraceWriter to a TraceWriterManager This class must be extended to provide the functionality to trace to different streams. The doPrintln () method must be implemented by the extending class.
Constructors
BaseTraceWriter (int[], String, String)
protected BaseTraceWriter(int[] traceLevels, java.lang.String name, java.lang.String description)BaseTraceWriter with trace levels as passed in traceLevels in the array falling outside the range Trace.LOWEST_LEVEL and Trace.HIGHEST_LEVEl are ignored
ParameterstraceLevels, array of trace levels
See AlsoTrace
BaseTraceWriter(int, String, String)
protected BaseTraceWriter(int maxTraceLevel, java.lang.String name, java.lang.String description)BaseTraceWriter that traces all levels upto the maxTraceLevel The trace level is maintained in the range [Trace.HIGHEST_LEVEL, Trace.LOWEST_LEVEL ]
See AlsoTrace
BaseTraceWriter(String, String)
protected BaseTraceWriter(java.lang.String name, java.lang.String description)BaseTraceWriter which only traces the lowest level ie severity level, Trace.LOWEST_LEVEL messages
See AlsoTrace
Methods
close()
public final void close()Specified By:TraceWriter.close() in interface TraceWriter
doClose()
protected void doClose()doFlush()
protected void doFlush()doPrintln(String, int)
protected abstract void doPrintln(java.lang.String message, int messageNumber)Must be implemented by the various TraceWriters extending BaseTraceWriter to provide the specific tracing functionality
flush()
public final void flush()Specified By:TraceWriter.flush() in interface TraceWriter
getDescription()
public final java.lang.String getDescription()Specified By:TraceWriter.getDescription() in interface TraceWriter
getEnabled()
public boolean getEnabled()Specified By:TraceWriter.getEnabled() in interface TraceWriter
getName()
public final java.lang.String getName()Specified By:TraceWriter.getName() in interface TraceWriter
getTraceLevels()
public final int[] getTraceLevels()Specified By:TraceWriter.getTraceLevels() in interface TraceWriter
println(String, int)
public final void println(java.lang.String message, int severity)Specified By:TraceWriter.println(String, int) in interface TraceWriter
setTraceLevels(int[])
public final void setTraceLevels(int[] levels)Specified By:TraceWriter.setTraceLevels(int[]) in interface TraceWriter
toString()
public final java.lang.String toString()Overrides:java.lang.Object.toString() in class java.lang.Object
ConsoleTraceWriter
Declaration
public final class ConsoleTraceWriter extends com.cisco.services.tracing.BaseTraceWriterjava.lang.Object|+--com.cisco.services.tracing.com.cisco.services.tracing.BaseTraceWriter|+--com.cisco.services.tracing.ConsoleTraceWriterAll Implemented Interfaces
TraceWriterDescription
Supplies a console TraceWriter to trace to System.out.
See Also:
Trace
Constructors
ConsoleTraceWriter()
public ConsoleTraceWriter()Default constructor, traces all severity levels
ConsoleTraceWriter(int)
public ConsoleTraceWriter(int maxTraceLevel)Constructor that sets the maximum level to be traced.
See Also:Trace
ConsoleTraceWriter(int[])
public ConsoleTraceWriter(int[] traceLevels)Construct a ConsoleTraceWriter with an array of trace levels Only traces with the severity in the tracelevel array are traced
Parameters:int - [] traceLevels
See Also:Trace
Methods
doFlush()
protected final void doFlush()Overrides:BaseTraceWriter.doFlush() in class BaseTraceWriter
doPrintln(String, int)
protected final void doPrintln(java.lang.String message, int messageNumber)Overrides:BaseTraceWriter.doPrintln(String, int) in class BaseTraceWriter
main(String[])
public static void main(java.lang.String[] args)LogFileTraceWriter
Declaration
public final class LogFileTraceWriter extends com.cisco.services.tracing.BaseTraceWriterjava.lang.Object|+--com.cisco.services.tracing.com.cisco.services.tracing.BaseTraceWriter|+--com.cisco.services.tracing.LogFileTraceWriterAll Implemented Interfaces:
TraceWriterDescription
This class extends the BaseTraceWriter class to implement a TraceWriter that writes to a set of log files, rotating among them as each becomes filled to a specified capacity and stores them in a specified directory.
Each of the log files is named according to a pattern controlled by three properties, CurrentFile, FileNameBase, and FileExtension. The CurrentFile property determines which log file, by ordinal number, is being written at present, the FileNameBase property determines the prefix of each log file name, and the FileExtension property determines the suffix, e.g. "txt". From these properties, log files are named FileNameBase LeadingZeroPadding CurrentFile.FileExtension. The CurrentFile property takes on a value from 1 to the value of the MaxFiles property. Note that the CurrentFile property, when converted to a String, is padded with leading zeroes depending on the values of the MaxFiles and CurrentFile properties. An index file tracks the index of the last file written. If the logFileWriter is recreated (for example if an application is restarted) new files will continue from the last written index.
Where the log files are stored is determined by the path, dirNameBase, useSameDir. If a path is not specified, the current path is used as default. If a dirNameBase is not specified, it write log files in the path. Depending upon whether useSameDir is true or false, files are written to the same directory or a new directory, each time an instance of LogFileTraceWriter is created. In case new directories are being made each time, the directory name will consist of the dirNameBase and a number, seperated by an '_'. The number is one more than the greatest number associated with directories with the same dirNameBame in the path. While specifying the path, you may use either a "/" or "\\", but not "\"
The LogFileTraceWriter keeps track of how many bytes have been written to the current log file. When that number grows within approximately LogFileTraceWriter.ROLLOVER_THRESHOLD bytes, tracing continues to the next file, which is either CurrentFile + 1 if CurrentFile is not equal to MaxFiles, or 1 if CurrentFile is equal to MaxFiles.
Note
Example
The following code instantiates a LogFileTraceWriter that will create log files called "MyLog01.log" through "MyLog12.log". Each file will grow to approximately 100K bytes in size before the next file is created:
LogFileTraceWriter out = new LogFileTraceWriter ( "MyLog", "log", 12, 100 * 1024 ); will create a log file TraceWriter which will rotate traces to 12 files from Mylog01.log and Mylog12.log with a file size of 100 KBytes. By default the tracing is set to the HIGHEST_LEVEL
Example
The following code constructs a LogFileTraceWriter which stores the log files in the path "c:/LogFiles" in a sub directory, "Run". The files will be named MyLogXX.log. The number of rotating files will be 12 with a size of 100 KB. The same directory is used for each instance of the application.
LogFileTraceWriter out = new LogFileTraceWriter ( "c:/logFiles", "Run", "MyLog", "log", 12, 100*1024, true );
See Also:
Trace
Fields
DEFAULT_FILE_NAME_BASE
public static final java.lang.String DEFAULT_FILE_NAME_BASEDEFAULT_FILE_NAME_EXTENSION
public static final java.lang.String DEFAULT_FILE_NAME_EXTENSIONDIR_BASE_NAME_NUM_SEPERATOR
public static final char DIR_BASE_NAME_NUM_SEPERATORMIN_FILE_SIZE
public static final int MIN_FILE_SIZEMIN_FILES
public static final int MIN_FILESROLLOVER_THRESHOLD
public static final int ROLLOVER_THRESHOLDConstructors
LogFileTraceWriter(String, String, int, int)
public LogFileTraceWriter(java.lang.String fileNameBase, java.lang.String fileNameExtension, int maxFiles, int maxFileSize) throws IOExceptionDefault constructor for LogFileTraceWriter that rotates among an arbitrary number of files with tracing for all levels. Since a path and Directory Base name is not specified, it writes the files to the current directory without any sub directories.
LogFileTraceWriter(String, String, String, String, int, int, boolean)
public LogFileTraceWriter(java.lang.String path, java.lang.String dirNameBase, java.lang.String fileNameBase, java.lang.String fileNameExtension, int maxFiles, int maxFileSize, boolean useSameDir) throws IOExceptionDefault constructor for LogFileTraceWriter that rotates among an arbitrary number of files with tracing for all levels.
LogFileTraceWriter(String, String, String, String, int, int, int, boolean)
public LogFileTraceWriter(java.lang.String path, java.lang.String dirNameBase, java.lang.String fileNameBase, java.lang.String fileNameExtension, int maxFiles, int maxFileSize, int maxTraceLevel, boolean useSameDir) throws IOExceptionConstructs a LogFileTraceWriter that rotates among an arbitrary number of files storing them in a specified directory.
Throws:IOException
Methods
doClose()
protected void doClose()Closes this OutputStream. Any log file that is currently open will be closed as well.
Overrides:BaseTraceWriter.doClose() in class BaseTraceWriter
doFlush()
protected void doFlush()Overrides:BaseTraceWriter.doFlush() in class BaseTraceWriter
doPrintln(String, int)
protected void doPrintln(java.lang.String message, int messageNumber)Overrides:BaseTraceWriter.doPrintln(String, int) in class BaseTraceWriter
getCurrentFile()
public int getCurrentFile()Returns the CurrentFile property
Returns:the CurrentFile property
getFileExtension()
public java.lang.String getFileExtension()Returns the FileExtension property
Returns:the FileExtension property
getFileNameBase()
public java.lang.String getFileNameBase()Returns the FileNameBase property
Returns:the FileNameBase property
getMaxFiles()
public int getMaxFiles()Returns the MaxFiles property
Returns:the MaxFiles property
getMaxFileSize()
public int getMaxFileSize()Returns the MaxFileSize property
Returns:the MaxFileSize property
OutputStreamTraceWriter
Declaration
public final class OutputStreamTraceWriter extends com.cisco.services.tracing.BaseTraceWriterjava.lang.Object|+--com.cisco.services.tracing.com.cisco.services.tracing.BaseTraceWriter|+--com.cisco.services.tracing.OutputStreamTraceWriterAll Implemented Interfaces:
TraceWriterDescription
OutputStreamTraceWriter wraps an output stream in a TraceWriter. This simplifies adding custom tracing classes that can co-exist with JTAPI TraceWriters.
Constructors
OutputStreamTraceWriter(int, OutputStream)
public OutputStreamTraceWriter(int maxTraceLevel, java.io.OutputStream outputStream)Default constructor which is autoflushing
See Also:
Trace
OutputStreamTraceWriter(int, OutputStream, boolean)
public OutputStreamTraceWriter(int maxTraceLevel, java.io.OutputStream outputStream, boolean autoFlush)Create an OutputStreamTraceWriter
Methods
doClose()
protected void doClose()Overrides:BaseTraceWriter.doClose() in class BaseTraceWriter
doFlush()
protected void doFlush()Overrides:BaseTraceWriter.doFlush() in class BaseTraceWriter
doPrintln(String, int)
protected void doPrintln(java.lang.String message, int messageNumber)Overrides:BaseTraceWriter.doPrintln(String, int) in class BaseTraceWriter
getOutputStream()
public java.io.OutputStream getOutputStream()Returns:the output stream associated with the TraceWriter
SyslogTraceWriter
Declaration
public final class SyslogTraceWriter extends com.cisco.services.tracing.BaseTraceWriterjava.lang.Object|+--com.cisco.services.tracing.com.cisco.services.tracing.BaseTraceWriter|+--com.cisco.services.tracing.SyslogTraceWriterAll Implemented Interfaces:
TraceWriterDescription
SyslogTraceWriter refines the BaseTraceWriter to allow tracing to syslog. Cisco syslog specification calls for sending low level traces to a syslog collector in the form of UDP messages. No buffering is done in this TraceWriter. The SyslogTraceWriter makes an exception to the println() method in that it places a '\0' instead of a System specified line seperator to terminate the message packet.
Constructors
SyslogTraceWriter(int, String)
public SyslogTraceWriter(int port, java.lang.String collector)Default SyslogTraceWriter with a max trace level of INFORMATIONAL
See Also:Trace
SyslogTraceWriter(int, String, int)
public SyslogTraceWriter(int port, java.lang.String collector, int maxTraceLevel)SyslogTraceWriter with max trace level specified
See Also:Trace
SyslogTraceWriter(int, String, int[])
public SyslogTraceWriter(int port, java.lang.String collector, int[] traceLevels)SyslogTraceWriter which takes an array of trace levels.
See Also:Trace
Methods
doClose()
public void doClose()Closes the socket
Overrides:BaseTraceWriter.doClose() in class BaseTraceWriter
doPrintln(String, int)
protected void doPrintln(java.lang.String message, int messageNumber)The SyslogTraceWriter makes an exception to the println() method in that it places a '\0' instead of a System specified line seperator to terminate the message packet. The portion of the message after a '\r' or '\n' is ignored
Overrides:BaseTraceWriter.doPrintln(String, int) in class BaseTraceWriter
main(String[])
public static void main(java.lang.String[] args)TraceManagerFactory
Declaration
public class TraceManagerFactoryjava.lang.Object|+--com.cisco.services.tracing.TraceManagerFactoryDescription
The TraceManagerFactory class is a class by which applications obtain a TraceManager object. The TraceModule passed in the constructor is registered in a list. The list can be enumerated using the getModules() method.
Methods
getModules()
public static java.util.Enumeration getModules()Returns an enumeration of the TraceModules registered with this factory.
registerModule(TraceModule)
public static TraceManager registerModule(TraceModule module)Returns an instance of a TraceManager object. The contained TraceWriterManager will not have any default TraceWriters.
registerModule(TraceModule, String[], TraceWriterManager)
public static TraceManager registerModule(TraceModule module, java.lang.String[] subFacilities, TraceWriterManager traceWriterManager)Returns an instance of a TraceManager object. Trace output will be redirected to the TraceWriterManager object specified.
registerModule(TraceModule, TraceWriterManager)
public static TraceManager registerModule(TraceModule module, TraceWriterManager traceWriterManager)Returns an instance of a TraceManager object. Trace output will be redirected to the TraceWriterManager object specified.
Table 2-6
Cisco JTAPI Tracing Interfaces and Their Methods
ConditionalTrace
Declaration
public interface ConditionalTrace extends com.cisco.services.tracing.TraceAll Superinterfaces:
TraceDescription
The ConditionalTrace interface extends the Trace interface and defines the methods that allow enabling and disabling of tracing for this particular condition.
Typically, applications would obtain one ConditionalTrace object per each condition that they need to trace under certain circumstances but not always (e.g. AUDIT, INFO, etc.).
Disables this condition for tracing.
Enables this condition for tracing.
Methods
disable()
public void disable()Disables this condition for tracing.
enable()
public void enable()Enables this condition for tracing.
Trace
Declaration
public interface TraceAll Known Subinterfaces:
ConditionalTrace, UnconditionalTraceDescription
The Trace interface defines the methods that allow application tracing. Trace also defines the standard trace types as specified by Syslog Trace Logging.Syslog currently defines 8 levels of trace. The severity of the message is indicated in the trace as a number ranging between [0-7] (0 and 7 included). Currently 7 is HIGHEST_LEVEL and 0 is the LOWEST_LEVEL trace. All 8 levels are predefined here as static int types for reference in tracing sub-system implementations.
The severities traced are as follows:
0 = EMERGENCIES System unusable
1 = ALERTS Immediate action needed
2 = CRITICAL Critical conditions
3 = ERROR Error conditions
4 = WARNING Warning conditions
5 = NOTIFICATION Normal but significant condition
6 = INFORMATIONAL Informational messages only
7 = DEBUGGING Debugging messages
Fields
ALERTS
public static final int ALERTSThe application will continue working on the tasks but all functions may not be operational (one or more devices in the list are not accessible but others in the list can be accessed)
Syslog severity level = 1ALERTS_TRACE_NAME
public static final java.lang.String ALERTS_TRACE_NAMEString descriptor for ALERTS trace level
CRITICAL
public static final int CRITICALA critical failure, the application can not accomplish the tasks required due to this failure, eg: the app cant open the database to read the device list
Syslog severity level = 2CRITICAL_TRACE_NAME
public static final java.lang.String CRITICAL_TRACE_NAMEString descriptor for CRITICAL trace level
DEBUGGING
public static final int DEBUGGINGVery detailed information regarding errors or processing status that is only generated when DEBUG mode has been enabled
Syslog severity level = 7DEBUGGING_TRACE_NAME
public static final java.lang.String DEBUGGING_TRACE_NAMEString descriptor for the DEBUGGING trace level
EMERGENCIES
public static final int EMERGENCIESEmergency situation, a system shutdown is necessary
Syslog severity level = 0EMERGENCIES_TRACE_NAME
public static final java.lang.String EMERGENCIES_TRACE_NAMEString descriptor for EMERGENCIES trace level
ERROR
public static final int ERRORAn error condition of some kind has occurred and the user needs to understand the nature of that failure
Syslog severity level = 3ERROR_TRACE_NAME
public static final java.lang.String ERROR_TRACE_NAMEString descriptor for ERROR trace level
HIGHEST_LEVEL
public static final int HIGHEST_LEVELThe highest trace level, currently this is DEBUGGING with a trace level of 7
INFORMATIONAL
public static final int INFORMATIONALInformation of some form not relating to errors, warnings, audit, or debug
Syslog severity level =6INFORMATIONAL_TRACE_NAME
public static final java.lang.String INFORMATIONAL_TRACE_NAMEString descriptor for INFORMATIONAL trace level
LOWEST_LEVEL
public static final int LOWEST_LEVELThe lowest trace level, currently this is EMERGENCIES with a trace level of 0
NOTIFICATION
public static final int NOTIFICATIONNotification denotes a normal but significant condition
Syslog severity level = 5NOTIFICATION_TRACE_NAME
public static final java.lang.String NOTIFICATION_TRACE_NAMEString descriptor for NOTIFICATION trace level
WARNING
public static final int WARNINGWarning that a problem of some form exists but is not keeping the application from completing its tasks
Syslog severity level = 4WARNING_TRACE_NAME
public static final java.lang.String WARNING_TRACE_NAMEString descriptor for WARNING trace level
Methods
getName()
public java.lang.String getName()Returns the name of this Trace object.
Returns:the name of this Trace object
getSubFacility()
public java.lang.String getSubFacility()Returns the subFacility of trace
Returns:the trace subFacility type
getType()
public int getType()Returns the type of trace.
Returns:the trace severity as specified in Syslog. DEBUGGING, INFORMATIONAL, WARNING, etc.
isEnabled()
public boolean isEnabled()Returns the state of this Trace object. By default, Trace objects are enabled, that is, println() method will always trace. The state may not be changed through this interface, however, this object may implement additional interfaces that allow the state to be changed.
Returns:true if tracing is enabled, false otherwise
See Also:ConditionalTrace
println(Object)
public void println(java.lang.Object object)Prints the string returned by the Object.toString() method and terminates the line as defined by the system.
Parameters:object - the object to be printed
println(String)
public void println(java.lang.String message)Prints a message in the same format as Trace.print() and terminates the line as defined by the system.
Parameters:message - the message to be printed
println(String, Object)
public void println(java.lang.String mnemonic, java.lang.Object object)Prints the string returned by the Object.toString() method and terminates the line as defined by the system.
Parameters:object - the object to be printed
mnemonic - the mnemonic mapped to message to be printed
println(String, String)
public void println(java.lang.String mnemonic, java.lang.String message)Prints a message in the same format as Trace.print() and terminates the line as defined by the system.
Parameters:message - the message to be printed
mnemonic - the mnemonic mapped to message to be printed
setDefaultMnemonic(String)
public void setDefaultMnemonic(java.lang.String mnemonic)Sets a default mnemonic for all messages printed out to this trace.
Parameters:mnemonic, - a mnemonic string
TraceManager
Declaration
public interface TraceManagerDescription
The TraceManager interface defines the methods that allow applications trace management.
Typically, an application obtains only one TraceManager object. All Trace objects are created by default: Predefined Trace in accordance with Syslog definitions are:
ContitionalTraces: INFORMATIONAL, DEBUGGING, NOTIFICATION, WARNING
UnconditionalTraces: ERROR, CRITICAL, ALERTS, EMERGENCIES
Facilities/Sub-Facilities:
Facility: is a code consisting of two or more uppercase letters that indicate the facility to which the message refers. A facility can be a hardware device, a protocol, or a module of the system software
SubFacility:is a code consisting of two or more uppercase letters that indicate the sub-facility to which the message refers. A sub-facility can be a hardware device component, a protocol unit, or a sub-module of the system software
By default all 8 Conditional and UnConditional Traces are created for the Facility and 8 for each of the subFacilities In order to use the DEBUGGING trace for the parent FACILITY, for example, the application needs to use the getConditionalTrace( "DEBUGGING" ) method of this object.
In order to use the DEBUGGING trace for the SUBFACILITY, for example, the application needs to use the getConditionalTrace( SUBFACILITY + "_" + "DEBUGGING" ) method of this object or use the getConditionalTrace( SUBFACILITY , "DEBUGGING" ) method.
System wide TraceWriterManager is set through the setTraceWriterManager method provided by this interface.
The Trace Manager object also allows the application to enable or disable tracing for all trace through the enableAll() and disableAll() methods.
Methods
addSubFacilities(String[])
public void addSubFacilities(java.lang.String[] names)Sets a set of subFacilities for this TraceManager/Facility.
addSubFacility(String)
public void addSubFacility(java.lang.String name)Adds a single subFacility for this TraceManager/Facility.
disableAll()
public void disableAll()Disables tracing for all Trace objects managed by this TraceManager.
disableTimeStamp()
public void disableTimeStamp()Disables prefixing a time stamp for every message printed by this TraceManager.
enableAll()
public void enableAll()Enables tracing for all Trace objects managed by this TraceManager.
enableTimeStamp()
public void enableTimeStamp()Enables prefixing a time stamp for every message printed by this TraceManager.
getConditionalTrace(int)
public ConditionalTrace getConditionalTrace(int severity)Creates a new ConditionalTrace object or obtains an existing ConditionalTrace object for this condition.
getConditionalTrace(String, int)
public ConditionalTrace getConditionalTrace(java.lang.String subFacility, int severity)Creates a new ConditionalTrace object or obtains an existing ConditionalTrace object for this condition and subFacility
getName()
public java.lang.String getName()Returns the Facility name for this TraceManager.
getSubFacilities()
public java.lang.String[] getSubFacilities()Returns the subFacility names for this TraceManager/Facility.
getTraces()
public java.util.Enumeration getTraces()Returns an enumeration of the Trace objects managed by this TraceManager.
getTraceWriterManager()
public TraceWriterManager getTraceWriterManager()Returns the TraceWriter used by this TraceManager.
getUnconditionalTrace(int)
public UnconditionalTrace getUnconditionalTrace(int severity)Creates a new UnconditionalTrace object or obtains an existing UnconditionalTrace object for this condition.
getUnconditionalTrace(String, int)
public UnconditionalTrace getUnconditionalTrace(java.lang.String subFacility, int severity)Creates a new UnconditionalTrace object or obtains an existing UnconditionalTrace object for this condition and subFacility
removeTrace(Trace)
public void removeTrace(Trace tc)Removes a Trace object given an object.
setSubFacilities(String[])
public void setSubFacilities(java.lang.String[] names)Deprecated.and replaced with TraceManager.addSubFacilities method
Sets a set of subFacilities for this TraceManager/Facility.
setSubFacility(String)
public void setSubFacility(java.lang.String name)Deprecated.and replaced with TraceManager.addSubFacility method
Adds a single subFacility for this TraceManager/Facility.
setTraceWriterManager(TraceWriterManager)
public void setTraceWriterManager(TraceWriterManager twm)Sets the TraceWriter to be used by this TraceManager.
TraceModule
Declaration
public interface TraceModuleDescription
The TraceModule interface serves two purposes. First, it allows applications to discover the TraceManager object used by other packages that they use. Second, applications that register with the TraceManagerFactory must identify themselves by implementing this interface.
Returns the TraceManager that an object is using for tracing.
Returns the module name.
Methods
getTraceManager()
public TraceManager getTraceManager()Returns the TraceManager that an object is using for tracing.
getTraceModuleName()
public java.lang.String getTraceModuleName()Returns the module name.
TraceWriter
Declaration
public interface TraceWriterAll Known Subinterfaces:
TraceWriterManagerAll Known Implementing Classes:
BaseTraceWriterDescription
The TraceWriter interface abstracts the details of trace message output. The TraceWriter uses its enabled method to advertise whether or not the print and println methods will have any effect. Users of TraceWriter should use the value returned by the getEnabled method as an indication of whether they should invoke the print and println methods at all.
Methods
close()
public void close()Releases any resources associated by this TraceWriter.
flush()
public void flush()Forces output of any messages that have been printed using the println method
getDescription()
public java.lang.String getDescription()Returns:a short description of this TraceWriter
getEnabled()
public boolean getEnabled()Returns whether the println method will print anything or not. A closed TraceWriter will always return false from this method.
Returns:true if this TraceWriter is enabled, false if not
getName()
public java.lang.String getName()Returns:the name of this TraceWriter
getTraceLevels()
public int[] getTraceLevels()Returns:the array of trace levels that will be traced by this TraceWriter
println(String, int)
public void println(java.lang.String message, int severity)Prints the specified string followed by a carriage return The concrete TraceWriter class will use the severity to block out messages from a particular stream. Each trace writer has a notion of the highest level tarce it traces
Parameters:message - the string to print
severity - of the trace.
See Also:Trace
setTraceLevels(int[])
public void setTraceLevels(int[] levels)set the trace levels that will be traced by this TraceWriter
Parameters:int[] - levels
See Also:Trace
TraceWriterManager
Declaration
public interface TraceWriterManager extends com.cisco.services.tracing.TraceWriterAll Superinterfaces:
TraceWriterDescription
TraceWriterManager contains the list of TraceWriter objects that JTAPI uses to implement the tracing. The list is populated at startup from the switches in jtapi.ini. A LogFileTraceWriter, a ConsoleTraceWriter, and a SyslogTraceWriter are available. Users can override the JTAPI TraceWriters by setting a user implemented TraceWriter[] or adding to the existing TraceWriters. This makes it possible to add other TraceWriters that can function along with exisiting JTAPI tracing.
Methods
addTraceWriter(TraceWriter)
public void addTraceWriter(TraceWriter traceWriter)Add another TraceWriter to the array
Parameters:TraceWriter - to be added to the list
getTraceWriters()
public TraceWriter[] getTraceWriters()Returns:the array of TraceWriters in the manager
removeTraceWriter(TraceWriter)
public void removeTraceWriter(TraceWriter traceWriter)Remove the TraceWriter from the array in the manager
setTraceWriters(TraceWriter[])
public void setTraceWriters(TraceWriter[] traceWriters)Implementations can use this method to override or enhance the JTAPI provided TraceWriters
Parameters:set - the array of TraceWriters.
UnconditionalTrace
Declaration
public interface UnconditionalTrace extends com.cisco.services.tracing.TraceAll Superinterfaces:
TraceDescription
The UnconditionalTrace interface extends the Trace interface. Note that because this object extends Trace, its state is enabled by default and it may not be changed.
Typically, applications would obtain one UnconditionalTrace object per each condition that they need to trace always under any circumstances (e.g. ERROR, FATAL, etc.).
