won.bot.framework.bot.base

Class EventBot

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

won.bot.framework.bot.base.EventBot

All Implemented Interfaces:

Bot, OwnerCallback

Direct Known Subclasses:

BAAtomicAdditionalParticipantsBaseBot, BAAtomicBaseBot, BABaseBot, CommentBot, ConversationBot, ConversationBotMonitored, DebugBot, EchoBot, FactoryBot, GroupCycleBot, GroupingBot, LastSeenNeedsMatcherBot, Mail2WonBot, MatcherProtocolTestBot, NeedCreatorBot, RandomSimulatorBot, StandardTwoPhaseCommitBot, StandardTwoPhaseCommitNoVoteBot, Telegram2WonBot

public abstract class EventBot
extends TriggeredBot

Base class for bots that define their behaviour through event listeners. Once the bot's work is done, the workIsDone() method should be called to allow the framework to shut down the bot gracefully. All methods from the Bot interface are converted to Events by the EventBot. Subclasses should implement the initializeEventListeners() method to register their event listeners. The corresponding shutdownEventListeners() is called when the bot's shutdown method is called an may be used to perform shutdown work for listeners. An event bot implementation should take care not to do long or blocking work in event listeners. Whenever a long computation or a blocking call is done, it should be done in a Runnable, executed in the Executor (see below). The bot's services and other environment can be accessed in listeners through the instance of EventListenerContext. these services include:

• the event bus - for subscribing for/unsubscribing for/publishing event
• the task scheduler - for scheduling tasks (Runnables) to be run after a timeout
• the executor - for running tasks (Runnables) immediately in the task scheduler's thread pool
• the node uri source - for obtaining a won node URI for need creation
• the need producer - for obtaining a valid need content in RDF that can be used to create a need
• the owner service - for sending messages to won nodes (create needs, connect, open, message, close)
• shutting down the trigger - an event bot may have a trigger that calls the bot's act() method regularly.

The bot will only react to onXX methods (i.e., create events and publish them on the internal event bus) if it is in lifecycle phase ACTIVE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EventBot.MyEventListenerContext Class holding references to all important services that EventListeners inside bots need to access.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
EventBot()

Method Summary

Modifier and Type	Method and Description
void	act() Called by the framework to execute non-reactive tasks.
protected void	doInitializeCustom() Init method used to create the event bus and allow event listeners to register.
protected void	doShutdownCustom() Init method used to shut down the event bus and allow event listeners shut down.
protected EventBus	getEventBus()
protected EventListenerContext	getEventListenerContext()
protected abstract void	initializeEventListeners()
void	onCloseFromOtherNeed(Connection con, WonMessage wonMessage)
void	onConnectFromOtherNeed(Connection con, WonMessage wonMessage)
void	onFailureResponse(java.net.URI failedMessageUri, WonMessage wonMessage)
void	onHintFromMatcher(Match match, WonMessage wonMessage)
void	onMatcherRegistered(java.net.URI wonNodeUri)
void	onMessageFromOtherNeed(Connection con, WonMessage wonMessage)
void	onNeedActivatedNotificationForMatcher(java.net.URI wonNodeURI, java.net.URI needURI)
void	onNeedDeactivatedNotificationForMatcher(java.net.URI wonNodeURI, java.net.URI needURI)
void	onNewNeedCreated(java.net.URI needUri, java.net.URI wonNodeUri, org.apache.jena.query.Dataset needDataset)
void	onNewNeedCreatedNotificationForMatcher(java.net.URI wonNodeURI, java.net.URI needUri, org.apache.jena.query.Dataset wonMessageDataset)
void	onOpenFromOtherNeed(Connection con, WonMessage wonMessage)
void	onSuccessResponse(java.net.URI successfulMessageUri, WonMessage wonMessage)
protected void	shutdownEventListeners()

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

cancelTrigger, doInitialize, doShutdown, getScheduledExecution, isTriggerDone, setTrigger, workIsDone

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

getBotContextWrapper, getLifecyclePhase, initialize, isWorkDone, knowsNeedURI, knowsNodeURI, setBotContextWrapper, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBot

public EventBot()

Method Detail

act

public final void act()
               throws java.lang.Exception

Description copied from interface: Bot

Called by the framework to execute non-reactive tasks. The callee must make sure this call is thread-safe, but explicit synchronization is strongly discouraged.

