IPowerNetManagementCapability.java

package org.opennaas.extensions.powernet.capability.mgt;

import java.util.List;

import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

import org.opennaas.core.resources.capability.ICapability;
import org.opennaas.extensions.gim.controller.ModelElementNotFoundException;
import org.opennaas.extensions.gim.model.core.entities.PowerConsumer;
import org.opennaas.extensions.gim.model.core.entities.PowerDelivery;
import org.opennaas.extensions.gim.model.core.entities.PowerSupply;
import org.opennaas.extensions.gim.model.core.entities.sockets.PowerReceptor;
import org.opennaas.extensions.gim.model.core.entities.sockets.PowerSource;
import org.opennaas.extensions.gim.model.energy.Energy;
import org.opennaas.extensions.gim.model.load.RatedLoad;

/**
 * 
 * @author Isart Canyameres Gimenez (i2cat Foundation)
 * 
 */
@Path("/")
public interface IPowerNetManagementCapability extends ICapability {

	// PowerSupplies CRUD

	/**
	 * 
	 * @return List of existing power supplies ids.
	 */
	@Path("/supply/")
	@GET
	public List<String> getPowerSupplies();

	/**
	 * @param id
	 * @return supply id
	 */
	@Path("/supply/{id}")
	@POST
	@Produces(MediaType.APPLICATION_XML)
	public String createPowerSupply(@PathParam("id") String id);

	@Path("/supply/{id}")
	@DELETE
	public void deletePowerSupply(@PathParam("id") String supplyId) throws ModelElementNotFoundException;

	@Path("/supply/{id}")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public PowerSupply getPowerSupply(@PathParam("id") String supplyId) throws ModelElementNotFoundException;

	public void setPowerSupplySourceEnergy(String supplyId, String sourceId, String energyName, String energyClass, String energyType,
			double co2perUnit,
			double greenPercentage) throws ModelElementNotFoundException;

	@Path("/supply/{id}/sources/{sourceId}/energy")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerSupplySourceEnergy(@PathParam("id") String supplyId, @PathParam("sourceId") String sourceId, Energy energy)
			throws ModelElementNotFoundException;

	@Path("/supply/{id}/sources/{sourceId}/price")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerSupplySourcePrice(@PathParam("id") String supplyId, @PathParam("sourceId") String sourceId, double pricePerUnit)
			throws ModelElementNotFoundException;

	public void setPowerSupplySourceRatedLoad(String supplyId, String sourceId,
			double inputVoltage, double inputCurrent, double inputPower, double inputEnergy)
			throws ModelElementNotFoundException;

	@Path("/supply/{id}/sources/{sourceId}/load")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerSupplySourceRatedLoad(@PathParam("id") String supplyId, @PathParam("sourceId") String sourceId, RatedLoad ratedLoad)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param supplyId
	 * @return list of existing power sources ids in specified supply.
	 * @throws ModelElementNotFoundException
	 */
	@Path("/supply/{id}/sources")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public List<String> getPowerSupplySources(@PathParam("id") String supplyId) throws ModelElementNotFoundException;

	@Path("/supply/{id}/sources/{sourceId}")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public PowerSource getPowerSupplySource(@PathParam("id") String supplyId, @PathParam("sourceId") String sourceId)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param supplyId
	 * @param sourceId
	 * @param source
	 * @return created PowerSource id
	 * @throws ModelElementNotFoundException
	 */
	@Path("/supply/{id}/sources/{sourceId}")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	@Produces(MediaType.APPLICATION_XML)
	public String addPowerSupplySource(@PathParam("id") String supplyId, @PathParam("sourceId") String sourceId, PowerSource source)
			throws ModelElementNotFoundException;

	@Path("/supply/{id}/sources/{sourceId}")
	@DELETE
	public void removePowerSupplySource(@PathParam("id") String supplyId, @PathParam("sourceId") String sourceId)
			throws ModelElementNotFoundException;

	// PowerDeliveries CRUD

	/**
	 * 
	 * @return List of existing power deliveries ids.
	 */
	@Path("/delivery/")
	@GET
	public List<String> getPowerDeliveries();

	/**
	 * @param id
	 * @return delivery id
	 */
	@Path("/delivery/{id}")
	@POST
	@Produces(MediaType.APPLICATION_XML)
	public String createPowerDelivery(@PathParam("id") String id);

	@Path("/delivery/{id}")
	@DELETE
	public void deletePowerDelivery(@PathParam("id") String deliveryId) throws ModelElementNotFoundException;

	@Path("/delivery/{id}")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public PowerDelivery getPowerDelivery(@PathParam("id") String deliveryId) throws ModelElementNotFoundException;

