org.asteriskjava.manager.action

Class AbstractManagerAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

All Implemented Interfaces:

Serializable, ManagerAction

Direct Known Subclasses:

AbsoluteTimeoutAction, AbstractMeetMeMuteAction, AgentCallbackLoginAction, AgentLogoffAction, AgentsAction, AgiAction, AtxferAction, BridgeAction, ChallengeAction, ChangeMonitorAction, CommandAction, ConfbridgeKickAction, ConfbridgeListAction, ConfbridgeListRoomsAction, ConfbridgeLockAction, ConfbridgeMuteAction, ConfbridgeSetSingleVideoSrcAction, ConfbridgeStartRecordAction, ConfbridgeStopRecordAction, ConfbridgeUnlockAction, ConfbridgeUnmuteAction, CoreSettingsAction, CoreShowChannelsAction, CoreStatusAction, DahdiShowChannelsAction, DbDelAction, DbDelTreeAction, DbGetAction, DbPutAction, DongleSendSMSAction, DongleShowDevicesAction, EventsAction, ExtensionStateAction, GetConfigAction, GetVarAction, HangupAction, IaxPeerListAction, JabberSendAction, ListCommandsAction, LocalOptimizeAwayAction, LoginAction, LogoffAction, MailboxCountAction, MailboxStatusAction, MessageSendAction, MixMonitorMuteAction, ModuleCheckAction, ModuleLoadAction, MonitorAction, MuteAudioAction, OriginateAction, ParkAction, ParkedCallsAction, PauseMixMonitorAction, PauseMonitorAction, PingAction, PlayDtmfAction, QueueAddAction, QueueLogAction, QueuePauseAction, QueuePenaltyAction, QueueRemoveAction, QueueResetAction, QueueStatusAction, QueueSummaryAction, RedirectAction, SendTextAction, SetCdrUserFieldAction, SetVarAction, ShowDialplanAction, SipNotifyAction, SipPeersAction, SipShowPeerAction, SipShowRegistryAction, SkypeAccountPropertyAction, SkypeAddBuddyAction, SkypeBuddiesAction, SkypeBuddyAction, SkypeChatSendAction, SkypeLicenseListAction, SkypeLicenseStatusAction, SkypeRemoveBuddyAction, StatusAction, StopMonitorAction, UnpauseMonitorAction, UpdateConfigAction, UserEventAction, VoicemailUsersListAction, ZapDialOffhookAction, ZapDndOffAction, ZapDndOnAction, ZapHangupAction, ZapRestartAction, ZapShowChannelsAction, ZapTransferAction

public abstract class AbstractManagerAction
extends Object
implements ManagerAction

This class implements the ManagerAction interface and can serve as base class for your concrete Action implementations.

Since:

0.2

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractManagerAction()

Method Summary

Modifier and Type	Method and Description
abstract String	getAction() Returns the name of the action for example "Hangup".
String	getActionId() Returns the action id.
void	setActionId(String actionId) Sets the action id.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractManagerAction

public AbstractManagerAction()

Method Detail

getAction

public abstract String getAction()

Description copied from interface: ManagerAction

Returns the name of the action for example "Hangup".

Specified by:

getAction in interface ManagerAction

getActionId

public String getActionId()

Description copied from interface: ManagerAction

Returns the action id.

Specified by:

getActionId in interface ManagerAction

Returns:

the user provied action id.

setActionId

public void setActionId(String actionId)

Description copied from interface: ManagerAction

Sets the action id.

If the action id is set and sent to the asterisk server any response returned by the Asterisk server will include the same id. This way the action id can be used to track actions and their corresponding responses and response events.

Note that Asterisk-Java uses its own internal action id to match actions with the corresponding responses and events. Though the internal action is never exposed to the application code. So if you want to handle reponses or response events on your own your application must set a unique action id using this method otherwise the action id of the reponse and response event objects passed to your application will be null.

Specified by:

setActionId in interface ManagerAction

Parameters:

actionId - the user provided action id to set.

See Also:

ManagerResponse.getActionId(), ResponseEvent.getActionId()

toString

public String toString()

Overrides:

toString in class Object