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