	// public void setPowerDeliveryRatedLoad(String deliveryId, double inputVoltage, double inputCurrent, double inputPower,
	// double inputEnergy,
	// double outputVoltage, double outputCurrent) throws ModelElementNotFoundException;

	public void setPowerDeliverySourceRatedLoad(String deliveryId, String sourceId, double voltage, double current, double power,
			double energy) throws ModelElementNotFoundException;

	@Path("/delivery/{id}/sources/{sourceId}/load")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerDeliverySourceRatedLoad(@PathParam("id") String deliveryId, @PathParam("sourceId") String sourceId, RatedLoad load)
			throws ModelElementNotFoundException;

	public void setPowerDeliveryReceptorRatedLoad(String deliveryId, String receptorId, double voltage, double current, double power,
			double energy) throws ModelElementNotFoundException;

	@Path("/delivery/{id}/receptors/{receptorId}/load")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerDeliveryReceptorRatedLoad(@PathParam("id") String deliveryId, @PathParam("receptorId") String receptorId, RatedLoad load)
			throws ModelElementNotFoundException;

	public void setPowerDeliverySourceEnergy(String deliveryId, String sourceId, String energyName, String energyClass, String energyType,
			double co2perUnit,
			double greenPercentage) throws ModelElementNotFoundException;

	@Path("/delivery/{id}/sources/{sourceId}/energy")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerDeliverySourceEnergy(@PathParam("id") String deliveryId, @PathParam("sourceId") String sourceId, Energy energy)
			throws ModelElementNotFoundException;

	@Path("/delivery/{id}/sources/{sourceId}/price")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerDeliverySourcePrice(@PathParam("id") String deliveryId, @PathParam("sourceId") String sourceId, double pricePerUnit)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param deliveryId
	 * @return list of existing power sources ids in specified delivery.
	 * @throws ModelElementNotFoundException
	 */
	@Path("/delivery/{id}/sources")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public List<String> getPowerDeliverySources(@PathParam("id") String deliveryId) throws ModelElementNotFoundException;

	@Path("/delivery/{id}/sources/{sourceId}")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public PowerSource getPowerDeliverySource(@PathParam("id") String deliveryId, @PathParam("sourceId") String sourceId)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param deliveryId
	 * @param sourceId
	 * @param source
	 * @return created PowerSource id
	 * @throws ModelElementNotFoundException
	 */
	@Path("/delivery/{id}/sources/{sourceId}")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	@Produces(MediaType.APPLICATION_XML)
	public String addPowerDeliverySource(@PathParam("id") String deliveryId, @PathParam("sourceId") String sourceId, PowerSource source)
			throws ModelElementNotFoundException;

	@Path("/delivery/{id}/sources/{sourceId}")
	@DELETE
	public void removePowerDeliverySource(@PathParam("id") String deliveryId, @PathParam("sourceId") String sourceId)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param deliveryId
	 * @return list of existing power receptors ids in specified delivery.
	 * @throws ModelElementNotFoundException
	 */
	@Path("/delivery/{id}/receptors")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public List<String> getPowerDeliveryReceptors(@PathParam("id") String deliveryId) throws ModelElementNotFoundException;

	@Path("/delivery/{id}/receptors/{receptorId}")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public PowerReceptor getPowerDeliveryReceptor(@PathParam("id") String deliveryId, @PathParam("receptorId") String receptorId)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param deliveryId
	 * @param sourceId
	 * @param receptor
	 * @return created PowerReceptor id
	 * @throws ModelElementNotFoundException
	 */
	@Path("/delivery/{id}/receptors/{receptorId}")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	@Produces(MediaType.APPLICATION_XML)
	public String addPowerDeliveryReceptor(@PathParam("id") String deliveryId, @PathParam("receptorId") String receptorId, PowerReceptor receptor)
			throws ModelElementNotFoundException;

	@Path("/delivery/{id}/receptors/{receptorId}")
	@DELETE
	public void removePowerDeliveryReceptor(@PathParam("id") String deliveryId, @PathParam("receptorId") String receptorId)
			throws ModelElementNotFoundException;

	// PowerConsumers CRUD

	/**
	 * 
	 * @return List of existing power consumers ids.
	 */
	@Path("/consumer/")
	@GET
	public List<String> getPowerConsumers();

	/**
	 * @param id
	 * @return consumer id
	 */
	@Path("/consumer/{id}")
	@POST
	@Produces(MediaType.APPLICATION_XML)
	public String createPowerConsumer(@PathParam("id") String id);

	@Path("/consumer/{id}")
	@DELETE
	public void deletePowerConsumer(@PathParam("id") String consumerId) throws ModelElementNotFoundException;

