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
  27 /**
  28  * The URI hierarchy for the RESTCONF resources consists of an entry point container, 4 top-level resources, and 1
  29  * field.
  30  * <ul>
  31  * <li><b>/restconf</b> - {@link #getRoot()}
  32  * <ul>
  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()}
  38  * <ul>
  39  * <li>/module
  40  * </ul>
  41  * <li><b>/operations</b> - {@link #invokeRpc(String, CompositeNode)} {@link #invokeRpc(String, CompositeNode)}
  42  * <li>/version (field)
  43  * </ul>
  44  * </ul>
  45  */
  46 @Path("/")
  47 public interface RestconfService {
  48
  49     public static final String XML = "+xml";
  50     public static final String JSON = "+json";
  51
  52     @GET
  53     public Object getRoot();
  54
  55     @GET
  56     @Path("/modules")
  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);
  60
  61     @GET
  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);
  66
  67     @GET
  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);
  72
  73     @GET
  74     @Path("/operations")
  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);
  78
  79     @GET
  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);
  84
  85     @POST
  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);
  95
  96     @POST
  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);
 103
 104     @GET
 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);
 110
 111     @GET
 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);
 117
 118     @PUT
 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);
 123
 124     @POST
 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);
 129
 130     @POST
 131     @Path("/config")
 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);
 135
 136     @DELETE
 137     @Path("/config/{identifier:.+}")
 138     public Response deleteConfigurationData(@Encoded @PathParam("identifier") String identifier);
 139
 140     @GET
 141     @Path("/streams/stream/{identifier:.+}")
 142     public Response subscribeToStream(@Encoded @PathParam("identifier") String identifier, @Context UriInfo uriInfo);
 143
 144     @GET
 145     @Path("/streams")
 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);
 149
 150 }