OSPFApiHelper.java

package org.opennaas.extensions.router.capabilities.api.helper;

/*
 * #%L
 * OpenNaaS :: Router :: OSPF capability
 * %%
 * Copyright (C) 2007 - 2014 Fundació Privada i2CAT, Internet i Innovació a Catalunya
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.opennaas.extensions.router.capabilities.api.model.chassis.InterfacesNamesList;
import org.opennaas.extensions.router.capabilities.api.model.ospf.OSPFAreaWrapper;
import org.opennaas.extensions.router.capabilities.api.model.ospf.OSPFProtocolEndpointWrapper;
import org.opennaas.extensions.router.capabilities.api.model.ospf.OSPFServiceWrapper;
import org.opennaas.extensions.router.model.OSPFArea;
import org.opennaas.extensions.router.model.OSPFAreaConfiguration;
import org.opennaas.extensions.router.model.OSPFProtocolEndpoint;
import org.opennaas.extensions.router.model.OSPFProtocolEndpointBase;
import org.opennaas.extensions.router.model.OSPFService;
import org.opennaas.extensions.router.model.utils.IPUtilsHelper;

public abstract class OSPFApiHelper {

	public static OSPFServiceWrapper buildOSPFServiceWrapper(OSPFService ospfService) throws IOException {

		OSPFServiceWrapper ospfServiceWrapper = new OSPFServiceWrapper();
		Collection<OSPFAreaWrapper> ospfAreaWrappers = new ArrayList<OSPFAreaWrapper>();

		for (OSPFAreaConfiguration areaConfig : ospfService.getOSPFAreaConfiguration()) {

			OSPFAreaWrapper ospfAreaWrapper = buildOSPFAreaWrapper(areaConfig.getOSPFArea());

			ospfAreaWrappers.add(ospfAreaWrapper);
		}

		ospfServiceWrapper.setOspfArea(ospfAreaWrappers);
		ospfServiceWrapper.setEnabledState(ospfService.getEnabledState());

		if (ospfService.getRouterID() != null)
			ospfServiceWrapper.setRouterId(ospfService.getRouterID());

		return ospfServiceWrapper;

	}

	public static OSPFAreaWrapper buildOSPFAreaWrapper(OSPFArea ospfArea) throws IOException {

		OSPFAreaWrapper ospfAreaWrapper = new OSPFAreaWrapper();
		ospfAreaWrapper.setAreaID(IPUtilsHelper.ipv4LongToString(ospfArea.getAreaID()));

		if (ospfArea.getAreaType() != null)
			ospfAreaWrapper.setAreaType(ospfArea.getAreaType());

		Collection<OSPFProtocolEndpointWrapper> ospfEndpointsWrapper = buildOSPFProtocolEndpointsWrapperCollection(ospfArea.getEndpointsInArea());
		ospfAreaWrapper.setOspfProtocolEndpoints(ospfEndpointsWrapper);

		return ospfAreaWrapper;
	}

	public static Collection<OSPFProtocolEndpointWrapper> buildOSPFProtocolEndpointsWrapperCollection(
			Collection<OSPFProtocolEndpointBase> protocolEndpointList) {

		List<OSPFProtocolEndpointWrapper> ospfEndpointsWrapper = new ArrayList<OSPFProtocolEndpointWrapper>();

		for (OSPFProtocolEndpointBase pE : protocolEndpointList) {

			OSPFProtocolEndpointWrapper endpointWrapper = buildOSPFProtocolEndpointWrapper(pE);

			ospfEndpointsWrapper.add(endpointWrapper);
		}

		return ospfEndpointsWrapper;

	}

	public static OSPFProtocolEndpointWrapper buildOSPFProtocolEndpointWrapper(OSPFProtocolEndpointBase pE) {

		OSPFProtocolEndpointWrapper endpointWrapper = new OSPFProtocolEndpointWrapper();

		endpointWrapper.setName(pE.getName());
		endpointWrapper.setState(pE.getEnabledState());

		return endpointWrapper;
	}

	public static OSPFService buildOSPFService(OSPFServiceWrapper ospfServiceWrapper) {

		OSPFService service = new OSPFService();

		if (ospfServiceWrapper.getRouterId() != null)
			service.setRouterID(ospfServiceWrapper.getRouterId());

		service.setEnabledState(ospfServiceWrapper.getEnabledState());

		return service;

	}

	/**
	 * Creates an OSPFAreaConfiguration with an OSPFArea and OSPFProtocolEndpoints (if any) from the given OSPFAreaWrapper.
	 * 
	 * @param ospfAreaWrapper
	 * @return
	 * @throws IOException
	 */
	public static OSPFAreaConfiguration buildOSPFAreaConfiguration(OSPFAreaWrapper ospfAreaWrapper) throws IOException {

		OSPFAreaConfiguration ospfAreaConfig = new OSPFAreaConfiguration();

		OSPFArea ospfArea = buildOSPFArea(ospfAreaWrapper);

		ospfAreaConfig.setOSPFArea(ospfArea);

		return ospfAreaConfig;
	}

	public static OSPFArea buildOSPFArea(OSPFAreaWrapper ospfAreaWrapper) throws IOException {

		OSPFArea ospfArea = new OSPFArea();

		ospfArea.setAreaID(IPUtilsHelper.ipv4StringToLong(ospfAreaWrapper.getAreaID()));

		if (ospfAreaWrapper.getAreaType() != null)
			ospfArea.setAreaType(ospfAreaWrapper.getAreaType());

		for (OSPFProtocolEndpointWrapper endpointWrapper : ospfAreaWrapper.getOspfProtocolEndpoints()) {
			OSPFProtocolEndpoint ospfEndpoint = new OSPFProtocolEndpoint();
			ospfEndpoint.setEnabledState(endpointWrapper.getEnabledState());
			ospfEndpoint.setName(endpointWrapper.getName());

			ospfArea.addEndpointInArea(ospfEndpoint);
		}

		return ospfArea;
	}

	/**
	 * Creates a basic OSPFAreaConfiguration with an OSPFArea with the specified areaId.
	 * 
	 * @param areaId
	 * @return
	 * @throws IOException
	 */
	public static OSPFAreaConfiguration buildOSPFAreaConfiguration(String areaId) throws IOException {

		OSPFAreaConfiguration areaConfig = new OSPFAreaConfiguration();
		OSPFArea ospfArea = buildOSPFArea(areaId);
		areaConfig.setOSPFArea(ospfArea);

		return areaConfig;
	}

	/**
	 * Creates an OSPFArea with the specific id.
	 * 
	 * @param areaId
	 * @return
	 * @throws IOException
	 */
	public static OSPFArea buildOSPFArea(String areaId) throws IOException {

		OSPFArea ospfArea = new OSPFArea();

		ospfArea.setAreaID(IPUtilsHelper.ipv4StringToLong(areaId));

		return ospfArea;
	}

	/**
	 * Creates a list of OSFProtocolEndpoint with the name of the interfaces specified in the InterfacesNamesList
	 * 
	 * @param interfaces
	 * @return
	 */
	public static List<OSPFProtocolEndpoint> buildOSPFProtocolEndpointsWrapperCollection(InterfacesNamesList interfaces) {

		List<OSPFProtocolEndpoint> ospfEndpoints = new ArrayList<OSPFProtocolEndpoint>();

		for (String iface : interfaces.getInterfaces()) {

			OSPFProtocolEndpoint ospfEndpoint = new OSPFProtocolEndpoint();
			ospfEndpoint.setName(iface);

			ospfEndpoints.add(ospfEndpoint);
		}

		return ospfEndpoints;
	}

	public static OSPFAreaConfiguration buildOSPFAreaConfiguration(String areaId, InterfacesNamesList interfaces) {
		// TODO Auto-generated method stub
		return null;
	}
}