RouterAgent.java

//----------------------------------------------------------------------------
// Copyright (C) 2011  Ingrid Nunes
// 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
// 
// To contact the authors:
// http://inf.ufrgs.br/prosoft/bdi4jade/
//
//----------------------------------------------------------------------------
package br.ufrgs.inf.bdinetr.agent;

import jade.content.lang.sl.SLCodec;
import jade.domain.DFService;
import jade.domain.FIPAException;
import jade.domain.FIPANames.ContentLanguage;
import jade.domain.FIPAAgentManagement.DFAgentDescription;
import jade.domain.FIPAAgentManagement.ServiceDescription;

import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import bdi4jade.belief.Belief;
import bdi4jade.belief.TransientBelief;
import bdi4jade.core.BDIAgent;
import bdi4jade.core.Capability;
import bdi4jade.core.SingleCapabilityAgent;
import bdi4jade.goal.Goal;
import bdi4jade.plan.Plan;
import bdi4jade.reasoning.AgentPlanSelectionStrategy;
import br.ufrgs.inf.bdinetr.domain.AnomalyDetection;
import br.ufrgs.inf.bdinetr.domain.Classifier;
import br.ufrgs.inf.bdinetr.domain.FlowExporter;
import br.ufrgs.inf.bdinetr.domain.LinkMonitor;
import br.ufrgs.inf.bdinetr.domain.RateLimiter;
import br.ufrgs.inf.bdinetr.domain.Role;
import br.ufrgs.inf.bdinetr.domain.Router;
import br.ufrgs.inf.bdinetr.domain.ontology.BDINetROntology;

/**
 * @author Ingrid Nunes
 */
public class RouterAgent extends SingleCapabilityAgent implements
		AgentPlanSelectionStrategy {

	public static class RootCapability extends Capability {
		public static final String ROUTER_BELIEF = "router";
		private static final long serialVersionUID = -2156730094556459899L;

		@bdi4jade.annotation.Plan
		private final GoalRequestPlan beliefGoalRequestPlan;
		@bdi4jade.annotation.Plan
		private final GoalResponsePlan beliefGoalResponsePlan;
		@bdi4jade.annotation.Belief
		private final Belief<String, Router> router;

		public RootCapability(Router router) {
			this.router = new TransientBelief<>(ROUTER_BELIEF, router);
			this.beliefGoalRequestPlan = new GoalRequestPlan();
			this.beliefGoalResponsePlan = new GoalResponsePlan();
		}
	}

	private static final Log log = LogFactory.getLog(RouterAgent.class);
	private static final long serialVersionUID = 6534875498063013722L;

	public RouterAgent(Router router) {
		super(new RootCapability(router));

		RootCapability root = (RootCapability) getCapability();

		if (router.hasRole(Role.LINK_MONITOR)) {
			this.getCapability().addPartCapability(
					new LinkMonitorCapability((LinkMonitor) router
							.getRole(Role.LINK_MONITOR),
							root.beliefGoalRequestPlan));
		}
		if (router.hasRole(Role.ANOMALY_DETECTION)) {
			this.getCapability().addPartCapability(
					new AnomalyDetectionCapability((AnomalyDetection) router
							.getRole(Role.ANOMALY_DETECTION),
							root.beliefGoalRequestPlan));
		}
		if (router.hasRole(Role.RATE_LIMITER)) {
			this.getCapability().addPartCapability(
					new RateLimiterCapability((RateLimiter) router
							.getRole(Role.RATE_LIMITER)));
		}
		if (router.hasRole(Role.IP_RATE_LIMITER)) {
			this.getCapability().addPartCapability(
					new IPRateLimiterCapability((RateLimiter) router
							.getRole(Role.IP_RATE_LIMITER)));
		}
		if (router.hasRole(Role.CLASSIFIER)) {
			this.getCapability().addPartCapability(
					new ClassifierCapability((Classifier) router
							.getRole(Role.CLASSIFIER),
							root.beliefGoalRequestPlan));
		}
		if (router.hasRole(Role.FLOW_EXPORTER)) {
			this.getCapability().addPartCapability(
					new FlowExporterCapability((FlowExporter) router
							.getRole(Role.FLOW_EXPORTER)));
		}

		setPlanSelectionStrategy(this);
	}

	@Override
	protected void init() {
		DFAgentDescription dfd = new DFAgentDescription();
		dfd.setName(getAID());
		for (Capability capability : getAllCapabilities()) {
			if (capability instanceof RouterAgentCapability) {
				ServiceDescription sd = new ServiceDescription();
				sd.setType(((RouterAgentCapability) capability).getRole()
						.name());
				sd.setName(getLocalName());
				sd.addLanguages(ContentLanguage.FIPA_SL);
				sd.addOntologies(BDINetROntology.ONTOLOGY_NAME);
				dfd.addServices(sd);
			}
		}

		try {
			DFService.register(this, dfd);
		} catch (FIPAException fe) {
			log.error(getLocalName()
					+ " registration with DF unsucceeded. Reason: "
					+ fe.getMessage());
			log.error(fe);
			fe.printStackTrace();
		}

		getContentManager().registerLanguage(new SLCodec());
		getContentManager().registerOntology(BDINetROntology.getInstance());
	}

	@Override
	public Plan selectPlan(Goal goal, Map<Capability, Set<Plan>> capabilityPlans) {
		Set<Plan> preselectedPlans = new HashSet<>();
		for (Capability capability : capabilityPlans.keySet()) {
			if (!getCapability().equals(capability)) {
				Plan preselectedPlan = capability.getPlanSelectionStrategy()
						.selectPlan(goal, capabilityPlans.get(capability));
				if (preselectedPlan != null) {
					preselectedPlans.add(preselectedPlan);
				}
			}
		}

		if (preselectedPlans.isEmpty()) {
			Set<Plan> candidatePlans = capabilityPlans.get(getCapability());
			return (candidatePlans == null) ? null : getCapability()
					.getPlanSelectionStrategy()
					.selectPlan(goal, candidatePlans);
		} else {
			return preselectedPlans.iterator().next();
		}
	}

	@Override
	public void setAgent(BDIAgent agent) {
		if (!this.equals(agent)) {
			throw new IllegalArgumentException(
					"This reasoning strategy is already associated with another agent.");
		}
	}

}