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;
25 import org.opendaylight.controller.sal.restconf.impl.StructuredData;
26 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
30 * The URI hierarchy for the RESTCONF resources consists of an entry point container, 4 top-level resources, and 1
33 * <li><b>/restconf</b> - {@link #getRoot()}
35 * <li><b>/config</b> - {@link #readConfigurationData(String)}
36 * {@link #updateConfigurationData(String, CompositeNode)}
37 * {@link #createConfigurationData(CompositeNode)}
38 * {@link #createConfigurationData(String, CompositeNode)}
39 * {@link #deleteConfigurationData(String)}
40 * <li><b>/operational</b> - {@link #readOperationalData(String)}
41 * <li>/modules - {@link #getModules()}
45 * <li><b>/operations</b> - {@link #invokeRpc(String, CompositeNode)}
46 * {@link #invokeRpc(String, CompositeNode)}
47 * <li>/version (field)
52 public interface RestconfService {
54 public static final String XML = "+xml";
55 public static final String JSON = "+json";
58 public Object getRoot();
62 @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
63 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
64 public NormalizedNodeContext getModules(@Context UriInfo uriInfo);
67 @Path("/modules/{identifier:.+}")
68 @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
69 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
70 public NormalizedNodeContext getModules(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
73 @Path("/modules/module/{identifier:.+}")
74 @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
75 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
76 public NormalizedNodeContext getModule(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
80 @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
81 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
82 public NormalizedNodeContext getOperations(@Context UriInfo uriInfo);
85 @Path("/operations/{identifier:.+}")
86 @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
87 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
88 public NormalizedNodeContext getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
91 @Path("/operations/{identifier:.+}")
92 @Produces({ 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 @Consumes({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
96 Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
97 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
98 public StructuredData invokeRpc(@Encoded @PathParam("identifier") String identifier, CompositeNode payload,
99 @Context UriInfo uriInfo);
102 @Path("/operations/{identifier:.+}")
103 @Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
104 Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
105 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
106 public StructuredData invokeRpc(@Encoded @PathParam("identifier") String identifier,
107 @DefaultValue("") String noPayload, @Context UriInfo uriInfo);
110 @Path("/config/{identifier:.+}")
111 @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
112 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
113 public NormalizedNodeContext readConfigurationData(@Encoded @PathParam("identifier") String identifier,
114 @Context UriInfo uriInfo);
117 @Path("/operational/{identifier:.+}")
118 @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
119 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
120 public NormalizedNodeContext readOperationalData(@Encoded @PathParam("identifier") String identifier,
121 @Context UriInfo uriInfo);
124 @Path("/config/{identifier:.+}")
125 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
126 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
127 public Response updateConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload);
130 @Path("/config/{identifier:.+}")
131 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
132 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
133 public Response createConfigurationData(@Encoded @PathParam("identifier") String identifier, NormalizedNodeContext payload,
134 @Context UriInfo uriInfo);
138 @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
139 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
140 public Response createConfigurationData(NormalizedNodeContext payload, @Context UriInfo uriInfo);
143 @Path("/config/{identifier:.+}")
144 public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
147 @Path("/streams/stream/{identifier:.+}")
148 public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
152 @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
153 MediaType.APPLICATION_XML, MediaType.TEXT_XML })
154 public NormalizedNodeContext getAvailableStreams(@Context UriInfo uriInfo);