restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/services/simple/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.services.simple.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.Rfc8040;
  19 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
  20
  21 /**
  22  * Container that provides access to the data-model specific operations supported by the server.
  23  */
  24 public interface RestconfOperationsService extends UpdateHandlers {
  25     /**
  26      * List of rpc or action operations supported by the server.
  27      *
  28      * @param uriInfo
  29      *             URI information
  30      * @return {@link NormalizedNodeContext}
  31      */
  32     @GET
  33     @Path("/operations")
  34     @Produces({
  35         Rfc8040.MediaTypes.DATA + RestconfConstants.JSON,
  36         Rfc8040.MediaTypes.DATA,
  37         MediaType.APPLICATION_JSON,
  38         MediaType.APPLICATION_XML,
  39         MediaType.TEXT_XML
  40     })
  41     NormalizedNodeContext getOperations(@Context UriInfo uriInfo);
  42
  43     /**
  44      * Valid for mount points. List of operations supported by the server.
  45      *
  46      * @param identifier
  47      *             path parameter
  48      * @param uriInfo
  49      *             URI information
  50      * @return {@link NormalizedNodeContext}
  51      */
  52     @GET
  53     @Path("/operations/{identifier:.+}")
  54     @Produces({
  55         Rfc8040.MediaTypes.DATA + RestconfConstants.JSON,
  56         Rfc8040.MediaTypes.DATA,
  57         MediaType.APPLICATION_JSON,
  58         MediaType.APPLICATION_XML,
  59         MediaType.TEXT_XML
  60     })
  61     NormalizedNodeContext getOperations(@PathParam("identifier") String identifier, @Context UriInfo uriInfo);
  62 }