org.asteriskjava.pbx.internal.core

Class ChannelImpl

java.lang.Object

org.asteriskjava.pbx.internal.core.ChannelImpl

All Implemented Interfaces:

Channel

public class ChannelImpl
extends Object
implements Channel

TODO set the channel unique id when registering against an existing channel which doesn't have its unique id set.

Create a single asterisk event source. All users of MyBaseEventCalls will become listeners to this class rather than talking to asterisk directly. Each listener will have events queued to it. It can process these events in a separate thread.

Key feature is that one a 'rename' event arrives we must pause all of the queues wait for them to empty and for the queue clients to quiescent, then apply the rename before resuming pushing data in to the queues.

Additionally we need to redo the asterisk events classes with our own classes that pass around an iChannel rather than a raw channel name. By doing this the rename affectively becomes global updating every instance of the channel (because they actually only have an instance handle).

Author:

bsutton

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	_actions
static String	MASQ
static String	UNKNOWN_UNIQUE_ID
static String	ZOMBIE

Method Summary

Modifier and Type	Method and Description
void	addHangupListener(ChannelHangupListener listener) Adds a listener to the channel.
boolean	canDetectHangup()
CallerID	getCallerID() Returns the current callerid for this channel.
long	getChannelId() Each channel is assigned a unique PBX independent id to help track the channels when logging.
String	getChannelName() returns a fully qualifed channel name which includes the tech.
AgiChannelActivityAction	getCurrentActivityAction()
EndPoint	getEndPoint()
String	getExtendedChannelName() Returns the full channel name including the masquerade prefix and the zombie suffix.
String	getUniqueId()
boolean	hasCallerID()
boolean	isConnectedTo(EndPoint endPoint) Returns true if the given endpont is currently connected to this channel.
boolean	isConsole()
boolean	isInAgi()
boolean	isLive() Returns true if the channel is alive.
boolean	isLocal() In Asterisk speak, this method returns true if it is a LOCAL/ channel Not quite certain how this will map to other pbx's
boolean	isMute() Checks if this channel is currently mute.
boolean	isParked()
boolean	isQuiescent() Returns true if the channel is quiescent.
boolean	isSame(Channel _rhs) ************************************************************************* ************************** The remaining methods are bridging methods to the new abstract PBX classes.
boolean	isSame(String extendedChannelName, String uniqueID)
boolean	isZombie() Returns true if the channel has been marked as in a zombie state.
void	masquerade(Channel channel) designed for use by the ChannelProxy when a channel is being cloned as a result of Asterisk undertaking an Masquerade.
void	notifyHangupListeners(Integer cause, String causeText) Called by Peer when we have been hungup.
void	removeListener(ChannelHangupListener listener)
void	rename(String newName, String uniqueId) Called to rename a channel
boolean	sameEndPoint(Channel rhs)
boolean	sameEndPoint(EndPoint rhs)
boolean	sameExtenededChannelName(String extendedChannelName) Compares if this channel is the same as the named channel.
boolean	sameUniqueID(String uniqueID) Try to match a channel based solely on its unique ID
void	setCallerId(CallerID callerId)
void	setCurrentActivityAction(AgiChannelActivityAction action)
void	setIsInAgi(boolean b)
void	setMute(boolean mutedState) This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.
void	setParked(boolean parked) This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.
String	toString()
boolean	waitForChannelToReachAgi(long timeout, TimeUnit timeunit)

Methods inherited from class java.lang.Object

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

Field Detail

ZOMBIE

public static final String ZOMBIE

See Also:

Constant Field Values

MASQ

public static final String MASQ

See Also:

Constant Field Values

UNKNOWN_UNIQUE_ID

public static final String UNKNOWN_UNIQUE_ID

See Also:

Constant Field Values

_actions

public static final String[] _actions

Method Detail

masquerade

public void masquerade(Channel channel)

designed for use by the ChannelProxy when a channel is being cloned as a result of Asterisk undertaking an Masquerade. This is not intended to be a complete clone just the key elements that we generally track on our side rather than getting directly from asterisk.

rename

public void rename(String newName,
                   String uniqueId)
            throws InvalidChannelName

Description copied from interface: Channel

Called to rename a channel

Specified by:

rename in interface Channel

Throws:

InvalidChannelName

getChannelName

public String getChannelName()

Description copied from interface: Channel

returns a fully qualifed channel name which includes the tech. e.g. SIP/100-00000342

Specified by:

getChannelName in interface Channel

Returns:

getEndPoint

public EndPoint getEndPoint()

Specified by:

getEndPoint in interface Channel

setCallerId

public void setCallerId(CallerID callerId)

Specified by:

setCallerId in interface Channel

isSame

public boolean isSame(Channel _rhs)

************************************************************************* ************************** The remaining methods are bridging methods to the new abstract PBX classes. ************************************************************************* **************************

Specified by:

isSame in interface Channel

Returns:

isSame

public boolean isSame(String extendedChannelName,
                      String uniqueID)

Specified by:

isSame in interface Channel

sameExtenededChannelName

public boolean sameExtenededChannelName(String extendedChannelName)

Description copied from interface: Channel

Compares if this channel is the same as the named channel.

Specified by:

sameExtenededChannelName in interface Channel

Returns:

sameUniqueID

public boolean sameUniqueID(String uniqueID)

Try to match a channel based solely on its unique ID

Parameters:

uniqueID -

Returns:

sameEndPoint

public boolean sameEndPoint(Channel rhs)

Specified by:

sameEndPoint in interface Channel

sameEndPoint

public boolean sameEndPoint(EndPoint rhs)

Specified by:

sameEndPoint in interface Channel

getChannelId

public long getChannelId()

Description copied from interface: Channel

Each channel is assigned a unique PBX independent id to help track the channels when logging.

Specified by:

getChannelId in interface Channel

Returns:

isLive

public boolean isLive()

Description copied from interface: Channel

Returns true if the channel is alive. A channel is considered to be alive from the moment it is created until we get a notification that it has been hungup.

Specified by:

isLive in interface Channel

Returns:

addHangupListener

public void addHangupListener(ChannelHangupListener listener)

Description copied from interface: Channel

Adds a listener to the channel. The channel will send a hungup notification to the listener when it hungup. A channel must be able to support multiple listeners.

Specified by:

addHangupListener in interface Channel

removeListener

public void removeListener(ChannelHangupListener listener)

Specified by:

removeListener in interface Channel

notifyHangupListeners

public void notifyHangupListeners(Integer cause,
                                  String causeText)

Called by Peer when we have been hungup. This can happen when Peer receives a HangupEvent or during a periodic sweep done by PeerMonitor to find the status of all channels. Notify any listeners that this channel has been hung up.

Specified by:

notifyHangupListeners in interface Channel

isConnectedTo

public boolean isConnectedTo(EndPoint endPoint)

Description copied from interface: Channel

Returns true if the given endpont is currently connected to this channel.

Specified by:

isConnectedTo in interface Channel

Returns:

isMute

public boolean isMute()

Description copied from interface: Channel

Checks if this channel is currently mute. A channel is mute if the party connected to this channel cannot hear any audio.

Specified by:

isMute in interface Channel

Returns:

setMute

public void setMute(boolean mutedState)

Description copied from interface: Channel

This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.

Specified by:

setMute in interface Channel

See Also:

iPBX.iMuteCallActivity mute(iChannel channel, Direction direction, boolean muteState) for a method which actually mutes the channel.

setParked

public void setParked(boolean parked)

Description copied from interface: Channel

This method does not actually change the state of the channel, rather it is intended to be used to record the fact that the state has changed.

Specified by:

setParked in interface Channel

See Also:

iPBX.iParkCallActivity park(iChannel channel, Direction direction, boolean parkState) for a method which actually parks the channel.

isParked

public boolean isParked()

Specified by:

isParked in interface Channel

Returns:

true if the channel is currently parked.

toString

public String toString()

Overrides:

toString in class Object

getExtendedChannelName

public String getExtendedChannelName()

Returns the full channel name including the masquerade prefix and the zombie suffix.

Specified by:

getExtendedChannelName in interface Channel

Returns:

isLocal

public boolean isLocal()

Description copied from interface: Channel

In Asterisk speak, this method returns true if it is a LOCAL/ channel Not quite certain how this will map to other pbx's

Specified by:

isLocal in interface Channel

Returns:

isZombie

public boolean isZombie()

Description copied from interface: Channel

Returns true if the channel has been marked as in a zombie state.

Specified by:

isZombie in interface Channel

Returns:

isConsole

public boolean isConsole()

Specified by:

isConsole in interface Channel

Returns:

true if the channel was originated from the console (Console/DSP).

hasCallerID

public boolean hasCallerID()

Specified by:

hasCallerID in interface Channel

getCallerID

public CallerID getCallerID()

Description copied from interface: Channel

Returns the current callerid for this channel. Note: on some systems this involves a round trip to the pbx.

Specified by:

getCallerID in interface Channel

Returns:

getUniqueId

public String getUniqueId()

Specified by:

getUniqueId in interface Channel

canDetectHangup

public boolean canDetectHangup()

Specified by:

canDetectHangup in interface Channel

isQuiescent

public boolean isQuiescent()

Returns true if the channel is quiescent. A quescent channel is one that is current not going through a transition (name change) such as MASQ, ZOMBIE, ASYNC, PARK

Specified by:

isQuiescent in interface Channel

Returns:

getCurrentActivityAction

public AgiChannelActivityAction getCurrentActivityAction()

Specified by:

getCurrentActivityAction in interface Channel

setCurrentActivityAction

public void setCurrentActivityAction(AgiChannelActivityAction action)

Specified by:

setCurrentActivityAction in interface Channel

setIsInAgi

public void setIsInAgi(boolean b)

Specified by:

setIsInAgi in interface Channel

isInAgi

public boolean isInAgi()

Specified by:

isInAgi in interface Channel

waitForChannelToReachAgi

public boolean waitForChannelToReachAgi(long timeout,
                                        TimeUnit timeunit)
                                 throws InterruptedException

Specified by:

waitForChannelToReachAgi in interface Channel

Throws:

InterruptedException