ITemplate.java

/**
 * 
 */
package org.opennaas.extensions.vcpe.manager.templates;

/*
 * #%L
 * OpenNaaS :: vCPENetwork
 * %%
 * 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 org.opennaas.extensions.vcpe.manager.VCPENetworkManagerException;
import org.opennaas.extensions.vcpe.model.VCPENetworkModel;

/**
 * @author Jordi
 */
public interface ITemplate {

	public static final String	SP_VCPE_TEMPLATE	= "sp_vcpe";
	public static final String	MP_VCPE_TEMPLATE	= "mp_vcpe";

	/**
	 * Generate the model from the template and the parameters of the initialModel. Uses managerModel to check availability of given parameters.
	 * 
	 * @param initialModel
	 * @param managerModel
	 * @return VCPENetworkModel
	 * @throws VCPENetworkManagerException
	 *             if parameters are not available
	 */
	public VCPENetworkModel buildModel(VCPENetworkModel initialModel) throws VCPENetworkManagerException;

	public VCPENetworkModel getPhysicalInfrastructureSuggestion() throws VCPENetworkManagerException;

	public VCPENetworkModel getLogicalInfrastructureSuggestion(VCPENetworkModel physicalInfrastructure) throws VCPENetworkManagerException;

}