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