com.cisco.jtapi.extensions
Interface CiscoConnection

All Superinterfaces:
javax.telephony.callcontrol.CallControlConnection, CiscoObjectContainer, javax.telephony.Connection
All Known Subinterfaces:
CiscoHuntConnection

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

Introduction

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

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


Field Summary
static int ADDRESS_SEARCH_SPACE
          The redirect should be done by using the redirect controller address search space.
static int CALLED_ADDRESS_DEFAULT
          The default behavior for Cisco JTAPI should apply.
static int CALLED_ADDRESS_SET_TO_PREFERREDCALLEDPARTY
          The originalCalledAddress should be set to the value present in preferredOriginalCalledParty field.
static int CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
          The calledAddress should be reset to the redirect destination.
static int CALLED_ADDRESS_UNCHANGED
          The calledAddress should remain unchanged after the redirect operation.
static int CALLINGADDRESS_SEARCH_SPACE
          The redirect should be done by using the calling address search space.
static int DEFAULT_SEARCH_SPACE
          The redirect should be done by using the default search space for the implementation.
static int REASON_DIRECTCALL
          This Connection results from a direct call.
static int REASON_FORWARDALL
          This Connection results from unconditional forwarding.
static int REASON_FORWARDBUSY
          This Connection results from a forwarding on busy.
static int REASON_FORWARDNOANSWER
          This Connection results from a forwarding on no answer.
static int REASON_OUTBOUND
          This Connection is an originating Connection, not a destination Connection.
static int REASON_REDIRECT
          This Connection results from a redirection.
static int REASON_TRANSFERREDCALL
          This Connection results from a transfer.
static int REDIRECT_DROP_ON_FAILURE
          This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination.
static int REDIRECT_NORMAL
          This redirect mode instructs the implementation to perform redirect if the destination is valid and available.
 
Fields inherited from interface javax.telephony.callcontrol.CallControlConnection
ALERTING, DIALING, DISCONNECTED, ESTABLISHED, FAILED, IDLE, INITIATED, NETWORK_ALERTING, NETWORK_REACHED, OFFERED, OFFERING, QUEUED, UNKNOWN
 
Fields inherited from interface javax.telephony.Connection
CONNECTED, INPROGRESS
 
Method Summary
 void disconnect(CiscoPartyInfo partyInfo)
          Disconnects a specific participant from this Connection based on the supplied CiscoPartyInfo object.
 boolean getAddressPI()
          Returns Presentation Indicator(PI) associated with the Address on which the connection is created.
 CiscoHuntConnection getCiscoHuntConnection()
          Returns the associated CiscoHuntConnection or null.
 CiscoConnectionID getConnectionID()
          Returns CiscoConnectionID for this CiscoConnection
 java.lang.String getDParkPrefixCode()
          Returns the prefix code that needs to be dialed with the DPark DN to retrieve the call.
 CiscoPartyInfo[] getPartyInfo()
          Returns an array of CiscoPartyInfo objects on this connection.
 int getReason()
          Returns the reason for the creation of this Connection.
 javax.telephony.TerminalConnection getRequestController()
          Returns the current request Controller for the Connection.
 java.lang.String getUniqueID(javax.telephony.Terminal term)
          Returns the unique identifier for this connection.
 boolean isChaperone()
          Returns true if the connection has limited features because it is part of a chaperone call.
 java.lang.String park()
          This method parks the call at a system park DN and returns the address of the park DN.
 javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode)
          This method overloads the CallControlConnection.redirect() method.
 javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace)
          This method overloads the CallControlConnection.redirect() method.
 javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption)
          This method overloads the CallControlConnection.redirect() method.
 javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, java.lang.String preferredOriginalCalledParty, java.lang.String facCode, java.lang.String cmcCode)
          This method overloads the CallControlConnection.redirect() method.
 javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, int calledAddressOption, java.lang.String preferredOriginalCalledParty, java.lang.String facCode, java.lang.String cmcCode, int featurePriority)
          This method overloads CallControlConnection.redirect().
 javax.telephony.Connection redirect(java.lang.String destinationAddress, int mode, int callingSearchSpace, java.lang.String preferredOriginalCalledParty)
          This method overloads the CallControlConnection.redirect() method.
 void setRequestController(javax.telephony.TerminalConnection tc)
          This interface gets provided to a requesting TerminalConnection.
 
Methods inherited from interface javax.telephony.callcontrol.CallControlConnection
accept, addToAddress, getCallControlState, park, redirect, reject
 
Methods inherited from interface javax.telephony.Connection
disconnect, getAddress, getCall, getCapabilities, getConnectionCapabilities, getState, getTerminalConnections
 
Methods inherited from interface com.cisco.jtapi.extensions.CiscoObjectContainer
getObject, setObject
 

