fipaos.platform.df
Class SubscriptionHandlerTask

fipaos.agent.task.Task
  |
  +--fipaos.platform.df.SubscriptionHandlerTask

public class SubscriptionHandlerTask
extends Task

This Task provides a mechanism for informing subscribed Agents about the something
that has changed within the DF - DFListenerTask is the counterpart to this Task.

Currently this Task (and its counterpart) only support intra-platform communication
over a transport which maintains message content as objects (i.e. RMI).


Constructor Summary
SubscriptionHandlerTask(fipaos.ont.fipa.ACL msg)
          Creates a SubscribeAction - once the Task has started, it will attempt
to "agree" and "inform" the subscribing Agent that the subscription has
been started OK

Method Summary
 (package private) voidDFUpdate(AgentManagementAction ama)
          Invoked by the DF when the DF has something to propogate to its subscribed
Agents
 voidhandleCancel(Conversation conv)
          Invoked when agree messages are received - generally indicates that DF will allow
us to subscribe
 voidhandleNotUnderstood(Conversation conv)
          Deal with not-understood messages here
 voidstartTask()
          Invoked when the Task starts - sends subscription message to target DF

Methods inherited from class fipaos.agent.task.Task
doneDFSearchTask, endTask, errorDFSearchTask, getContext, getState, handleAcceptProposal, handleAgree, handleCfp, handleConfirm, handleDisconfirm, handleFailure, handleInform, handleInformIf, handleInformRef, handleLateMessage, handlePropagate, handlePropose, handleProxy, handleQueryIf, handleQueryRef, handleRefuse, handleRejectProposal, handleRequest, handleRequestWhen, handleRequestWhenever, handleSubscribe, handleUndeliverableMessage, notify, notifyMessageFailure, notifyMessageForEndedConversation, setContext, timeoutDFSearchTask

Constructor Detail

SubscriptionHandlerTask

public SubscriptionHandlerTask(fipaos.ont.fipa.ACL msg)
Creates a SubscribeAction - once the Task has started, it will attempt
to "agree" and "inform" the subscribing Agent that the subscription has
been started OK
Parameters:
msg - First ACL message of the subscription
Method Detail

DFUpdate

void DFUpdate(AgentManagementAction ama)
Invoked by the DF when the DF has something to propogate to its subscribed
Agents

handleCancel

public void handleCancel(Conversation conv)
Invoked when agree messages are received - generally indicates that DF will allow
us to subscribe
Parameters:
conv - The subscription conversation

handleNotUnderstood

public void handleNotUnderstood(Conversation conv)
Deal with not-understood messages here

startTask

public void startTask()
Invoked when the Task starts - sends subscription message to target DF

Association Links

to Class fipaos.ont.fipa.fipaman.AgentID

Agent that is monitoring the DF

to Class java.lang.String

Conversation ID associated with our subscription messages

to Class fipaos.ont.proprietary.subscription.DFSubscriptionAction

The original subscription object submitted by the Agent this Task
is interacting with