org.asteriskjava.manager.action

Class HangupAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.HangupAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class HangupAction
extends AbstractManagerAction
implements EventGeneratingAction

The HangupAction causes Asterisk to hang up a given channel.

Hangup with a cause code is only supported by Asterisk versions later than 1.6.2.

If the provided channel is surrounded by /forward slashes/, Asterisk will interpret the value as a POSIX Extended Regular Expression (ERE), allowing multiple channels to be hung up at once.

If you are passing a regular expression to this action, ensure that you also use one of the ManagerConnection.sendEventGeneratingAction(EventGeneratingAction) overloads to capture the response correctly.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HangupAction() Creates a new empty HangupAction.
HangupAction(String channelOrRegex) Creates a new HangupAction that hangs up the given channel.
HangupAction(String channelOrRegex, int cause) Creates a new HangupAction that hangs up the given channel with the given cause code.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
Integer	getCause() Returns the hangup cause.
String	getChannel() Returns the name of the channel to hangup.
void	setCause(Integer cause) Sets the hangup cause.
void	setChannel(String channel) Sets the name of the channel to hangup.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asteriskjava.manager.action.ManagerAction

getActionId, setActionId

Constructor Detail

HangupAction

public HangupAction()

Creates a new empty HangupAction.

HangupAction

public HangupAction(String channelOrRegex)

Creates a new HangupAction that hangs up the given channel.

Parameters:

channelOrRegex - the name of the channel to hangup.

Since:

0.2

HangupAction

public HangupAction(String channelOrRegex,
                    int cause)

Creates a new HangupAction that hangs up the given channel with the given cause code.

Parameters:

channelOrRegex - the name of the channel to hangup.

cause - the cause code. The cause code must be >= 0 and <= 127.

Since:

1.0.0

Method Detail

getAction

public String getAction()

Returns the name of this action, i.e. "Hangup".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getChannel

public String getChannel()

Returns the name of the channel to hangup.

Returns:

the name of the channel to hangup.

setChannel

public void setChannel(String channel)

Sets the name of the channel to hangup.

This property is mandatory.

Parameters:

channel - the name of the channel to hangup.

getCause

public Integer getCause()

Returns the hangup cause.

Returns:

the hangup cause.

Since:

1.0.0

setCause

public void setCause(Integer cause)

Sets the hangup cause. The cause code must be >= 0 and <= 127.

This property is optional.

Parameters:

cause - the hangup cause.

Since:

1.0.0

getActionCompleteEventClass

public Class<? extends ResponseEvent> getActionCompleteEventClass()

Description copied from interface: EventGeneratingAction

Returns the event type that indicates that Asterisk is finished sending response events for this action.

Specified by:

getActionCompleteEventClass in interface EventGeneratingAction

Returns:

a Class that is an instance of ResponseEvent.

See Also:

ResponseEvent