7f8f0a1d0e32478d4b977cefab1398a252c52c2a
[controller.git] / opendaylight / md-sal / sal-rest-connector / src / main / java / org / opendaylight / controller / sal / rest / api / RestconfService.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.controller.sal.rest.api;
9
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;
27 import org.opendaylight.yangtools.yang.data.api.Node;
28
29
30 /**
31  * The URI hierarchy for the RESTCONF resources consists of an entry point container, 4 top-level resources, and 1
32  * field.
33  * <ul>
34  * <li><b>/restconf</b> - {@link #getRoot()}
35  * <ul>
36  *      <li><b>/config</b> - {@link #readConfigurationData(String)}
37  *                              {@link #updateConfigurationData(String, CompositeNode)}
38  *                              {@link #createConfigurationData(CompositeNode)}
39  *                              {@link #createConfigurationData(String, CompositeNode)}
40  * {@link #deleteConfigurationData(String)}
41  * <li><b>/operational</b> - {@link #readOperationalData(String)}
42  * <li>/modules - {@link #getModules()}
43  * <ul>
44  * <li>/module
45  * </ul>
46  *      <li><b>/operations</b> - {@link #invokeRpc(String, CompositeNode)}
47  *                               {@link #invokeRpc(String, CompositeNode)}
48  * <li>/version (field)
49  * </ul>
50  * </ul>
51  */
52 @Path("/")
53 public interface RestconfService {
54
55     public static final String XML = "+xml";
56     public static final String JSON = "+json";
57
58     @GET
59     public Object getRoot();
60
61     @GET
62     @Path("/modules")
63     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
64             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
65     public StructuredData getModules(@Context UriInfo uriInfo);
66
67     @GET
68     @Path("/modules/{identifier:.+}")
69     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
70             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
71     public StructuredData getModules(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
72
73     @GET
74     @Path("/modules/module/{identifier:.+}")
75     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
76             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
77     public StructuredData getModule(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
78
79     @GET
80     @Path("/operations")
81     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
82             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
83     public StructuredData getOperations(@Context UriInfo uriInfo);
84
85     @GET
86     @Path("/operations/{identifier:.+}")
87     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
88             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
89     public StructuredData getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
90
91     @POST
92     @Path("/operations/{identifier:.+}")
93     @Produces({ 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     @Consumes({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
97             Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
98             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
99     public StructuredData invokeRpc(@Encoded @PathParam("identifier") String identifier, CompositeNode payload,
100             @Context UriInfo uriInfo);
101
102     @POST
103     @Path("/operations/{identifier:.+}")
104     @Produces({ Draft02.MediaTypes.OPERATION + JSON, Draft02.MediaTypes.OPERATION + XML,
105             Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
106             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
107     public StructuredData invokeRpc(@Encoded @PathParam("identifier") String identifier,
108             @DefaultValue("") String noPayload, @Context UriInfo uriInfo);
109
110     @GET
111     @Path("/config/{identifier:.+}")
112     @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
113             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
114     public NormalizedNodeContext readConfigurationData(@Encoded @PathParam("identifier") String identifier,
115             @Context UriInfo uriInfo);
116
117     @GET
118     @Path("/operational/{identifier:.+}")
119     @Produces({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
120             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
121     public NormalizedNodeContext readOperationalData(@Encoded @PathParam("identifier") String identifier,
122             @Context UriInfo uriInfo);
123
124     @PUT
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 updateConfigurationData(@Encoded @PathParam("identifier") String identifier, Node<?> payload);
129
130     @POST
131     @Path("/config/{identifier:.+}")
132     @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
133             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
134     public Response createConfigurationData(@Encoded @PathParam("identifier") String identifier, Node<?> payload);
135
136     @POST
137     @Path("/config")
138     @Consumes({ Draft02.MediaTypes.DATA + JSON, Draft02.MediaTypes.DATA + XML, MediaType.APPLICATION_JSON,
139             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
140     public Response createConfigurationData(Node<?> payload);
141
142     @DELETE
143     @Path("/config/{identifier:.+}")
144     public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
145
146     @GET
147     @Path("/streams/stream/{identifier:.+}")
148     public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
149
150     @GET
151     @Path("/streams")
152     @Produces({ Draft02.MediaTypes.API + JSON, Draft02.MediaTypes.API + XML, MediaType.APPLICATION_JSON,
153             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
154     public StructuredData getAvailableStreams(@Context UriInfo uriInfo);
155
156 }