won.bot.framework.bot.base

Class TriggeredBot

java.lang.Object

won.bot.framework.bot.base.BaseBot

won.bot.framework.bot.base.BasicServiceBot

won.bot.framework.bot.base.ScheduledActionBot

won.bot.framework.bot.base.TriggeredBot

All Implemented Interfaces:

Bot, OwnerCallback

Direct Known Subclasses:

EventBot

public abstract class TriggeredBot
extends ScheduledActionBot

Bot base class that expects a trigger to be injected that will cause the act() method to be called according to the trigger's specification.

Field Summary

Fields inherited from class won.bot.framework.bot.base.BaseBot

logger

Constructor Summary

Constructors

Constructor and Description
TriggeredBot()

Method Summary

Modifier and Type	Method and Description
protected void	cancelTrigger()
protected void	doInitialize() Override this method to do initialization work.
protected abstract void	doInitializeCustom() Override this method to do initialization work.
protected void	doShutdown() Override this method to do free resources during shutdown.
protected abstract void	doShutdownCustom() Override this method to do shutdown work.
protected java.util.concurrent.ScheduledFuture	getScheduledExecution()
protected boolean	isTriggerDone() Returns true if the trigger won't cause any more executions (and none are currently running).
void	setTrigger(org.springframework.scheduling.Trigger trigger)
protected void	workIsDone() Overrides the inherited method so as to also cancel the trigger when indicating that the bot's work is done.

Methods inherited from class won.bot.framework.bot.base.ScheduledActionBot

getExecutor, getTaskScheduler, setTaskScheduler

Methods inherited from class won.bot.framework.bot.base.BasicServiceBot

getLinkedDataSource, getMatcheNodeURISource, getMatcherProtocolMatcherService, getMatcherProtocolNeedServiceClient, getNeedProducer, getNodeURISource, getSolrServerURI, getWonMessageSender, getWonNodeInformationService, setLinkedDataSource, setMatcherNodeURISource, setMatcherProtocolMatcherService, setMatcherProtocolNeedServiceClient, setNeedProducer, setNodeURISource, setSolrServerURI, setWonMessageSender, setWonNodeInformationService

Methods inherited from class won.bot.framework.bot.base.BaseBot

act, getBotContextWrapper, getLifecyclePhase, initialize, isWorkDone, knowsNeedURI, knowsNodeURI, onCloseFromOtherNeed, onConnectFromOtherNeed, onFailureResponse, onHintFromMatcher, onMatcherRegistered, onMessageFromOtherNeed, onNeedActivatedNotificationForMatcher, onNeedDeactivatedNotificationForMatcher, onNewNeedCreated, onNewNeedCreatedNotificationForMatcher, onOpenFromOtherNeed, onSuccessResponse, setBotContextWrapper, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggeredBot

public TriggeredBot()

Method Detail

doInitialize

protected void doInitialize()

Description copied from class: BaseBot

Override this method to do initialization work.

Specified by:

doInitialize in class BaseBot

isTriggerDone

protected boolean isTriggerDone()

Returns true if the trigger won't cause any more executions (and none are currently running).

Returns:

doInitializeCustom

protected abstract void doInitializeCustom()

Override this method to do initialization work.

doShutdown

protected void doShutdown()

Description copied from class: BaseBot

Override this method to do free resources during shutdown.

Specified by:

doShutdown in class BaseBot

doShutdownCustom

protected abstract void doShutdownCustom()

Override this method to do shutdown work.

workIsDone

protected void workIsDone()

Overrides the inherited method so as to also cancel the trigger when indicating that the bot's work is done.

Overrides:

workIsDone in class BaseBot

cancelTrigger

protected void cancelTrigger()

getScheduledExecution

protected java.util.concurrent.ScheduledFuture getScheduledExecution()

setTrigger

public void setTrigger(org.springframework.scheduling.Trigger trigger)