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.StructuredData;
25 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
28 * The URI hierarchy for the RESTCONF resources consists of an entry point
29 * container, 4 top-level resources, and 1 field.
31 * <li><b>/restconf</b> - {@link #getRoot()}
33 * <li><b>/config</b> - {@link #readConfigurationData(String)}
34 * {@link #updateConfigurationData(String, CompositeNode)}
35 * {@link #createConfigurationData(CompositeNode)}
36 * {@link #createConfigurationData(String, CompositeNode)}
37 * {@link #deleteConfigurationData(String)}
38 * <li><b>/operational</b> - {@link #readOperationalData(String)}
39 * <li>/modules - {@link #getModules()}
43 * <li><b>/operations</b> - {@link #invokeRpc(String, CompositeNode)}
44 * {@link #invokeRpc(String, CompositeNode)}
45 * <li>/version (field)
50 public interface RestconfService {
52 public static final String XML = "+xml";
53 public static final String JSON = "+json";
56 public Object getRoot();
60 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
61 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
62 public StructuredData getModules(@Context UriInfo uriInfo);
65 @Path("/modules/{identifier:.+}")
66 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
67 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
68 public StructuredData getModules(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
71 @Path("/modules/module/{identifier:.+}")
72 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
73 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
74 public StructuredData getModule(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
78 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
79 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
80 public StructuredData getOperations(@Context UriInfo uriInfo);
83 @Path("/operations/{identifier:.+}")
84 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
85 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
86 public StructuredData getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
89 @Path("/operations/{identifier:.+}")
90 @Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
91 Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
92 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
93 @Consumes({ 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 public StructuredData invokeRpc(@Encoded @PathParam("identifier") String identifier, CompositeNode payload, @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 StructuredData 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 StructuredData 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 StructuredData readOperationalData(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
120 @Path("/config/{identifier:.+}")
121 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
122 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
123 public Response updateConfigurationData(@Encoded @PathParam("identifier") String identifier, CompositeNode payload);
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 createConfigurationData(@Encoded @PathParam("identifier") String identifier, CompositeNode payload);
133 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
134 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
135 public Response createConfigurationData(CompositeNode payload);
138 @Path("/config/{identifier:.+}")
139 public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
142 @Path("/streams/stream/{identifier:.+}")
143 public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
147 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
148 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
149 public StructuredData getAvailableStreams(@Context UriInfo uriInfo);