	@Path("/consumer/{id}")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public PowerConsumer getPowerConsumer(@PathParam("id") String consumerId) throws ModelElementNotFoundException;

	// public void setPowerConsumerRatedLoad(@PathParam("id") String consumerId, double inputVoltage, double inputCurrent, double inputPower,
	// double inputEnergy)
	// throws ModelElementNotFoundException;
	//
	// @Path("/consumer/{id}/load")
	// @POST
	// @Consumes(MediaType.APPLICATION_XML)
	// public void setPowerConsumerRatedLoad(@PathParam("id") String consumerId, RatedLoad ratedLoad)
	// throws ModelElementNotFoundException;

	public void setPowerConsumerReceptorRatedLoad(String consumerId, String receptorId, double voltage, double current, double power,
			double energy) throws ModelElementNotFoundException;

	@Path("/consumer/{id}/receptors/{receptorId}/load")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	public void setPowerConsumerReceptorRatedLoad(@PathParam("id") String consumerId, @PathParam("receptorId") String receptorId, RatedLoad load)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param deliveryId
	 * @return list of existing power receptors ids in specified delivery.
	 * @throws ModelElementNotFoundException
	 */
	@Path("/consumer/{id}/receptors")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public List<String> getPowerConsumerReceptors(@PathParam("id") String consumerId) throws ModelElementNotFoundException;

	@Path("/consumer/{id}/receptors/{receptorId}")
	@GET
	@Produces(MediaType.APPLICATION_XML)
	public PowerReceptor getPowerConsumerReceptor(@PathParam("id") String consumerId, @PathParam("receptorId") String receptorId)
			throws ModelElementNotFoundException;

	/**
	 * 
	 * @param deliveryId
	 * @param consumerId
	 * @param receptor
	 * @return created PowerReceptor id
	 * @throws ModelElementNotFoundException
	 */
	@Path("/consumer/{id}/receptors/{receptorId}")
	@POST
	@Consumes(MediaType.APPLICATION_XML)
	@Produces(MediaType.APPLICATION_XML)
	public String addPowerConsumerReceptor(@PathParam("id") String consumerId, @PathParam("receptorId") String receptorId, PowerReceptor receptor)
			throws ModelElementNotFoundException;

	@Path("/consumer/{id}/receptors/{receptorId}")
	@DELETE
	public void removePowerConsumerReceptor(@PathParam("id") String consumerId, @PathParam("receptorId") String receptorId)
			throws ModelElementNotFoundException;

	// connections

	/**
	 * Connects an existing supply with an existing delivery, using specified power socket ids.
	 * <p/>
	 * Applying this actions represents the fact that given delivery is taking power from given supply.
	 * 
	 * @param supplyId
	 * @param supplySourceId
	 * @param deliveryId
	 * @param deliveryReceptorId
	 * @throws ModelElementNotFoundException
	 */
	@Path("/connectSupplyDelivery/")
	@POST
	public void connectSupplyDelivery(@QueryParam("supplyId") String supplyId, @QueryParam("sourceId") String supplySourceId,
			@QueryParam("deliveryId") String deliveryId, @QueryParam("receptorId") String deliveryReceptorId)
			throws ModelElementNotFoundException;

	/**
	 * Connects an existing consumer with an existing delivery, using specified power socket ids.
	 * <p/>
	 * Applying this actions represents the fact that given consumer is taking power from given delivery.
	 * 
	 * @param deliveryId
	 * @param deliverySourceId
	 * @param consumerId
	 * @param consumerReceptorId
	 * @throws ModelElementNotFoundException
	 */
	@Path("/connectDeliveryConsumer/")
	@POST
	public void connectDeliveryConsumer(@QueryParam("deliveryId") String deliveryId, @QueryParam("sourceId") String deliverySourceId,
			@QueryParam("consumerId") String consumerId, @QueryParam("receptorId") String consumerReceptorId)
			throws ModelElementNotFoundException;

	@Path("/disconnectSupplyDelivery/")
	@POST
	public void disconnectSupplyDelivery(@QueryParam("supplyId") String supplyId, @QueryParam("sourceId") String supplySourceId,
			@QueryParam("deliveryId") String deliveryId, @QueryParam("receptorId") String deliveryReceptorId)
			throws ModelElementNotFoundException;

	@Path("/disconnectDeliveryConsumer/")
	@POST
	public void disconnectDeliveryConsumer(@QueryParam("deliveryId") String deliveryId, @QueryParam("sourceId") String deliverySourceId,
			@QueryParam("consumerId") String consumerId, @QueryParam("receptorId") String consumerReceptorId)
			throws ModelElementNotFoundException;

}