org.asteriskjava.pbx

Class CallImpl

java.lang.Object

org.asteriskjava.pbx.CallImpl

All Implemented Interfaces:

Call, ChannelHangupListener

public class CallImpl
extends Object
implements ChannelHangupListener, Call

Holds a call which may consist of 0, 1, 2 or 3 channels. When dialing out a call The 1st channel is always the call 'originator'. Channel 2 is 'accepting' party Channel 3 is a 'third party' which has joined the call via a conference mode. The concept of a Call is independent of a particular PBX. All channels of a Call must belong to the same PBX as we have no way of bridging calls across multiple PBX's anyway. Calls can be established by: 1) When a call arrives at the NJR Management inbound context 2) Dialing 3) Joining two existing calls The 'originating' channel is the first channel introduced to the call and is stored in the zeroth element of the channel list.

Author:

bsutton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CallImpl.OWNER Used to indicate the ownership of the call.
static class	CallImpl.TransferType

Nested classes/interfaces inherited from interface org.asteriskjava.pbx.Call

Call.OperandChannel

Field Summary

Fields

Modifier and Type	Field and Description
protected BlindTransferActivity	_transferActivity

Constructor Summary

Constructors

Constructor and Description
CallImpl(Channel originatingChannel, CallDirection direction)
CallImpl(Channel agent, Channel callee)
CallImpl(Channel originatingChannel, Channel acceptingChannel, CallDirection direction)

Method Summary

Modifier and Type	Method and Description
boolean	addHangupListener(CallHangupListener listener) Call this method to get a notification when this call hangs up.
void	callDialedOut(Channel remoteChannel, CallerID fromClid, CallerID toClid) Call this method to indicate that this is an outbound call originated by this NJR instance.
boolean	canSplit() Returns true of the Call can be split into two (or more) separate calls.
void	channelHangup(Channel channel, Integer cause, String causeText)
boolean	contains(Channel parkChannel)
Channel	getAcceptingParty()
CallerID	getAcceptingPartyCallerID()
Date	getCallStartTime()
List<Channel>	getChannels() Returns all of the Channels associated with this call.
Integer	getContactId()
CallDirection	getDirection() Returns the direction of the call.
Date	getHoldStartTime()
Channel	getLocalParty() This method use the CallDirection to determine which leg of the call is the local call and which is the called/calling party.
Channel	getOperandChannel(Call.OperandChannel operand) retrieves the channel associated with the give Operand.
Channel	getOriginatingParty() Returns the originating channel for this call.
CallerID	getOriginatingPartyCallerID()
CallImpl.OWNER	getOwner()
EndPoint	getParkingLot()
Channel	getRemoteParty() This method use the CallDirection to determine which leg of the call is the local call and which is the called/calling party.
CallerID	getRemotePartyCallerID()
Date	getTimeAtDialIn()
EndPoint	getTransferTarget() The current transfer target.
CallerID	getTransferTargetCallerID()
Channel	getTransferTargetParty()
CallImpl.TransferType	getTransferType()
String	getUniqueCallID()
boolean	isCallParked()
boolean	isLive() returns true if the call has any active channels.
boolean	isSame(Call rhs)
CallImpl	join(Call.OperandChannel originatingOperand, Call rhs, Call.OperandChannel acceptingOperand, CallDirection direction) Joins a specific channel from this call with a specific channel from another call which results in a new Call object being created.
void	setContactId(Integer _contactId) The contact id is just used when refilling the list of contacts so we know which one is selected at the moment.
Call	split(Call.OperandChannel channelToSplit) Splits a channel out of a call into a separate call.
Call	split(Channel channelToSplit)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_transferActivity

protected BlindTransferActivity _transferActivity

Constructor Detail

CallImpl

public CallImpl(Channel originatingChannel,
                CallDirection direction)
         throws PBXException

Throws:

PBXException

CallImpl

public CallImpl(Channel originatingChannel,
                Channel acceptingChannel,
                CallDirection direction)
         throws PBXException

Throws:

PBXException

CallImpl

public CallImpl(Channel agent,
                Channel callee)
         throws PBXException

Throws:

PBXException

Method Detail

join

public CallImpl join(Call.OperandChannel originatingOperand,
                     Call rhs,
                     Call.OperandChannel acceptingOperand,
                     CallDirection direction)
              throws PBXException

Joins a specific channel from this call with a specific channel from another call which results in a new Call object being created. Channels that do not participate in the join are left in their original Call.

Parameters:

originatingOperand - the channel from this call that will participate in the join as the originating Channel