Specified by:

act in interface Bot

Specified by:

act in class BaseBot

Throws:

java.lang.Exception

onMessageFromOtherNeed

public final void onMessageFromOtherNeed(Connection con,
                                         WonMessage wonMessage)

Specified by:

onMessageFromOtherNeed in interface OwnerCallback

Specified by:

onMessageFromOtherNeed in class BaseBot

onHintFromMatcher

public final void onHintFromMatcher(Match match,
                                    WonMessage wonMessage)

Specified by:

onHintFromMatcher in interface OwnerCallback

Specified by:

onHintFromMatcher in class BaseBot

onCloseFromOtherNeed

public final void onCloseFromOtherNeed(Connection con,
                                       WonMessage wonMessage)

Specified by:

onCloseFromOtherNeed in interface OwnerCallback

Specified by:

onCloseFromOtherNeed in class BaseBot

onOpenFromOtherNeed

public final void onOpenFromOtherNeed(Connection con,
                                      WonMessage wonMessage)

Specified by:

onOpenFromOtherNeed in interface OwnerCallback

Specified by:

onOpenFromOtherNeed in class BaseBot

onConnectFromOtherNeed

public void onConnectFromOtherNeed(Connection con,
                                   WonMessage wonMessage)

Specified by:

onConnectFromOtherNeed in interface OwnerCallback

Specified by:

onConnectFromOtherNeed in class BaseBot

onNewNeedCreated

public final void onNewNeedCreated(java.net.URI needUri,
                                   java.net.URI wonNodeUri,
                                   org.apache.jena.query.Dataset needDataset)
                            throws java.lang.Exception

Specified by:

onNewNeedCreated in interface Bot

Specified by:

onNewNeedCreated in class BaseBot

Throws:

java.lang.Exception

onNewNeedCreatedNotificationForMatcher

public final void onNewNeedCreatedNotificationForMatcher(java.net.URI wonNodeURI,
                                                         java.net.URI needUri,
                                                         org.apache.jena.query.Dataset wonMessageDataset)

Specified by:

onNewNeedCreatedNotificationForMatcher in interface Bot

Specified by:

onNewNeedCreatedNotificationForMatcher in class BaseBot

onMatcherRegistered

public final void onMatcherRegistered(java.net.URI wonNodeUri)

Specified by:

onMatcherRegistered in interface Bot

Specified by:

onMatcherRegistered in class BaseBot

onNeedActivatedNotificationForMatcher

public final void onNeedActivatedNotificationForMatcher(java.net.URI wonNodeURI,
                                                        java.net.URI needURI)

Specified by:

onNeedActivatedNotificationForMatcher in interface Bot

Specified by:

onNeedActivatedNotificationForMatcher in class BaseBot

onNeedDeactivatedNotificationForMatcher

public final void onNeedDeactivatedNotificationForMatcher(java.net.URI wonNodeURI,
                                                          java.net.URI needURI)

Specified by:

onNeedDeactivatedNotificationForMatcher in interface Bot

Specified by:

onNeedDeactivatedNotificationForMatcher in class BaseBot

onFailureResponse

public final void onFailureResponse(java.net.URI failedMessageUri,
                                    WonMessage wonMessage)

Specified by:

onFailureResponse in interface OwnerCallback

Specified by:

onFailureResponse in class BaseBot

onSuccessResponse

public final void onSuccessResponse(java.net.URI successfulMessageUri,
                                    WonMessage wonMessage)

Specified by:

onSuccessResponse in interface OwnerCallback

Specified by:

onSuccessResponse in class BaseBot

initializeEventListeners

protected abstract void initializeEventListeners()

shutdownEventListeners

protected void shutdownEventListeners()

doInitializeCustom

protected void doInitializeCustom()

Init method used to create the event bus and allow event listeners to register. Do not override! It not final to allow for CGLIB autoproxying.

Specified by:

doInitializeCustom in class TriggeredBot

doShutdownCustom

protected void doShutdownCustom()

Init method used to shut down the event bus and allow event listeners shut down. Do not override! It not final to allow for CGLIB autoproxying.

Specified by:

doShutdownCustom in class TriggeredBot

getEventBus

protected EventBus getEventBus()

getEventListenerContext

protected EventListenerContext getEventListenerContext()