won.bot.framework.bot.base

Class BaseBot

java.lang.Object

won.bot.framework.bot.base.BaseBot

All Implemented Interfaces:

Bot, OwnerCallback

Direct Known Subclasses:

BasicServiceBot

public abstract class BaseBot
extends java.lang.Object
implements Bot

Basic Bot implementation intended to be extended. Does nothing.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
BaseBot()

Method Summary

Modifier and Type	Method and Description
abstract void	act() Called by the framework to execute non-reactive tasks.
protected abstract void	doInitialize() Override this method to do initialization work.
protected abstract void	doShutdown() Override this method to do free resources during shutdown.
protected BotContextWrapper	getBotContextWrapper()
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)
abstract void	onCloseFromOtherNeed(Connection con, WonMessage wonMessage)
abstract void	onConnectFromOtherNeed(Connection con, WonMessage wonMessage)
abstract void	onFailureResponse(java.net.URI failedMessageUri, WonMessage wonMessage)
abstract void	onHintFromMatcher(Match match, WonMessage wonMessage)
abstract void	onMatcherRegistered(java.net.URI wonNodeUri)
abstract void	onMessageFromOtherNeed(Connection con, WonMessage wonMessage)
abstract void	onNeedActivatedNotificationForMatcher(java.net.URI wonNodeURI, java.net.URI needURI)
abstract void	onNeedDeactivatedNotificationForMatcher(java.net.URI wonNodeURI, java.net.URI needURI)
abstract void	onNewNeedCreated(java.net.URI needUri, java.net.URI wonNodeUri, org.apache.jena.query.Dataset needDataset)
abstract void	onNewNeedCreatedNotificationForMatcher(java.net.URI wonNodeURI, java.net.URI needURI, org.apache.jena.query.Dataset needDataset)
abstract void	onOpenFromOtherNeed(Connection con, WonMessage wonMessage)
abstract void	onSuccessResponse(java.net.URI successfulMessageUri, WonMessage wonMessage)
void	setBotContextWrapper(BotContextWrapper botContextWrapper)
void	shutdown() Shutdown method called exactly once by the framework to allow the bot to free resources.
protected void	workIsDone() Sets the workDone flag to true.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

BaseBot

public BaseBot()

Method Detail

knowsNeedURI

public boolean knowsNeedURI(java.net.URI needURI)

Specified by:

knowsNeedURI in interface Bot

knowsNodeURI

public boolean knowsNodeURI(java.net.URI wonNodeURI)

Specified by:

knowsNodeURI in interface Bot

initialize

public void initialize()
                throws java.lang.Exception

Description copied from interface: Bot

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.

Specified by:

initialize in interface Bot

Throws:

java.lang.Exception

shutdown

public void shutdown()
              throws java.lang.Exception

Description copied from interface: Bot

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.

Specified by:

shutdown in interface Bot

Throws:

java.lang.Exception

doShutdown

protected abstract void doShutdown()

Override this method to do free resources during shutdown.

doInitialize

protected abstract void doInitialize()

Override this method to do initialization work.

workIsDone

protected void workIsDone()

Sets the workDone flag to true.

isWorkDone

public boolean isWorkDone()

Description copied from interface: Bot

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.

Specified by:

isWorkDone in interface Bot

Returns:

getLifecyclePhase

public BotLifecyclePhase getLifecyclePhase()

Description copied from interface: Bot

The lifecycle phase the bot is currently in.

Specified by:

getLifecyclePhase in interface Bot

Returns:

setBotContextWrapper

public void setBotContextWrapper(BotContextWrapper botContextWrapper)

getBotContextWrapper

protected BotContextWrapper getBotContextWrapper()

onNewNeedCreated

public abstract 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

Throws:

java.lang.Exception

onConnectFromOtherNeed

public abstract void onConnectFromOtherNeed(Connection con,
                                            WonMessage wonMessage)

Specified by:

onConnectFromOtherNeed in interface OwnerCallback

onOpenFromOtherNeed

public abstract void onOpenFromOtherNeed(Connection con,
                                         WonMessage wonMessage)

Specified by:

onOpenFromOtherNeed in interface OwnerCallback

onCloseFromOtherNeed

public abstract void onCloseFromOtherNeed(Connection con,
                                          WonMessage wonMessage)

Specified by:

onCloseFromOtherNeed in interface OwnerCallback

onHintFromMatcher

public abstract void onHintFromMatcher(Match match,
                                       WonMessage wonMessage)

Specified by:

onHintFromMatcher in interface OwnerCallback

onMessageFromOtherNeed

public abstract void onMessageFromOtherNeed(Connection con,
                                            WonMessage wonMessage)

Specified by:

onMessageFromOtherNeed in interface OwnerCallback

onFailureResponse

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

Specified by:

onFailureResponse in interface OwnerCallback

onSuccessResponse

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

Specified by:

onSuccessResponse in interface OwnerCallback

onMatcherRegistered

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

Specified by:

onMatcherRegistered in interface Bot

onNewNeedCreatedNotificationForMatcher

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

Specified by:

onNewNeedCreatedNotificationForMatcher in interface Bot

onNeedActivatedNotificationForMatcher

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

Specified by:

onNeedActivatedNotificationForMatcher in interface Bot

onNeedDeactivatedNotificationForMatcher

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

Specified by:

onNeedDeactivatedNotificationForMatcher in interface Bot

act

public abstract 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

Throws:

java.lang.Exception