won.bot.framework.eventbot.action.impl.wonmessage.execCommand

Class ExecuteSendMessageCommandAction<T extends MessageCommandEvent>

java.lang.Object

won.bot.framework.eventbot.action.BaseEventBotAction

won.bot.framework.eventbot.action.impl.wonmessage.execCommand.ExecuteSendMessageCommandAction<T>

All Implemented Interfaces:

EventBotAction

Direct Known Subclasses:

ExecuteCloseCommandAction, ExecuteConnectCommandAction, ExecuteConnectionMessageCommandAction, ExecuteFeedbackCommandAction, ExecuteOpenCommandAction

public abstract class ExecuteSendMessageCommandAction<T extends MessageCommandEvent>
extends BaseEventBotAction

Action executing a MessageCommandEvent and publishing MessageCommandSuccess and MessageCommandFailure events indicating how well sending that message worked. The optional constructor parameter messageIsSentToRemoteNode, which defaults to true is used to determine if response listeners for a response from the remote node are to be registered

Field Summary

Fields inherited from class won.bot.framework.eventbot.action.BaseEventBotAction

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExecuteSendMessageCommandAction(EventListenerContext eventListenerContext)
protected	ExecuteSendMessageCommandAction(EventListenerContext eventListenerContext, boolean messageIsSentToRemoteNode)

Method Summary

Modifier and Type	Method and Description
protected abstract MessageCommandFailureEvent	createLocalNodeFailureEvent(T originalCommand, WonMessage messageSent, FailureResponseEvent failureResponseEvent) Implementations can choose to return null here if they do not want an event published.
protected abstract MessageCommandSuccessEvent	createLocalNodeSuccessEvent(T originalCommand, WonMessage messageSent, SuccessResponseEvent successResponseEvent) Implementations can choose to return null here if they do not want an event published.
protected abstract MessageCommandNotSentEvent	createMessageNotSentEvent(T originalCommand, java.lang.String message) Implementations can choose to return null here if they do not want an event published.
protected abstract MessageCommandFailureEvent	createRemoteNodeFailureEvent(T originalCommand, WonMessage messageSent, FailureResponseEvent failureResponseEvent) Implementations can choose to return null here if they do not want an event published.
protected abstract MessageCommandSuccessEvent	createRemoteNodeSuccessEvent(T originalCommand, WonMessage messageSent, SuccessResponseEvent successResponseEvent) Implementations can choose to return null here if they do not want an event published.
protected abstract WonMessage	createWonMessage(T messageCommandEvent) Implementations must return a valid WoNMessage here or perform adequate logging and publish an MessageCommandFailureEvent and return null.
void	doRun(Event event, EventListener executingListener) Constructs the message via createWonMessage and registers a listener for the response from the local WoN node and, if messageIsSenttoRemoteNode is true, a listener for the response from the remote WoN node.

Methods inherited from class won.bot.framework.eventbot.action.BaseEventBotAction

getActionTask, getEventListenerContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecuteSendMessageCommandAction

protected ExecuteSendMessageCommandAction(EventListenerContext eventListenerContext,
                                          boolean messageIsSentToRemoteNode)

ExecuteSendMessageCommandAction

public ExecuteSendMessageCommandAction(EventListenerContext eventListenerContext)

Method Detail

doRun

public final void doRun(Event event,
                        EventListener executingListener)

Constructs the message via createWonMessage and registers a listener for the response from the local WoN node and, if messageIsSenttoRemoteNode is true, a listener for the response from the remote WoN node.

Specified by:

doRun in class BaseEventBotAction

Parameters:

event -

executingListener -

createRemoteNodeFailureEvent

protected abstract MessageCommandFailureEvent createRemoteNodeFailureEvent(T originalCommand,
                                                                           WonMessage messageSent,
                                                                           FailureResponseEvent failureResponseEvent)

Implementations can choose to return null here if they do not want an event published.

createRemoteNodeSuccessEvent

protected abstract MessageCommandSuccessEvent createRemoteNodeSuccessEvent(T originalCommand,
                                                                           WonMessage messageSent,
                                                                           SuccessResponseEvent successResponseEvent)

Implementations can choose to return null here if they do not want an event published.

createLocalNodeFailureEvent

protected abstract MessageCommandFailureEvent createLocalNodeFailureEvent(T originalCommand,
                                                                          WonMessage messageSent,
                                                                          FailureResponseEvent failureResponseEvent)

Implementations can choose to return null here if they do not want an event published.

createLocalNodeSuccessEvent

protected abstract MessageCommandSuccessEvent createLocalNodeSuccessEvent(T originalCommand,
                                                                          WonMessage messageSent,
                                                                          SuccessResponseEvent successResponseEvent)

Implementations can choose to return null here if they do not want an event published.

createMessageNotSentEvent

protected abstract MessageCommandNotSentEvent createMessageNotSentEvent(T originalCommand,
                                                                        java.lang.String message)

Implementations can choose to return null here if they do not want an event published.

createWonMessage

protected abstract WonMessage createWonMessage(T messageCommandEvent)
                                        throws WonMessageBuilderException

Implementations must return a valid WoNMessage here or perform adequate logging and publish an MessageCommandFailureEvent and return null.

Throws:

WonMessageBuilderException