won.bot.framework.bot

Interface Bot

All Superinterfaces:

OwnerCallback

All Known Implementing Classes:

BAAtomicAdditionalParticipantsBaseBot, BAAtomicBaseBot, BAAtomicCCActiveExitingBot, BAAtomicCCActiveFailingBot, BAAtomicCCActiveNotCompletingBot, BAAtomicCCAdditionalParticipants, BAAtomicCCBot, BAAtomicCCCompletingExitingBot, BAAtomicCCCompletingFailingBot, BAAtomicCCCompletingNotCompletingBot, BAAtomicPCActiveExitingBot, BAAtomicPCActiveFailingBot, BAAtomicPCActiveNotCompletingBot, BAAtomicPCBot, BABaseBot, BACCBot, BAPCBot, BaseBot, BasicServiceBot, CommentBot, ConversationBot, ConversationBotMonitored, DebugBot, EchoBot, EventBot, FactoryBot, GroupCycleBot, GroupingBot, LastSeenNeedsMatcherBot, Mail2WonBot, MatcherProtocolTestBot, NeedCreatorBot, RandomSimulatorBot, ScheduledActionBot, StandardTwoPhaseCommitBot, StandardTwoPhaseCommitNoVoteBot, Telegram2WonBot, TriggeredBot

public interface Bot
extends OwnerCallback

A bot that manipulates needs. Note: Methods may throw runtime exceptions, which will be handled by the execution framework.

Method Summary

Modifier and Type	Method and Description
void	act() Called by the framework to execute non-reactive tasks.
BotLifecyclePhase	getLifecyclePhase() The lifecycle phase the bot is currently in.
void	initialize() Init method, called exactly once by the framework before any other method is invoked.
boolean	isWorkDone() Indicates whether the bot considers its work done.
boolean	knowsNeedURI(java.net.URI needURI)
boolean	knowsNodeURI(java.net.URI wonNodeURI)
void	onMatcherRegistered(java.net.URI wonNodeUri)
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 needModel)
void	onNewNeedCreatedNotificationForMatcher(java.net.URI wonNodeURI, java.net.URI needURI, org.apache.jena.query.Dataset needModel)
void	shutdown() Shutdown method called exactly once by the framework to allow the bot to free resources.

Methods inherited from interface won.owner.protocol.message.OwnerCallback

onCloseFromOtherNeed, onConnectFromOtherNeed, onFailureResponse, onHintFromMatcher, onMessageFromOtherNeed, onOpenFromOtherNeed, onSuccessResponse

Method Detail

knowsNeedURI

boolean knowsNeedURI(java.net.URI needURI)

knowsNodeURI

boolean knowsNodeURI(java.net.URI wonNodeURI)

onNewNeedCreated

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

Throws:

java.lang.Exception

onMatcherRegistered

void onMatcherRegistered(java.net.URI wonNodeUri)

onNewNeedCreatedNotificationForMatcher

void onNewNeedCreatedNotificationForMatcher(java.net.URI wonNodeURI,
                                            java.net.URI needURI,
                                            org.apache.jena.query.Dataset needModel)

onNeedActivatedNotificationForMatcher

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

onNeedDeactivatedNotificationForMatcher

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

initialize

void initialize()
         throws java.lang.Exception

Init method, called exactly once by the framework before any other method is invoked. The callee must make sure this call is thread-safe, e.g. by explicit synchronizing.

Throws:

java.lang.Exception

act

void act()
  throws java.lang.Exception

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.

Throws:

java.lang.Exception

shutdown

void shutdown()
       throws java.lang.Exception

Shutdown method called exactly once by the framework to allow the bot to free resources. The callee must make sure this call is thread-safe, e.g. by explicit synchronizing.

Throws:

java.lang.Exception

getLifecyclePhase

BotLifecyclePhase getLifecyclePhase()

The lifecycle phase the bot is currently in.

Returns:

isWorkDone

boolean isWorkDone()

Indicates whether the bot considers its work done. If true, the bot is ok with not receiving incoming messages and not having its act() method called.

Returns: