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 container, 4 top-level resources, and 1
31 * <li><b>/restconf</b> - {@link #getRoot()}
33 * <li><b>/config</b> - {@link #readConfigurationData(String)} {@link #updateConfigurationData(String, CompositeNode)}
34 * {@link #createConfigurationData(CompositeNode)} {@link #createConfigurationData(String, CompositeNode)}
35 * {@link #deleteConfigurationData(String)}
36 * <li><b>/operational</b> - {@link #readOperationalData(String)}
37 * <li>/modules - {@link #getModules()}
41 * <li><b>/operations</b> - {@link #invokeRpc(String, CompositeNode)} {@link #invokeRpc(String, CompositeNode)}
42 * <li>/version (field)
47 public interface RestconfService {
49 public static final String XML = "+xml";
50 public static final String JSON = "+json";
53 public Object getRoot();
57 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
58 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
59 public StructuredData getModules(@Context UriInfo uriInfo);
62 @Path("/modules/{identifier:.+}")
63 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
64 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
65 public StructuredData getModules(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
68 @Path("/modules/module/{identifier:.+}")
69 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
70 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
71 public StructuredData getModule(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
75 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
76 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
77 public StructuredData getOperations(@Context UriInfo uriInfo);
80 @Path("/operations/{identifier:.+}")
81 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
82 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
83 public StructuredData getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
86 @Path("/operations/{identifier:.+}")
87 @Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
88 Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
89 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
90 @Consumes({ 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 public StructuredData invokeRpc(@Encoded @PathParam("identifier") String identifier, CompositeNode payload,
94 @Context UriInfo uriInfo);
97 @Path("/operations/{identifier:.+}")
98 @Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
99 Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
100 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
101 public StructuredData invokeRpc(@Encoded @PathParam("identifier") String identifier,
102 @DefaultValue("") String noPayload, @Context UriInfo uriInfo);
105 @Path("/config/{identifier:.+}")
106 @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
107 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
108 public StructuredData readConfigurationData(@Encoded @PathParam("identifier") String identifier,
109 @Context UriInfo uriInfo);
112 @Path("/operational/{identifier:.+}")
113 @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
114 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
115 public StructuredData readOperationalData(@Encoded @PathParam("identifier") String identifier,
116 @Context UriInfo uriInfo);
119 @Path("/config/{identifier:.+}")
120 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
121 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
122 public Response updateConfigurationData(@Encoded @PathParam("identifier") String identifier, CompositeNode payload);
125 @Path("/config/{identifier:.+}")
126 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
127 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
128 public Response createConfigurationData(@Encoded @PathParam("identifier") String identifier, CompositeNode payload);
132 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
133 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
134 public Response createConfigurationData(CompositeNode payload);
137 @Path("/config/{identifier:.+}")
138 public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
141 @Path("/streams/stream/{identifier:.+}")
142 public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
146 @Produces({ Draft02.MediaTypes.API + XML, Draft02.MediaTypes.API + JSON, MediaType.APPLICATION_JSON,
147 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
148 public StructuredData getAvailableStreams(@Context UriInfo uriInfo);