restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/api/RestconfOperationsService.java

   1 /*
   2  * Copyright (c) 2016 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.restconf.nb.rfc8040.rests.services.api;
   9
  10 import javax.ws.rs.GET;
  11 import javax.ws.rs.Path;
  12 import javax.ws.rs.PathParam;
  13 import javax.ws.rs.Produces;
  14 import javax.ws.rs.core.Context;
  15 import javax.ws.rs.core.MediaType;
  16 import javax.ws.rs.core.UriInfo;
  17 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  18 import org.opendaylight.restconf.nb.rfc8040.MediaTypes;
  19
  20 /**
  21  * Container that provides access to the data-model specific operations supported by the server.
  22  */
  23 public interface RestconfOperationsService {
  24     /**
  25      * List of rpc or action operations supported by the server.
  26      *
  27      * @param uriInfo URI information
  28      * @return {@link NormalizedNodeContext}
  29      */
  30     @GET
  31     @Path("/operations")
  32     @Produces({
  33         MediaTypes.APPLICATION_YANG_DATA_JSON,
  34         MediaTypes.APPLICATION_YANG_DATA_XML,
  35         MediaType.APPLICATION_JSON,
  36         MediaType.APPLICATION_XML,
  37         MediaType.TEXT_XML
  38     })
  39     NormalizedNodeContext getOperations(@Context UriInfo uriInfo);
  40
  41     /**
  42      * Valid for mount points. List of operations supported by the server.
  43      *
  44      * @param identifier path parameter
  45      * @param uriInfo URI information
  46      * @return {@link NormalizedNodeContext}
  47      */
  48     @GET
  49     @Path("/operations/{identifier:.+}")
  50     @Produces({
  51         MediaTypes.APPLICATION_YANG_DATA_JSON,
  52         MediaTypes.APPLICATION_YANG_DATA_XML,
  53         MediaType.APPLICATION_JSON,
  54         MediaType.APPLICATION_XML,
  55         MediaType.TEXT_XML
  56     })
  57     NormalizedNodeContext getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
  58 }