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