opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/rest/api/RestconfService.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  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 package org.opendaylight.controller.sal.rest.api;
   9
  10 import javax.ws.rs.Consumes;
  11 import javax.ws.rs.DELETE;
  12 import javax.ws.rs.DefaultValue;
  13 import javax.ws.rs.Encoded;
  14 import javax.ws.rs.GET;
  15 import javax.ws.rs.POST;
  16 import javax.ws.rs.PUT;
  17 import javax.ws.rs.Path;
  18 import javax.ws.rs.PathParam;
  19 import javax.ws.rs.Produces;
  20 import javax.ws.rs.core.Context;
  21 import javax.ws.rs.core.MediaType;
  22 import javax.ws.rs.core.Response;
  23 import javax.ws.rs.core.UriInfo;
  24 import org.opendaylight.controller.sal.restconf.impl.NormalizedNodeContext;
  25
  26 /**
  27  * The URI hierarchy for the RESTCONF resources consists of an entry point container, 4 top-level resources, and 1
  28  * field.
  29  * <ul>
  30  * <li><b>/restconf</b> - {@link #getRoot()}
  31  * <ul>
  32  *      <li><b>/config</b> - {@link #readConfigurationData(String)}
  33  *                              {@link #updateConfigurationData(String, NormalizedNodeContext)}
  34  *                              {@link #createConfigurationData(NormalizedNodeContext)}
  35  *                              {@link #createConfigurationData(String, NormalizedNodeContext)}
  36  * {@link #deleteConfigurationData(String)}
  37  * <li><b>/operational</b> - {@link #readOperationalData(String)}
  38  * <li>/modules - {@link #getModules()}
  39  * <ul>
  40  * <li>/module
  41  * </ul>
  42  *      <li><b>/operations</b> - {@link #invokeRpc(String, NormalizedNodeContext)}
  43  *                               {@link #invokeRpc(String, NormalizedNodeContext)}
  44  * <li>/version (field)
  45  * </ul>
  46  * </ul>
  47  */
  48 @Path("/")
  49 public interface RestconfService {
  50
  51     public static final String XML = "+xml";
  52     public static final String JSON = "+json";
  53
  54     @GET
  55     public Object getRoot();
  56
  57     @GET
  58     @Path("/modules")
  59     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
  60             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  61     public NormalizedNodeContext getModules(@Context UriInfo uriInfo);
  62
  63     @GET
  64     @Path("/modules/{identifier:.+}")
  65     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
  66             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  67     public NormalizedNodeContext getModules(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
  68
  69     @GET
  70     @Path("/modules/module/{identifier:.+}")
  71     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
  72             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  73     public NormalizedNodeContext getModule(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
  74
  75     @GET
  76     @Path("/operations")
  77     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
  78             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  79     public NormalizedNodeContext getOperations(@Context UriInfo uriInfo);
  80
  81     @GET
  82     @Path("/operations/{identifier:.+}")
  83     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
  84             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  85     public NormalizedNodeContext getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
  86
  87     @POST
  88     @Path("/operations/{identifier:.+}")
  89     @Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
  90             Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
  91             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  92     @Consumes({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
  93             Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
  94             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  95     public NormalizedNodeContext invokeRpc(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload,
  96             @Context UriInfo uriInfo);
  97
  98     @POST
  99     @Path("/operations/{identifier:.+}")
 100     @Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
 101             Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
 102             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
 103     @Deprecated // method isn't use anywhere
 104     public NormalizedNodeContext invokeRpc(@Encoded @PathParam("identifier") String identifier,
 105             @DefaultValue("") String noPayload, @Context UriInfo uriInfo);
 106
 107     @GET
 108     @Path("/config/{identifier:.+}")
 109     @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
 110             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
 111     public NormalizedNodeContext readConfigurationData(@Encoded @PathParam("identifier") String identifier,
 112             @Context UriInfo uriInfo);
 113
 114     @GET
 115     @Path("/operational/{identifier:.+}")
 116     @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
 117             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
 118     public NormalizedNodeContext readOperationalData(@Encoded @PathParam("identifier") String identifier,
 119             @Context UriInfo uriInfo);
 120
 121     @PUT
 122     @Path("/config/{identifier:.+}")
 123     @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
 124             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
 125     public Response updateConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload);
 126
 127     @POST
 128     @Path("/config/{identifier:.+}")
 129     @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
 130             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
 131     public Response createConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload,
 132             @Context UriInfo uriInfo);
 133
 134     @POST
 135     @Path("/config")
 136     @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
 137             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
 138     public Response createConfigurationData(NormalizedNodeContext payload, @Context UriInfo uriInfo);
 139
 140     @DELETE
 141     @Path("/config/{identifier:.+}")
 142     public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
 143
 144     @GET
 145     @Path("/streams/stream/{identifier:.+}")
 146     public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
 147
 148     @GET
 149     @Path("/streams")
 150     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
 151             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
 152     public NormalizedNodeContext getAvailableStreams(@Context UriInfo uriInfo);
 153
 154 }