Responder

package examples.protocols;

import jade.core.*;
import jade.core.behaviours.*;
import jade.proto.*;
import jade.lang.acl.*;
import jade.domain.FIPAAgentManagement.*;
import java.io.*;

/**
 * This agent acts as a  responder for the FIPARequest and FIPAQuery protocol
 * The example shows how to write two simple the FIPARequest protocol
 and the FIPAQuery Protocol
 using the <code>AchiveREResponder<code> behaviour.
 * If a REQUEST message arrives the agent could reply in one of the following way:
 <UL>
 * <li> send an AGREE message and then an INFORM message
 * <li> send an AGREE message and then a FAILURE message
 * <li> send an AGREE message and then no message 
 * <li> send an AGREE message and then an out of sequence message
 * <li> send an INFORM message
 * <li> send a REFUSE message
 * <li> send a NOT_UNDERSTOD message
 * <li> send an out of sequence message
 * <li> send no message
 * </ul>
 * If QUERY-IF or QUERY-REF message arrive the agent could reply in one of the following way:
 * <ul>
 * <li> send a NOT_UNDERSTOOD message
 * <li> send a REFUSE message
 * <li> send a FAILURE message
 * <li> send an INFORM message
 * <li> send an out of sequence message
 * <li> send no message
 * </ul> 
 * This agent can be use together with an <code>Initiator</code> agent to see an agent conversation 
 * using random the FIPARequest or FIPAQuery protocol.
 *
 * @see jade.proto.AchieveREInitiator
 * @see jade.proto.AchieveREResponder
 * @author Tiziana Trucco - Telecom Italia Lab S.p.A
 * @version $Date: 2001/09/18 10:28:32 $ $Revision: 1.3 $
 **/


public class Responder extends Agent {
    
  public void setup() {
  
    Behaviour requestB = new MyRequestResponder(this, AchieveREResponder.createMessageTemplate(FIPAProtocolNames.FIPA_REQUEST));
    addBehaviour(requestB);
  
    Behaviour queryB = new MyRequestResponder(this,AchieveREResponder.createMessageTemplate(FIPAProtocolNames.FIPA_QUERY));
    addBehaviour(queryB);
  
  }



    
  /**
     Inner class MyRequestResponder
  */
  class MyRequestResponder extends AchieveREResponder {
    boolean sentAgree = false;
  
    public MyRequestResponder(Agent a, MessageTemplate mt) {
      super(a, mt, null);
    }
  
    protected ACLMessage prepareResponse(ACLMessage request) throws RefuseException, NotUnderstoodException {
      sentAgree=false;
      double chance = Math.random();
      
      double range = 1.0 / 6.0;
      ACLMessage response = request.createReply();
      
      if(chance < range ){
        //send a NOT UNDERSTOOD
        response.setPerformative(ACLMessage.NOT_UNDERSTOOD);
      }else if(chance <(range * 2.0)){
        //send a REFUSE    
        response.setPerformative(ACLMessage.REFUSE);
      }else if (chance < (range * 3.0)){
        //send an AGREE
        response.setPerformative(ACLMessage.AGREE);
        sentAgree = true;
      }else if (chance < (range * 4.0)){
        //send an out of sequence Message
        response.setPerformative(ACLMessage.SUBSCRIBE);
      }else if(chance <(range * 5.0)){
        //send an INFORM
        response.setPerformative(ACLMessage.INFORM);
      }else{
        //check the time out expiration in initiator. 
        response = null;
      }
      System.out.println( myAgent.getLocalName() + " --> is sending "+(response==null?"no":(response.getPerformative()==ACLMessage.SUBSCRIBE?"an out-of-sequence":ACLMessage.getPerformative(response.getPerformative())))+ " response to the protocol initiator." );
      return response;  
    }
  
    protected ACLMessage prepareResultNotification(ACLMessage request, ACLMessage response) throws FailureException {
      
      double chance = Math.random();
      
      ACLMessage resNot = request.createReply();
      
      if(sentAgree){
        if(chance < 0.25){
          //SENDING INFORM
          resNot.setPerformative(ACLMessage.INFORM);
        }else if(chance < 0.50){
          // sending FAILURE
          resNot.setPerformative(ACLMessage.FAILURE);
        }else if(chance < 0.75){
          //sending out of sequence message
          resNot.setPerformative(ACLMessage.SUBSCRIBE);
          myAgent.addBehaviour(new unblockInitiator(myAgent,resNot));
        }else{
          // sending no message checking TIMEOUT of Initiator.
          myAgent.addBehaviour(new unblockInitiator(myAgent,resNot));
          resNot = null;
        }
      }else {
        // the inform message has been already sent.
        resNot = null;
      }
      System.out.println( myAgent.getLocalName() +  " --> is sending "+(resNot==null?"no":(resNot.getPerformative()==ACLMessage.SUBSCRIBE?"an out-of-sequence":ACLMessage.getPerformative(resNot.getPerformative())))+ " result notification to the protocol initiator." );
      return resNot;
    }
  } // End of inner class MyRequestResponder
    
    


    /**
     * This inner class is a behaviour that waits until the user presses a
     * key and then sends a message
     **/
  class unblockInitiator extends OneShotBehaviour {
    ACLMessage msg;
    unblockInitiator(Agent a, ACLMessage msg) {
      super(a);
      this.msg=msg;
    }
    public void action() {
      System.out.println(myAgent.getLocalName() + ": This situation causes the initiator to block forever; when you are tired of waiting, press a key and a FAILURE message will be sent to unblock the initiator ...");
      try {
        BufferedReader buff = new BufferedReader(new InputStreamReader(System.in));
        String reply = buff.readLine();
      } catch (IOException e) {
        e.printStackTrace();
      }
      msg.setPerformative(ACLMessage.FAILURE);
      myAgent.send(msg);
    }
  }

}//end of class Responder