Field Detail

REASON_DIRECTCALL

static final int REASON_DIRECTCALL
This Connection results from a direct call.

See Also:
Constant Field Values

REASON_TRANSFERREDCALL

static final int REASON_TRANSFERREDCALL
This Connection results from a transfer.

See Also:
Constant Field Values

REASON_FORWARDNOANSWER

static final int REASON_FORWARDNOANSWER
This Connection results from a forwarding on no answer.

See Also:
Constant Field Values

REASON_FORWARDBUSY

static final int REASON_FORWARDBUSY
This Connection results from a forwarding on busy.

See Also:
Constant Field Values

REASON_FORWARDALL

static final int REASON_FORWARDALL
This Connection results from unconditional forwarding.

See Also:
Constant Field Values

REASON_REDIRECT

static final int REASON_REDIRECT
This Connection results from a redirection.

See Also:
Constant Field Values

REASON_OUTBOUND

static final int REASON_OUTBOUND
This Connection is an originating Connection, not a destination Connection.

See Also:
Constant Field Values

REDIRECT_DROP_ON_FAILURE

static final int REDIRECT_DROP_ON_FAILURE
This redirect mode instructs the implementation to perform redirect without checking the validity or availability of the destination. The system drops the original call if the destination is invalid or busy.

See Also:
Constant Field Values

REDIRECT_NORMAL

static final int REDIRECT_NORMAL
This redirect mode instructs the implementation to perform redirect if the destination is valid and available. Otherwise, the request returns an error. The original call does not get dropped on failure.

See Also:
Constant Field Values

DEFAULT_SEARCH_SPACE

static final int DEFAULT_SEARCH_SPACE
The redirect should be done by using the default search space for the implementation. The default is to use the calling address search space.

See Also:
Constant Field Values

CALLINGADDRESS_SEARCH_SPACE

static final int CALLINGADDRESS_SEARCH_SPACE
The redirect should be done by using the calling address search space.

See Also:
Constant Field Values

ADDRESS_SEARCH_SPACE

static final int ADDRESS_SEARCH_SPACE
The redirect should be done by using the redirect controller address search space.

See Also:
Constant Field Values

CALLED_ADDRESS_DEFAULT

static final int CALLED_ADDRESS_DEFAULT
The default behavior for Cisco JTAPI should apply. The default behavior matches CALLED_ADDRESS_UNCHANGED.

See Also:
Constant Field Values

CALLED_ADDRESS_UNCHANGED

static final int CALLED_ADDRESS_UNCHANGED
The calledAddress should remain unchanged after the redirect operation.

See Also:
Constant Field Values

CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

static final int CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
The calledAddress should be reset to the redirect destination.

See Also:
Constant Field Values

CALLED_ADDRESS_SET_TO_PREFERREDCALLEDPARTY

static final int CALLED_ADDRESS_SET_TO_PREFERREDCALLEDPARTY
The originalCalledAddress should be set to the value present in preferredOriginalCalledParty field.

See Also:
Constant Field Values
Method Detail

getReason

int getReason()
Returns the reason for the creation of this Connection.

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 mailbox (REASON_DIRECTCALL).

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

Returns:
The reason for the creation of this Connection

getConnectionID

CiscoConnectionID getConnectionID()
Returns CiscoConnectionID for this CiscoConnection

Returns:
CiscoConnectionID

getPartyInfo

CiscoPartyInfo[] getPartyInfo()
Returns an array of CiscoPartyInfo objects on this connection.

Returns:
CiscoPartyInfo[]
Since:
7.1

disconnect

void disconnect(CiscoPartyInfo partyInfo)
                throws javax.telephony.PrivilegeViolationException,
                       javax.telephony.ResourceUnavailableException,
                       javax.telephony.MethodNotSupportedException,
                       javax.telephony.InvalidStateException
Disconnects a specific participant from this Connection based on the supplied CiscoPartyInfo object.

Throws:
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException
javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
Since:
7.1

redirect

javax.telephony.Connection redirect(java.lang.String destinationAddress,
                                    int mode)
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.InvalidPartyException,
                                           javax.telephony.MethodNotSupportedException,
                                           javax.telephony.PrivilegeViolationException,
                                           javax.telephony.ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes a new parameter: redirectMode.

Parameters:
mode - This parameter can take one of the following two values:
  • CiscoConnection.REDIRECT_DROP_ON_FAILURE -- This mode instructs the implementation to perform a redirect without checking the validity or availability of the destination. The original call gets dropped if the destination is invalid or busy.
  • CiscoConnection.REDIRECT_NORMAL -- This mode instructs the implementation to perform a redirect only after checking the validity or availability of the destination. This matches the behavior of the CallControlConnection.redirect() method. The system does not drop the original call on failure.
