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