org.asteriskjava.pbx.internal.activity

Class DialToAgiActivityImpl

java.lang.Object

org.asteriskjava.lock.Lockable

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

org.asteriskjava.pbx.internal.activity.DialToAgiActivityImpl

All Implemented Interfaces:

Runnable, DialToAgiActivity, Activity, NewChannelListener

public class DialToAgiActivityImpl
extends ActivityHelper<DialToAgiActivity>
implements DialToAgiActivity, NewChannelListener

Constructor Summary

Constructors

Constructor and Description
DialToAgiActivityImpl(EndPoint originating, CallerID toCallerID, Integer timeout, boolean hideToCallerID, ActivityCallback<DialToAgiActivity> listener, Map<String,String> channelVarsToSet, AgiChannelActivityAction action)

Method Summary

Modifier and Type	Method and Description
void	abort()
boolean	cancelledByOperator()
void	channelUpdate(Channel channel) Allows a listener to be informed as new channels come up during an originate.
void	dial()
boolean	doActivity()
Channel	getOriginatingChannel()
EndPoint	getOriginatingEndPoint()
ListenerPriority	getPriority()
void	markCancelled() Called if the user cancels the call after starting it.
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

DialToAgiActivityImpl

public DialToAgiActivityImpl(EndPoint originating,
                             CallerID toCallerID,
                             Integer timeout,
                             boolean hideToCallerID,
                             ActivityCallback<DialToAgiActivity> listener,
                             Map<String,String> channelVarsToSet,
                             AgiChannelActivityAction action)

Method Detail

dial

public void dial()

Specified by:

dial in interface DialToAgiActivity

doActivity

public boolean doActivity()
                   throws PBXException

Specified by:

doActivity in class ActivityHelper<DialToAgiActivity>

Throws:

PBXException

markCancelled

public void markCancelled()

Called if the user cancels the call after starting it. The caller must also hangup the trc channel.

Specified by:

markCancelled in interface DialToAgiActivity

getOriginatingChannel

public Channel getOriginatingChannel()

Specified by:

getOriginatingChannel in interface DialToAgiActivity

getOriginatingEndPoint

public EndPoint getOriginatingEndPoint()

Specified by:

getOriginatingEndPoint in interface DialToAgiActivity

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<DialToAgiActivity>

cancelledByOperator

public boolean cancelledByOperator()

Specified by:

cancelledByOperator in interface DialToAgiActivity

requiredEvents

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

getPriority

public ListenerPriority getPriority()

Specified by:

getPriority in class ActivityHelper<DialToAgiActivity>

onManagerEvent

public void onManagerEvent(ManagerEvent event)

abort

public void abort()

Specified by:

abort in interface DialToAgiActivity