org.asteriskjava.pbx.internal.activity

Class DialActivityImpl

java.lang.Object

org.asteriskjava.lock.Lockable

org.asteriskjava.pbx.internal.activity.ActivityHelper<DialActivity>

org.asteriskjava.pbx.internal.activity.DialActivityImpl

All Implemented Interfaces:

Runnable, DialActivity, Activity, NewChannelListener

public class DialActivityImpl
extends ActivityHelper<DialActivity>
implements DialActivity, NewChannelListener

Constructor Summary

Constructors

Constructor and Description
DialActivityImpl(EndPoint originating, EndPoint accepting, CallerID toCallerID, boolean hideToCallerID, ActivityCallback<DialActivity> listener, Map<String,String> channelVarsToSet, String dialOptions)

Method Summary

Modifier and Type	Method and Description
boolean	cancelledByOperator() Returns true if markCancelled was called during the dial attempt.
void	channelUpdate(Channel channel) Allows a listener to be informed as new channels come up during an originate.
boolean	doActivity()
Channel	getAcceptingChannel() Returns the 'accepting' channel which is brought up as part of the dial activity.
EndPoint	getAcceptingEndPoint() Returns the end point which is being dialed.
Call	getNewCall()
Channel	getOriginatingChannel() Returns the 'originating' channel which is brought up as part of the dial activity.
EndPoint	getOriginatingEndPoint() Returns the end point which originated the dial.
ListenerPriority	getPriority()
void	markCancelled() Called to cancels the dial before it fully comes up.
void	onManagerEvent(ManagerEvent event)
HashSet<Class<? extends ManagerEvent>>	requiredEvents()
boolean	validateChannel(Channel channel)

Methods inherited from class org.asteriskjava.pbx.internal.activity.ActivityHelper

getLastException, isSuccess, progess, run, setLastException, startActivity

Methods inherited from class org.asteriskjava.lock.Lockable

getDumpRateLimit, withLock

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asteriskjava.pbx.Activity

getLastException, isSuccess

Constructor Detail

DialActivityImpl

public DialActivityImpl(EndPoint originating,
                        EndPoint accepting,
                        CallerID toCallerID,
                        boolean hideToCallerID,
                        ActivityCallback<DialActivity> listener,
                        Map<String,String> channelVarsToSet,
                        String dialOptions)

Method Detail

doActivity

public boolean doActivity()
                   throws PBXException

Specified by:

doActivity in class ActivityHelper<DialActivity>

Throws:

PBXException

markCancelled

public void markCancelled()

Called to cancels the dial before it fully comes up. The caller must also hangup the associated channels.

Specified by:

markCancelled in interface DialActivity

getOriginatingChannel

public Channel getOriginatingChannel()

Description copied from interface: DialActivity

Returns the 'originating' channel which is brought up as part of the dial activity. The 'originating' channel may return null if the channel is not up.

Specified by:

getOriginatingChannel in interface DialActivity

Returns:

the 'originating' channel if it has been brought up otherwise null.

getAcceptingChannel

public Channel getAcceptingChannel()

Description copied from interface: DialActivity

Returns the 'accepting' channel which is brought up as part of the dial activity. The accepting party is the party that answers the call. The 'accepting' channel may return null if the channel is not up.

Specified by:

getAcceptingChannel in interface DialActivity

Returns:

the 'accepting' channel if it has been brought up otherwise null

getOriginatingEndPoint

public EndPoint getOriginatingEndPoint()

Description copied from interface: DialActivity

Returns the end point which originated the dial.

Specified by:

getOriginatingEndPoint in interface DialActivity

getAcceptingEndPoint

public EndPoint getAcceptingEndPoint()

Description copied from interface: DialActivity

Returns the end point which is being dialed. This is available even before the dial commences.

Specified by:

getAcceptingEndPoint in interface DialActivity

channelUpdate

public void channelUpdate(Channel channel)

Description copied from interface: NewChannelListener

Allows a listener to be informed as new channels come up during an originate.

The OriginateBase class will call this for each channel that comes up (as a result of the originate).

Intermediate channels (local etc) that the underlying pbx may create on the way through are ignored with only the final channels being notified.

This listener should be used by anyone that needs to have the channel at the earliest possible moment.

Listeners should not run long lived process from this call as it will stall the dialer.

Specified by:

channelUpdate in interface NewChannelListener

validateChannel

public boolean validateChannel(Channel channel)

Overrides:

validateChannel in class ActivityHelper<DialActivity>

cancelledByOperator

public boolean cancelledByOperator()

Description copied from interface: DialActivity

Returns true if markCancelled was called during the dial attempt.

Specified by:

cancelledByOperator in interface DialActivity

Returns:

requiredEvents

public HashSet<Class<? extends ManagerEvent>> requiredEvents()

getPriority

public ListenerPriority getPriority()

Specified by:

getPriority in class ActivityHelper<DialActivity>

onManagerEvent

public void onManagerEvent(ManagerEvent event)

getNewCall

public Call getNewCall()

Specified by:

getNewCall in interface DialActivity