jade.core.behaviours

Class OntologyServer

java.lang.Object

jade.core.behaviours.Behaviour

jade.core.behaviours.SimpleBehaviour

jade.core.behaviours.CyclicBehaviour

jade.core.behaviours.OntologyServer

All Implemented Interfaces:

java.io.Serializable

public class OntologyServer
extends CyclicBehaviour

Ready made behaviour that for each incoming message automatically invokes a corresponding method of the form
public void serveCcccPppp(Cccc c, ACLMessage msg) throws Exception
where Cccc represents the key content-element referenced by the incoming message msg and Pppp represents the performative of the message.
ContentElement-s representing SL0 operators action, done and result are automatically managed so that for instance if an incoming REQUEST message is received carrying a content of type
((action (actor ...) (Sell ...)))
a serving method with signature
public void serveSellRequest(Sell s, ACLMessage msg) throws Exception
will be searched.
Serving methods are responsible for sending back responses if any.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	myLogger

Fields inherited from class jade.core.behaviours.Behaviour

myAgent

Constructor Summary

Constructors

Constructor and Description
OntologyServer(Agent a, Ontology onto, int performative)
OntologyServer(Agent a, Ontology onto, int[] performatives)
OntologyServer(Agent a, Ontology onto, int[] performatives, java.lang.Object serverDelegate)
OntologyServer(Agent a, Ontology onto, int performative, java.lang.Object serverDelegate)

Method Summary

Modifier and Type	Method and Description
void	action() Runs the behaviour.
void	addPerformativeRequiringReply(int performative) If an unexpected error occurs in one of the serving methods or if a suitable serving method is not found for an incoming message, the OntologyServer automatically sends back a FAILURE or REFUSE message if the incoming performative was one of REQUEST, CFP, PROPOSE, QUERY, SUBSCRIBE, PROXY and PROPAGATE.
void	conversationFinished(java.lang.String convId) Notifies this OntologyServer that a given conversation is finished and therefore it must no longer ignore messages belonging to it.
protected java.lang.Object	extractKeyContentElement(ContentElement ce)
ConversationList	getIgnoredConversations()
ContentElement	getReceivedContentElement() Allows subclasses to retrieve the actually received content element e.g.
protected void	handleMessage(ACLMessage msg)
protected void	handleNotUnderstood(ContentException ce, ACLMessage msg)
protected void	handleServingFailure(java.lang.Throwable t, java.lang.Object cel, ACLMessage msg)
protected void	handleUnsupported(java.lang.Object keyCel, ACLMessage msg)
void	ignoreConversation(java.lang.String convId) Makes this OntologyServer ignore all incoming messages belonging to a given conversation i.e. marked with the indicated conversation-id
void	onStart() This method is just an empty placeholders for subclasses.
void	removePerformativeRequiringReply(int performative)
void	setIgnoredConversations(ConversationList l) Set the ConversationList used by this OntologyServer to determine which conversations to ignore (if any).
void	setLanguage(Codec codec)
void	setMessageTemplate(MessageTemplate template)
void	setPrintFullUnexpectedMessages(boolean printFullUnexpectedMessages)

Methods inherited from class jade.core.behaviours.CyclicBehaviour

done

Methods inherited from class jade.core.behaviours.SimpleBehaviour

reset

Methods inherited from class jade.core.behaviours.Behaviour

block, block, getAgent, getBehaviourName, getDataStore, getParent, isRunnable, onEnd, restart, root, setAgent, setBehaviourName, setDataStore

Methods inherited from class java.lang.Object

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

Field Detail

myLogger

protected Logger myLogger

Constructor Detail

OntologyServer

public OntologyServer(Agent a,
                      Ontology onto,
                      int performative)

OntologyServer

public OntologyServer(Agent a,
                      Ontology onto,
                      int[] performatives)

OntologyServer

public OntologyServer(Agent a,
                      Ontology onto,
                      int performative,
                      java.lang.Object serverDelegate)

OntologyServer

public OntologyServer(Agent a,
                      Ontology onto,
                      int[] performatives,
                      java.lang.Object serverDelegate)

Method Detail

setLanguage

public void setLanguage(Codec codec)

setMessageTemplate

public void setMessageTemplate(MessageTemplate template)

setIgnoredConversations

public void setIgnoredConversations(ConversationList l)

Set the ConversationList used by this OntologyServer to determine which conversations to ignore (if any). Note: calling this method after the behaviour started has no effect

See Also:

ignoreConversation(String)

getIgnoredConversations

public ConversationList getIgnoredConversations()

addPerformativeRequiringReply

public void addPerformativeRequiringReply(int performative)

If an unexpected error occurs in one of the serving methods or if a suitable serving method is not found for an incoming message, the OntologyServer automatically sends back a FAILURE or REFUSE message if the incoming performative was one of REQUEST, CFP, PROPOSE, QUERY, SUBSCRIBE, PROXY and PROPAGATE. In other cases the OntologyServer simply logs a suitable error message. The above list of performatives can be customized by means of this method as well as the addPerformativeRequiringReply(int) one.

Parameters:

performative - The performative to be added

removePerformativeRequiringReply

public void removePerformativeRequiringReply(int performative)

Parameters:

performative - The performative to be removed

See Also:

addPerformativeRequiringReply(int)

setPrintFullUnexpectedMessages

public void setPrintFullUnexpectedMessages(boolean printFullUnexpectedMessages)

onStart

public void onStart()

Description copied from class: Behaviour

This method is just an empty placeholders for subclasses. It is executed just once before starting behaviour execution. Therefore, it acts as a prolog to the task represented by this Behaviour.

Overrides:

onStart in class Behaviour

action

public final void action()

Description copied from class: Behaviour

Runs the behaviour. This abstract method must be implemented by Behavioursubclasses to perform ordinary behaviour duty. An agent schedules its behaviours calling their action() method; since all the behaviours belonging to the same agent are scheduled cooperatively, this method must not enter in an endless loop and should return as soon as possible to preserve agent responsiveness. To split a long and slow task into smaller section, recursive behaviour aggregation may be used.

Specified by:

action in class Behaviour

See Also:

CompositeBehaviour

handleMessage

protected void handleMessage(ACLMessage msg)

getReceivedContentElement

public final ContentElement getReceivedContentElement()

Allows subclasses to retrieve the actually received content element e.g. Action, Done, Result

Returns:

extractKeyContentElement

protected java.lang.Object extractKeyContentElement(ContentElement ce)

handleUnsupported

protected void handleUnsupported(java.lang.Object keyCel,
                                 ACLMessage msg)

handleServingFailure

protected void handleServingFailure(java.lang.Throwable t,
                                    java.lang.Object cel,
                                    ACLMessage msg)

handleNotUnderstood

protected void handleNotUnderstood(ContentException ce,
                                   ACLMessage msg)

ignoreConversation

public void ignoreConversation(java.lang.String convId)

Makes this OntologyServer ignore all incoming messages belonging to a given conversation i.e. marked with the indicated conversation-id

conversationFinished

public void conversationFinished(java.lang.String convId)

Notifies this OntologyServer that a given conversation is finished and therefore it must no longer ignore messages belonging to it.

See Also:

ignoreConversation(String)