X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=restconf%2Fsal-rest-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fsal%2Frest%2Fapi%2FRestconfService.java;h=e2775381a14b9e33cffd035257a5ce7729e84c5b;hb=dca9aa60cd4584298c414ff2722dff4f406fe0de;hp=17731de775d582fa4c21e94c998c0acd3d43d8ed;hpb=01a3b9adce74d7c6a10646ebbf0a3f4998a76d41;p=netconf.git
diff --git a/restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/rest/api/RestconfService.java b/restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/rest/api/RestconfService.java
index 17731de775..e2775381a1 100644
--- a/restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/rest/api/RestconfService.java
+++ b/restconf/sal-rest-connector/src/main/java/org/opendaylight/netconf/sal/rest/api/RestconfService.java
@@ -26,25 +26,29 @@ import org.opendaylight.netconf.sal.rest.impl.PATCH;
import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
import org.opendaylight.netconf.sal.restconf.impl.PATCHContext;
import org.opendaylight.netconf.sal.restconf.impl.PATCHStatusContext;
+import org.opendaylight.restconf.base.services.api.RestconfOperationsService;
+import org.opendaylight.restconf.restful.services.api.RestconfDataService;
+import org.opendaylight.restconf.restful.services.api.RestconfInvokeOperationsService;
/**
- * The URI hierarchy for the RESTCONF resources consists of an entry point container, 4 top-level resources, and 1
- * field.
+ * The URI hierarchy for the RESTCONF resources consists of an entry point
+ * container, 4 top-level resources, and 1 field.
*
* - /restconf - {@link #getRoot()}
*
- * - /config - {@link #readConfigurationData(String, UriInfo)}
- * {@link #updateConfigurationData(String, NormalizedNodeContext)}
- * {@link #createConfigurationData(NormalizedNodeContext, UriInfo)}
- * {@link #createConfigurationData(String, NormalizedNodeContext, UriInfo)}
+ *
- /config - {@link #readConfigurationData(String, UriInfo)}
+ * {@link #updateConfigurationData(String, NormalizedNodeContext, UriInfo)}
+ * {@link #createConfigurationData(NormalizedNodeContext, UriInfo)}
+ * {@link #createConfigurationData(String, NormalizedNodeContext, UriInfo)}
* {@link #deleteConfigurationData(String)}
*
- /operational - {@link #readOperationalData(String, UriInfo)}
*
- /modules - {@link #getModules(UriInfo)}
*
- *
- /operations - {@link #invokeRpc(String, NormalizedNodeContext, UriInfo)}
- * {@link #invokeRpc(String, NormalizedNodeContext, UriInfo)}
+ *
- /operations -
+ * {@link #invokeRpc(String, NormalizedNodeContext, UriInfo)}
+ * {@link #invokeRpc(String, NormalizedNodeContext, UriInfo)}
*
- /version (field)
*
*
@@ -58,36 +62,66 @@ public interface RestconfService {
@GET
public Object getRoot();
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#readData(UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/modules")
@Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
public NormalizedNodeContext getModules(@Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#readData(String, UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/modules/{identifier:.+}")
@Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
public NormalizedNodeContext getModules(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#readData(String, UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/modules/module/{identifier:.+}")
@Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
public NormalizedNodeContext getModule(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfOperationsService#getOperations(UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/operations")
@Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
public NormalizedNodeContext getOperations(@Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfOperationsService#getOperations(String, UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/operations/{identifier:.+}")
@Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
public NormalizedNodeContext getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfInvokeOperationsService#invokeRpc(String, NormalizedNodeContext, UriInfo)}
+ */
+ @Deprecated
@POST
@Path("/operations/{identifier:.+}")
@Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
@@ -108,6 +142,11 @@ public interface RestconfService {
public NormalizedNodeContext invokeRpc(@Encoded @PathParam("identifier") String identifier,
@DefaultValue("") String noPayload, @Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#readData(String, UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/config/{identifier:.+}")
@Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
@@ -115,6 +154,11 @@ public interface RestconfService {
public NormalizedNodeContext readConfigurationData(@Encoded @PathParam("identifier") String identifier,
@Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#readData(String, UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/operational/{identifier:.+}")
@Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
@@ -122,12 +166,23 @@ public interface RestconfService {
public NormalizedNodeContext readOperationalData(@Encoded @PathParam("identifier") String identifier,
@Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#putData(String, NormalizedNodeContext, UriInfo)}
+ */
+ @Deprecated
@PUT
@Path("/config/{identifier:.+}")
@Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
- public Response updateConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload);
-
+ public Response updateConfigurationData(@Encoded @PathParam("identifier") String identifier,
+ NormalizedNodeContext payload, @Context UriInfo uriInfo);
+
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#postData(String, NormalizedNodeContext, UriInfo)}
+ */
+ @Deprecated
@POST
@Path("/config/{identifier:.+}")
@Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
@@ -135,26 +190,47 @@ public interface RestconfService {
public Response createConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload,
@Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#postData(NormalizedNodeContext, UriInfo)}
+ */
+ @Deprecated
@POST
@Path("/config")
@Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
public Response createConfigurationData(NormalizedNodeContext payload, @Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#deleteData(String)}
+ */
+ @Deprecated
@DELETE
@Path("/config/{identifier:.+}")
public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
@GET
@Path("/streams/stream/{identifier:.+}")
- public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
+ public NormalizedNodeContext subscribeToStream(@Encoded @PathParam("identifier") String identifier,
+ @Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#readData(String, UriInfo)}
+ */
+ @Deprecated
@GET
@Path("/streams")
@Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
MediaType.APPLICATION_XML, MediaType.TEXT_XML })
public NormalizedNodeContext getAvailableStreams(@Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#patchData(String, PATCHContext, UriInfo)}
+ */
+ @Deprecated
@PATCH
@Path("/config/{identifier:.+}")
@Consumes({MediaTypes.PATCH + JSON, MediaTypes.PATCH + XML})
@@ -162,6 +238,11 @@ public interface RestconfService {
PATCHStatusContext patchConfigurationData(@Encoded @PathParam("identifier") String identifier, PATCHContext
context, @Context UriInfo uriInfo);
+ /**
+ * @deprecated do not use this method. It will be replaced by
+ * {@link RestconfDataService#patchData(PATCHContext, UriInfo)}
+ */
+ @Deprecated
@PATCH
@Path("/config")
@Consumes({MediaTypes.PATCH + JSON, MediaTypes.PATCH + XML})