ConfigureVRRPAction.java

package org.opennaas.extensions.router.junos.actionssets.actions.vrrp;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.opennaas.core.resources.action.ActionException;
import org.opennaas.core.resources.action.ActionResponse;
import org.opennaas.core.resources.protocol.IProtocolSession;
import org.opennaas.extensions.router.junos.actionssets.ActionConstants;
import org.opennaas.extensions.router.junos.actionssets.actions.JunosAction;
import org.opennaas.extensions.router.junos.commandsets.commands.EditNetconfCommand;
import org.opennaas.extensions.router.model.ComputerSystem;
import org.opennaas.extensions.router.model.IPProtocolEndpoint;
import org.opennaas.extensions.router.model.LogicalPort;
import org.opennaas.extensions.router.model.ManagedElement;
import org.opennaas.extensions.router.model.NetworkPort;
import org.opennaas.extensions.router.model.ProtocolEndpoint;
import org.opennaas.extensions.router.model.ProtocolEndpoint.ProtocolIFType;
import org.opennaas.extensions.router.model.Service;
import org.opennaas.extensions.router.model.VRRPGroup;
import org.opennaas.extensions.router.model.VRRPProtocolEndpoint;
import org.opennaas.extensions.router.model.utils.IPUtilsHelper;

public class ConfigureVRRPAction extends JunosAction {
	Log							log						= LogFactory.getLog(ConfigureVRRPAction.class);

	private static final String	VELOCITY_TEMPLATE_IPv4	= "/VM_files/configureVRRP.vm";
	private static final String	VELOCITY_TEMPLATE_IPv6	= "/VM_files/configureVRRPIPv6.vm";

	public ConfigureVRRPAction() {
		super();
		initialize();
	}

	/**
	 * Initialize protocolName, ActionId and velocity template
	 */
	protected void initialize() {
		this.setActionID(ActionConstants.VRRP_CONFIGURE);
		setTemplate("/VM_files/configureVRRP.vm");
		this.protocolName = "netconf";
	}

	@Override
	public void executeListCommand(ActionResponse actionResponse, IProtocolSession protocol) throws ActionException {
		try {
			EditNetconfCommand command = new EditNetconfCommand(getVelocityMessage());
			command.initialize();
			actionResponse.addResponse(sendCommandToProtocol(command, protocol));
		} catch (Exception e) {
			throw new ActionException(this.actionID + ": " + e.getMessage(), e);
		}
		validateAction(actionResponse);
	}

	@Override
	public void parseResponse(Object responseMessage, Object model) throws ActionException {
		// TODO Auto-generated method stub

	}

	/**
	 * FIXME VRRPProtocolEndpoint in IPv6 should not have 3 IPProtocolEndpoints. The third one was a work-around to store the IPv6 prefix for
	 * router-advertisement. Router-advertisement is mandatory in VRRP with IPv6 and our model DOES NOT support it.
	 */
	@Override
	public boolean checkParams(Object params) throws ActionException {
		if (params == null) {
			throw new ActionException("Invalid params. Params cannot be null.");
		}
		// correct instance received
		if (!(params instanceof VRRPProtocolEndpoint))
			throw new ActionException("Invalid params. VRRPProtocolEndpoint expected.");

		VRRPProtocolEndpoint pE = (VRRPProtocolEndpoint) params;

		// ProtocolIFtype not set or not correct.
		if (pE.getProtocolIFType() == null)
			throw new ActionException("Invalid params. ProtocolIFtype cannot be null.");

		if (!pE.getProtocolIFType().equals(ProtocolIFType.IPV4) && !pE.getProtocolIFType().equals(ProtocolIFType.IPV6))
			throw new ActionException("Invalid params. Unknown ProtocolIFtype.");

		List<ProtocolEndpoint> protocolEndpoints = ((VRRPProtocolEndpoint) params).getBindedProtocolEndpoints();
		// VRRPProtocolEndpoint has 1 ProtocolEndpoint
		if (pE.getProtocolIFType().equals(ProtocolIFType.IPV4) && protocolEndpoints.size() != 1)
			throw new ActionException("Invalid params. A single IPProtocolEndpoint is required for VRRP IPv4.");

		if (pE.getProtocolIFType().equals(ProtocolIFType.IPV6) && protocolEndpoints.size() != 3)
			throw new ActionException("Invalid params. Three IPProtocolEndpoints are required for VRRP IPv6.");

		// protocolEndpoint is an instance of IPProtocolEndpoint
		ProtocolEndpoint protocolEndpoint = protocolEndpoints.get(0);
		if (!(protocolEndpoint instanceof IPProtocolEndpoint))
			throw new ActionException("Invalid params. IPProtocolEndpoint expected.");

		// ProtocolEndpoint and VRRPProtocolEndpoint with different protocols.
		if (protocolEndpoint.getProtocolIFType() == null || !protocolEndpoint.getProtocolIFType().equals(pE.getProtocolIFType()))
			throw new ActionException("Invalid params. IPProtocolEndpoint ProtocolIFtype not matching VRRP ProtocolIFtype " + pE.getProtocolIFType());

		if (pE.getProtocolIFType().equals(ProtocolIFType.IPV6)) {
			ProtocolEndpoint secondProtocolEndpoint = protocolEndpoints.get(1);
			if (!(secondProtocolEndpoint instanceof IPProtocolEndpoint))
				throw new ActionException("Invalid params. IPProtocolEndpoint expected.");
			if (secondProtocolEndpoint.getProtocolIFType() == null || !secondProtocolEndpoint.getProtocolIFType().equals(pE.getProtocolIFType()))
				throw new ActionException(
						"Invalid params. IPProtocolEndpoint ProtocolIFtype not matching VRRP ProtocolIFtype " + pE.getProtocolIFType());

			ProtocolEndpoint thirdProtocolEndpoint = protocolEndpoints.get(2);
			if (!(thirdProtocolEndpoint instanceof IPProtocolEndpoint))
				throw new ActionException("Invalid params. IPProtocolEndpoint expected.");
			if (thirdProtocolEndpoint.getProtocolIFType() == null || !thirdProtocolEndpoint.getProtocolIFType().equals(pE.getProtocolIFType()))
				throw new ActionException(
						"Invalid params. IPProtocolEndpoint ProtocolIFtype not matching VRRP ProtocolIFtype " + pE.getProtocolIFType());

		}

		// protocolEndpoint has 1 LogicalPort
		List<LogicalPort> logicalPorts = ((IPProtocolEndpoint) protocolEndpoint).getLogicalPorts();
		if (logicalPorts.size() != 1)
			throw new ActionException("Invalid params. A LogicalPort is required.");
		// logicalPort is an instance of NetworkPort
		LogicalPort logicalPort = logicalPorts.get(0);
		if (!(logicalPort instanceof NetworkPort))
			throw new ActionException("Invalid params. A NetworkPort is required.");

		// service is an instance of VRRPGroup
		Service service = ((VRRPProtocolEndpoint) params).getService();
		if (!(service instanceof VRRPGroup)) {
			throw new ActionException("Invalid params. VRRPGroup service required.");
		}

		if (pE.getProtocolIFType().equals(ProtocolIFType.IPV6))
			if (((VRRPGroup) service).getVirtualLinkAddress() == null || ((VRRPGroup) service).getVirtualLinkAddress().isEmpty())
				throw new ActionException("Invalid params. VirtualLinkAddress required for IPv6.");

		// structure correct
		return true;
	}