rhs - the call we are joining to.

acceptingOperand - the channel from the rhs call that will participate in the join as the accepting channel.

Returns:

Throws:

PBXException

split

public Call split(Call.OperandChannel channelToSplit)
           throws PBXException

Splits a channel out of a call into a separate call. This method should only be called from the SplitActivity.

Returns:

the resulting call.

Throws:

PBXException

split

public Call split(Channel channelToSplit)
           throws PBXException

Throws:

PBXException

channelHangup

public void channelHangup(Channel channel,
                          Integer cause,
                          String causeText)

Specified by:

channelHangup in interface ChannelHangupListener

getOriginatingParty

public Channel getOriginatingParty()

Returns the originating channel for this call. e.g. the first channel that came up. Whilst a call must always start with an originating channel as a call is shutting down it will get to the point where it will have no channels. In these cases the return will be null.

Specified by:

getOriginatingParty in interface Call

Returns:

null or the originating channel.

callDialedOut

public void callDialedOut(Channel remoteChannel,
                          CallerID fromClid,
                          CallerID toClid)
                   throws PBXException

Call this method to indicate that this is an outbound call originated by this NJR instance. These type of calls are not seen by a remote operator unless they are put on hold.

Parameters:

remoteChannel - - the remote channel this call connected to when dialing.

Throws:

PBXException

getCallStartTime

public Date getCallStartTime()

Specified by:

getCallStartTime in interface Call

getContactId

public Integer getContactId()

getTransferTarget

public EndPoint getTransferTarget()

The current transfer target.

Returns:

getTransferTargetCallerID

public CallerID getTransferTargetCallerID()

getAcceptingPartyCallerID

public CallerID getAcceptingPartyCallerID()

Specified by:

getAcceptingPartyCallerID in interface Call

getOriginatingPartyCallerID

public CallerID getOriginatingPartyCallerID()

Specified by:

getOriginatingPartyCallerID in interface Call

getRemotePartyCallerID

public CallerID getRemotePartyCallerID()

Specified by:

getRemotePartyCallerID in interface Call

getHoldStartTime

public Date getHoldStartTime()

getParkingLot

public EndPoint getParkingLot()

getTimeAtDialIn

public Date getTimeAtDialIn()

getTransferType

public CallImpl.TransferType getTransferType()

getUniqueCallID

public String getUniqueCallID()

isCallParked

public boolean isCallParked()

setContactId

public void setContactId(Integer _contactId)

The contact id is just used when refilling the list of contacts so we know which one is selected at the moment. It probably should be stored here!

Parameters:

_contactId -

getDirection

public CallDirection getDirection()

Description copied from interface: Call

Returns the direction of the call. The call Direction can be a little esoteric as a call can come in and then be transferred out again. So is this an inbound or outbound call?

Specified by:

getDirection in interface Call

Returns:

addHangupListener

public boolean addHangupListener(CallHangupListener listener)

Call this method to get a notification when this call hangs up.

Parameters:

listener -

Returns:

true if the hangup listener was added. False if the call has already been hungup.

isLive

public boolean isLive()

returns true if the call has any active channels.

Returns:

getOwner

public CallImpl.OWNER getOwner()

Returns:

true if this call is owned by another instance of NJR.

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(Channel parkChannel)

Specified by:

contains in interface Call

getAcceptingParty

public Channel getAcceptingParty()

Specified by:

getAcceptingParty in interface Call

getTransferTargetParty

public Channel getTransferTargetParty()

Specified by:

getTransferTargetParty in interface Call

getRemoteParty

public Channel getRemoteParty()

Description copied from interface: Call

This method use the CallDirection to determine which leg of the call is the local call and which is the called/calling party. It then returns the called/calling party.

Specified by:

getRemoteParty in interface Call

Returns:

getLocalParty

public Channel getLocalParty()

This method use the CallDirection to determine which leg of the call is the local call and which is the called/calling party. It then returns the local call .

Specified by:

getLocalParty in interface Call

Returns:

canSplit

public boolean canSplit()

Description copied from interface: Call

Returns true of the Call can be split into two (or more) separate calls.

Specified by:

canSplit in interface Call

Returns:

getOperandChannel

public Channel getOperandChannel(Call.OperandChannel operand)

Description copied from interface: Call

retrieves the channel associated with the give Operand.

Specified by:

getOperandChannel in interface Call

Returns:

isSame

public boolean isSame(Call rhs)

getChannels

public List<Channel> getChannels()

Returns all of the Channels associated with this call.

Specified by:

getChannels in interface Call

Returns: