org.asteriskjava.pbx.internal.core

Class ChannelProxy

java.lang.Object

org.asteriskjava.pbx.internal.core.ChannelProxy

All Implemented Interfaces:

Channel, ChannelHangupListener

public class ChannelProxy
extends Object
implements Channel, ChannelHangupListener

The ChannelProxy exists to deal with the fact that Asterisk will often replace a channel during a call. This is referred to as Masquerading. When a channel is to be Masqueraded we get a Masquerade event. The ChannelProxy class acts as a level of indirection for an iChannel. Rather than holding an iChannel directly you can instead hold a ChannelProxy. If the underlying iChannel is replaced the ChannelProxy will be updated with the new iChannel.

Author:

bsutton

Constructor Summary

Constructors

Constructor and Description
ChannelProxy(ChannelImpl channel)

Method Summary

Modifier and Type	Method and Description
void	addHangupListener(ChannelHangupListener listener) Adds a listener to the channel.
boolean	canDetectHangup()
void	channelHangup(Channel channel, Integer cause, String causeText)
boolean	equals(Object obj)
CallerID	getCallerID() Returns the current callerid for this channel.
Channel	getChannel() returns the current 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 a PBX specific version of the Channel name.
int	getIdentity()
ChannelImpl	getRealChannel()
String	getUniqueId()
boolean	hasCallerID()
int	hashCode()
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()
boolean	isSame(Channel rhs) Compares if two channels are the same logical channel on the pbx.
boolean	isSame(String extendedChannelName, String uniqueID)
boolean	isZombie() Returns true if the channel has been marked as in a zombie state.
void	masquerade(ChannelProxy cloneProxy) Used to handle a MasqueradeEvent.
void	notifyHangupListeners(Integer cause, String causeText)
void	removeListener(ChannelHangupListener listener)
void	rename(String newName, String uniqueId) Called to rename a channel
boolean	sameEndPoint(Channel rhs)
boolean	sameEndPoint(EndPoint extensionRoaming)
boolean	sameExtenededChannelName(String channelName) Compares if this channel is the same as the named channel.
boolean	sameUniqueID(String uniqueID)
void	setCallerId(CallerID callerId)
void	setCurrentActivityAction(AgiChannelActivityAction action)
void	setIsInAgi(boolean b)
void	setMute(boolean muteState) 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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelProxy

public ChannelProxy(ChannelImpl channel)

Method Detail

getChannel

public Channel getChannel()

returns the current channel

Returns:

isSame

public boolean isSame(Channel rhs)

Description copied from interface: Channel

Compares if two channels are the same logical channel on the pbx. This comparison uses the full unique name of the channel not just the abbreviated peer name. e.g. SIP/100-00000100

Specified by:

isSame in interface Channel

Returns:

isSame

public boolean isSame(String extendedChannelName,
                      String uniqueID)

Specified by:

isSame in interface Channel

sameUniqueID

public boolean sameUniqueID(String uniqueID)

sameEndPoint

public boolean sameEndPoint(Channel rhs)

Specified by:

sameEndPoint in interface Channel

sameEndPoint

public boolean sameEndPoint(EndPoint extensionRoaming)

Specified by:

sameEndPoint in interface Channel

sameExtenededChannelName

public boolean sameExtenededChannelName(String channelName)

Description copied from interface: Channel

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

Specified by:

sameExtenededChannelName in interface Channel

Returns:

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.

setMute

public void setMute(boolean muteState)

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.

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

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:

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

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:

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).

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:

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

isParked

public boolean isParked()

Specified by:

isParked in interface Channel

Returns:

true if the channel is currently parked.

masquerade

public void masquerade(ChannelProxy cloneProxy)
                throws InvalidChannelName

Used to handle a MasqueradeEvent. We essentially swap the two underlying channels between the two proxies.

Parameters:

cloneProxy -

Throws:

InvalidChannelName

getRealChannel

public ChannelImpl getRealChannel()

getExtendedChannelName

public String getExtendedChannelName()

Description copied from interface: Channel

Returns a PBX specific version of the Channel name.

Specified by:

getExtendedChannelName in interface Channel

Returns:

notifyHangupListeners

public void notifyHangupListeners(Integer cause,
                                  String causeText)

Specified by:

notifyHangupListeners in interface Channel

toString

public String toString()

Overrides:

toString in class Object

channelHangup

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

Specified by:

channelHangup in interface ChannelHangupListener

canDetectHangup

public boolean canDetectHangup()

Specified by:

canDetectHangup in interface Channel

isQuiescent

public boolean isQuiescent()

Specified by:

isQuiescent in interface Channel

hasCallerID

public boolean hasCallerID()

Specified by:

hasCallerID in interface Channel

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

getUniqueId

public String getUniqueId()

Specified by:

getUniqueId in interface Channel

getIdentity

public int getIdentity()

setCallerId

public void setCallerId(CallerID callerId)

Specified by:

setCallerId in interface Channel