	@Override
	public void prepareMessage() throws ActionException {

		setTemplate();

		try {
			Map<String, Object> extraParams = new HashMap<String, Object>();

			// physical or logical router
			if (((ComputerSystem) modelToUpdate).getElementName() != null) {
				// is logicalRouter, add LRName param
				((ManagedElement) params).setElementName(((ComputerSystem) modelToUpdate).getElementName());
				// TODO If we don't have a ManagedElement initialized
			} else if (params != null && params instanceof ManagedElement && ((ManagedElement) params).getElementName() == null) {
				((ManagedElement) params).setElementName("");
			}

			// IP address and subnet mask of interface
			IPProtocolEndpoint ipProtocolEndpoint = (IPProtocolEndpoint) ((VRRPProtocolEndpoint) params).getBindedProtocolEndpoints().get(0);
			if (ipProtocolEndpoint.getProtocolIFType().equals(ProtocolIFType.IPV4)) {
				String ipAddress = ipProtocolEndpoint.getIPv4Address();
				extraParams.put("ipAddress", ipAddress);
				String subnetMask = IPUtilsHelper.parseLongToShortIpv4NetMask(ipProtocolEndpoint.getSubnetMask());
				extraParams.put("subnetMask", subnetMask);
			} else {
				String ipAddress = ipProtocolEndpoint.getIPv6Address();
				extraParams.put("ipAddress", ipAddress);
				short prefix = ipProtocolEndpoint.getPrefixLength();
				extraParams.put("prefix", prefix);
				IPProtocolEndpoint secondIProtocolEnpodint = (IPProtocolEndpoint) ((VRRPProtocolEndpoint) params).getBindedProtocolEndpoints().get(1);
				String secondIPAddress = secondIProtocolEnpodint.getIPv6Address();
				short secondPrefix = ipProtocolEndpoint.getPrefixLength();
				extraParams.put("ipLinkAddress", secondIPAddress);
				extraParams.put("ipLinkPrefix", secondPrefix);

				IPProtocolEndpoint thirdIProtocolEnpodint = (IPProtocolEndpoint) ((VRRPProtocolEndpoint) params).getBindedProtocolEndpoints().get(2);

				extraParams.put("longPrefix", thirdIProtocolEnpodint.getIPv6Address() + "/" + thirdIProtocolEnpodint.getPrefixLength());

			}
			// router interface
			NetworkPort networkInterface = (NetworkPort) ipProtocolEndpoint.getLogicalPorts().get(0);
			extraParams.put("networkInterface", networkInterface);

			// VRRPGroup
			VRRPGroup vrrpGroup = (VRRPGroup) ((VRRPProtocolEndpoint) params).getService();
			extraParams.put("vrrpGroup", vrrpGroup);

			setVelocityMessage(prepareVelocityCommand(params, template, extraParams));
		} catch (Exception e) {
			throw new ActionException(e);
		}
	}

	private void setTemplate() throws ActionException {
		VRRPProtocolEndpoint pE = (VRRPProtocolEndpoint) params;
		if (pE.getProtocolIFType().equals(ProtocolIFType.IPV4))
			this.template = VELOCITY_TEMPLATE_IPv4;
		else if (pE.getProtocolIFType().equals(ProtocolIFType.IPV6))
			this.template = VELOCITY_TEMPLATE_IPv6;
		else
			throw new ActionException("VRRPProtocolEndpoint param must have an either IPv4 or IPv6 ProtocolIFType.");

	}
}