Throws:
javax.telephony.InvalidStateException
javax.telephony.InvalidPartyException
javax.telephony.MethodNotSupportedException
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException

redirect

javax.telephony.Connection redirect(java.lang.String destinationAddress,
                                    int mode,
                                    int callingSearchSpace)
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.InvalidPartyException,
                                           javax.telephony.MethodNotSupportedException,
                                           javax.telephony.PrivilegeViolationException,
                                           javax.telephony.ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes two new parameters -- redirectMode and callingSearchSpace. The redirectMode selects which type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space.

Parameters:
mode - One of:
  • CiscoConnection.REDIRECT_DROP_ON_FAILURE -- This mode instructs the implementation to perform a redirect without checking the validity or availability of the destination. The original call gets dropped if the destination is invalid or busy.
  • CiscoConnection.REDIRECT_NORMAL -- This mode instructs the implementation to perform a redirect only after checking the validity or availability of the destination. This matches the behavior of the CallControlConnection.redirect() method. The system does not drop the original call on failure.
callingSearchSpace - One of:
  • CiscoConnection.DEFAULT_SEARCH_SPACE
  • CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
  • CiscoConnection.ADDRESS_SEARCH_SPACE
Throws:
javax.telephony.InvalidStateException
javax.telephony.InvalidPartyException
javax.telephony.MethodNotSupportedException
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException

redirect

javax.telephony.Connection redirect(java.lang.String destinationAddress,
                                    int mode,
                                    int callingSearchSpace,
                                    java.lang.String preferredOriginalCalledParty)
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.InvalidPartyException,
                                           javax.telephony.MethodNotSupportedException,
                                           javax.telephony.PrivilegeViolationException,
                                           javax.telephony.ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes three new parameters: mode, callingSearchSpace, and preferredOriginalCalledParty. The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space.

Parameters:
mode - One of:
  • CiscoConnection.REDIRECT_DROP_ON_FAILURE
  • CiscoConnection.REDIRECT_NORMAL
callingSearchSpace - One of:
  • CiscoConnection.DEFAULT_SEARCH_SPACE
  • CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
  • CiscoConnection.ADDRESS_SEARCH_SPACE
preferredOriginalCalledParty - May be a DN that will be the originalCalledParty field when the call gets offered to the destinationAddress.
Throws:
javax.telephony.InvalidStateException
javax.telephony.InvalidPartyException
javax.telephony.MethodNotSupportedException
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException

redirect

javax.telephony.Connection redirect(java.lang.String destinationAddress,
                                    int mode,
                                    int callingSearchSpace,
                                    int calledAddressOption)
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.InvalidPartyException,
                                           javax.telephony.MethodNotSupportedException,
                                           javax.telephony.PrivilegeViolationException,
                                           javax.telephony.ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes three new parameters: mode, callingSearchSpace, and calledAddressOption. The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space. The calledAddressOption parameter controls whether to reset the original called fields.

Parameters:
mode - One of:
  • CiscoConnection.REDIRECT_DROP_ON_FAILURE
  • CiscoConnection.REDIRECT_NORMAL
callingSearchSpace - One of:
  • CiscoConnection.DEFAULT_SEARCH_SPACE
  • CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
  • CiscoConnection.ADDRESS_SEARCH_SPACE
calledAddressOption - One of:
  • CiscoConnection.CALLED_ADDRESS_DEFAULT
  • CiscoConnection.CALLED_ADDRESS_UNCHANGED
  • CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION

Throws:
javax.telephony.InvalidStateException
javax.telephony.InvalidPartyException
javax.telephony.MethodNotSupportedException
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException

redirect

javax.telephony.Connection redirect(java.lang.String destinationAddress,
                                    int mode,
                                    int callingSearchSpace,
                                    int calledAddressOption,
                                    java.lang.String preferredOriginalCalledParty,
                                    java.lang.String facCode,
                                    java.lang.String cmcCode)
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.InvalidPartyException,
                                           javax.telephony.MethodNotSupportedException,
                                           javax.telephony.PrivilegeViolationException,
                                           javax.telephony.ResourceUnavailableException
This method overloads the CallControlConnection.redirect() method. It takes three new parameters: mode, callingSearchSpace, and calledAddressOption. The redirectMode selects the type of redirect to perform. The callingSearchSpace tells the implementation to use either the calling party search space or the redirect controller search space. The calledAddressOption parameter controls whether to reset the original called fields.

If the FAC and CMC codes are missing or invalid, the call might not get offered and platformException may contain one of the following error codes:

Parameters:
mode - One of:
  • CiscoConnection.REDIRECT_DROP_ON_FAILURE
  • CiscoConnection.REDIRECT_NORMAL
