northbound-api/src/main/java/org/opendaylight/neutron/northbound/api/NeutronVPNIPSECPoliciesNorthbound.java

   1 /*
   2  * Copyright IBM Corporation, 2013.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.neutron.northbound.api;
  10
  11 import java.util.ArrayList;
  12 import java.util.HashMap;
  13 import java.util.Iterator;
  14 import java.util.List;
  15
  16 import javax.ws.rs.Consumes;
  17 import javax.ws.rs.DELETE;
  18 import javax.ws.rs.DefaultValue;
  19 import javax.ws.rs.GET;
  20 import javax.ws.rs.POST;
  21 import javax.ws.rs.PUT;
  22 import javax.ws.rs.Path;
  23 import javax.ws.rs.PathParam;
  24 import javax.ws.rs.Produces;
  25 import javax.ws.rs.QueryParam;
  26 import javax.ws.rs.core.Context;
  27 import javax.ws.rs.core.MediaType;
  28 import javax.ws.rs.core.Response;
  29 import javax.ws.rs.core.UriInfo;
  30
  31 import org.codehaus.enunciate.jaxrs.ResponseCode;
  32 import org.codehaus.enunciate.jaxrs.StatusCodes;
  33 import org.codehaus.enunciate.jaxrs.TypeHint;
  34 import org.opendaylight.neutron.spi.INeutronVPNIPSECPolicyAware;
  35 import org.opendaylight.neutron.spi.NeutronVPNIPSECPolicy;
  36
  37 /**
  38  * Neutron Northbound REST APIs for VPN IPSEC Policy.<br>
  39  * This class provides REST APIs for managing neutron VPN IPSEC Policies
  40  *
  41  * <br>
  42  * <br>
  43  * Authentication scheme : <b>HTTP Basic</b><br>
  44  * Authentication realm : <b>opendaylight</b><br>
  45  * Transport : <b>HTTP and HTTPS</b><br>
  46  * <br>
  47  * HTTPS Authentication is disabled by default. Administrator can enable it in
  48  * tomcat-server.xml after adding a proper keystore / SSL certificate from a
  49  * trusted authority.<br>
  50  * More info :
  51  * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
  52  *
  53  */
  54
  55 @Path("/vpn/ipsecpolicies")
  56 public class NeutronVPNIPSECPoliciesNorthbound {
  57
  58     @Context
  59     UriInfo uriInfo;
  60
  61     /**
  62      * Returns a list of all VPN IPSEC Policies */
  63
  64     @GET
  65     @Produces({ MediaType.APPLICATION_JSON })
  66     @StatusCodes({
  67         @ResponseCode(code = 501, condition = "Not Implemented") })
  68     public Response listVPNIPSECPolicies(
  69             ) {
  70         throw new UnimplementedException("Not Implemented");
  71     }
  72
  73     /**
  74      * Returns a specific VPN IPSEC Policy */
  75
  76     @Path("{serviceID}")
  77     @GET
  78     @Produces({ MediaType.APPLICATION_JSON })
  79     @StatusCodes({
  80         @ResponseCode(code = 501, condition = "Not Implemented") })
  81     public Response showVPNIPSECPolicy(
  82             @PathParam("serviceID") String serviceID,
  83             // return fields
  84             @QueryParam("fields") List<String> fields
  85             ) {
  86         throw new UnimplementedException("Not Implemented");
  87     }
  88
  89     /**
  90      * Creates new VPN IPSEC Policy */
  91     @POST
  92     @Produces({ MediaType.APPLICATION_JSON })
  93     @Consumes({ MediaType.APPLICATION_JSON })
  94     @TypeHint(NeutronVPNIPSECPolicy.class)
  95     @StatusCodes({
  96         @ResponseCode(code = 501, condition = "Not Implemented") })
  97     public Response createVPNIPSECPolicy(final NeutronVPNIPSECPolicyRequest input) {
  98         throw new UnimplementedException("Not Implemented");
  99     }
 100
 101     /**
 102      * Updates a VPN IPSEC Policy */
 103     @Path("{policyID}")
 104     @PUT
 105     @Produces({ MediaType.APPLICATION_JSON })
 106     @Consumes({ MediaType.APPLICATION_JSON })
 107     @StatusCodes({
 108         @ResponseCode(code = 501, condition = "Not Implemented") })
 109     public Response updateVPNIPSECPolicy(
 110             @PathParam("policyID") String policyID, final NeutronVPNIPSECPolicyRequest input
 111             ) {
 112         throw new UnimplementedException("Not Implemented");
 113     }
 114
 115     /**
 116      * Deletes a VPN IPSEC Policy */
 117
 118     @Path("{policyID}")
 119     @DELETE
 120     @StatusCodes({
 121         @ResponseCode(code = 501, condition = "Not Implemented") })
 122     public Response deleteVPNIPSECPolicy(
 123             @PathParam("policyID") String policyID) {
 124         throw new UnimplementedException("Not Implemented");
 125     }
 126 }