2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.sal.rest.api;
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;
27 * The URI hierarchy for the RESTCONF resources consists of an entry point container, 4 top-level resources, and 1
30 * <li><b>/restconf</b> - {@link #getRoot()}
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()}
42 * <li><b>/operations</b> - {@link #invokeRpc(String, NormalizedNodeContext)}
43 * {@link #invokeRpc(String, NormalizedNodeContext)}
44 * <li>/version (field)
49 public interface RestconfService {
51 public static final String XML = "+xml";
52 public static final String JSON = "+json";
55 public Object getRoot();
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);
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);
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);
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);
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);
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);
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 public NormalizedNodeContext invokeRpc(@Encoded @PathParam("identifier") String identifier,
104 @DefaultValue("") String noPayload, @Context UriInfo uriInfo);
107 @Path("/config/{identifier:.+}")
108 @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
109 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
110 public NormalizedNodeContext readConfigurationData(@Encoded @PathParam("identifier") String identifier,
111 @Context UriInfo uriInfo);
114 @Path("/operational/{identifier:.+}")
115 @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
116 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
117 public NormalizedNodeContext readOperationalData(@Encoded @PathParam("identifier") String identifier,
118 @Context UriInfo uriInfo);
121 @Path("/config/{identifier:.+}")
122 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
123 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
124 public Response updateConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload);
127 @Path("/config/{identifier:.+}")
128 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
129 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
130 public Response createConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload,
131 @Context UriInfo uriInfo);
135 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
136 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
137 public Response createConfigurationData(NormalizedNodeContext payload, @Context UriInfo uriInfo);
140 @Path("/config/{identifier:.+}")
141 public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
144 @Path("/streams/stream/{identifier:.+}")
145 public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
149 @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
150 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
151 public NormalizedNodeContext getAvailableStreams(@Context UriInfo uriInfo);