callingSearchSpace - One of:
  • CiscoConnection.DEFAULT_SEARCH_SPACE
  • CiscoConnection.CALLINGADDRESS_SEARCH_SPACE
  • CiscoConnection.ADDRESS_SEARCH_SPACE

calledAddressOption - One of:
  • CiscoConnection.CALLED_ADDRESS_DEFAULT
  • CiscoConnection.CALLED_ADDRESS_UNCHANGED
  • CiscoConnection.CALLED_ADDRESS_SET_TO_REDIRECT_DESTINATION
  • CiscoConnection.CALLED_ADDRESS_SET_TO_PREFERREDCALLEDPARTY
preferredOriginalCalledParty - may be a DN that will be the originalCalledParty field when call is offered to destinationAddress. If this field * needs to be used, applications must set calledAddressOption as CALLED_ADDRESS_SET_TO_PREFERREDCALLEDPARTY. If applications are not interested in this field, you must pass the default value of null.
facCode - is required if the destinationAddress requires a forced authorization code to offer the call. Pass the FAC in this parameter. Pass the default value of null if the destinationAddress does not require a FAC code.
cmcCode - parameter is required if the destinationAddress requires a client matter code to offer the call. Pass the CMC in this parameter. Pass the default value of null if the destinationAddress does not require a CMC code.
Throws:
javax.telephony.InvalidStateException
javax.telephony.InvalidPartyException
javax.telephony.MethodNotSupportedException
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException

redirect

javax.telephony.Connection redirect(java.lang.String destinationAddress,
                                    int mode,
                                    int callingSearchSpace,
                                    int calledAddressOption,
                                    java.lang.String preferredOriginalCalledParty,
                                    java.lang.String facCode,
                                    java.lang.String cmcCode,
                                    int featurePriority)
                                    throws javax.telephony.InvalidStateException,
                                           javax.telephony.InvalidPartyException,
                                           javax.telephony.MethodNotSupportedException,
                                           javax.telephony.PrivilegeViolationException,
                                           javax.telephony.ResourceUnavailableException
This method overloads CallControlConnection.redirect(). It takes a new parameter, featurePriority, that sets the call priority.
The featurePriority parameter may be:

Returns:
Connection
Throws:
javax.telephony.InvalidStateException
javax.telephony.InvalidPartyException
javax.telephony.MethodNotSupportedException
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException

park

java.lang.String park()
                      throws javax.telephony.InvalidArgumentException,
                             javax.telephony.PrivilegeViolationException,
                             javax.telephony.ResourceUnavailableException,
                             javax.telephony.InvalidStateException
This method parks the call at a system park DN and returns the address of the park DN. You can unpark the call by using this address.

Throws:
javax.telephony.InvalidArgumentException
javax.telephony.PrivilegeViolationException
javax.telephony.ResourceUnavailableException
javax.telephony.InvalidStateException

setRequestController

void setRequestController(javax.telephony.TerminalConnection tc)
                          throws javax.telephony.InvalidArgumentException,
                                 javax.telephony.InvalidStateException
This interface gets provided to a requesting TerminalConnection. Applications must call this method prior to redirecting, parking, or disconnecting the call for a connection for a SharedLine Call.

On a SharedLine address, there will be more than one TerminalConnection for a connection. When there is only one active terminalConnection, applications may not specify a RequestController; however, if there is more that one active TerminalConnection in same connection (for example, for a barged call or a conference call), applications must specify the RequestController. The RequestController is the TerminalConnection to use to complete the request. The RequestController gets set to null/0 after the request gets completed or executed.

The following examples show how you can use this interface:

Throws:
javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException

getRequestController

javax.telephony.TerminalConnection getRequestController()
Returns the current request Controller for the Connection.


getAddressPI

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


getDParkPrefixCode

java.lang.String getDParkPrefixCode()
Returns the prefix code that needs to be dialed with the DPark DN to retrieve the call.


getUniqueID

java.lang.String getUniqueID(javax.telephony.Terminal term)
                             throws javax.telephony.PrivilegeViolationException,
                                    javax.telephony.InvalidStateException
Returns the unique identifier for this connection.

Parameters:
term - For Shared lines, a non-null valid terminal associated with this connection can be passed to get the Unique Identifier associated with a particular shared DN terminal else for non- * shared lines, application can pass a null object in the request.
Returns:
String
Throws:
javax.telephony.PrivilegeViolationException
javax.telephony.InvalidStateException
Since:
8.0

getCiscoHuntConnection

CiscoHuntConnection getCiscoHuntConnection()
Returns the associated CiscoHuntConnection or null.

Since:
8.0
See Also:
CiscoHuntConnection

isChaperone

boolean isChaperone()
Returns true if the connection has limited features because it is part of a chaperone call.

Since:
8.0