restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/api/RestconfInvokeOperationsService.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.Consumes;
  11 import javax.ws.rs.Encoded;
  12 import javax.ws.rs.POST;
  13 import javax.ws.rs.Path;
  14 import javax.ws.rs.PathParam;
  15 import javax.ws.rs.Produces;
  16 import javax.ws.rs.core.Context;
  17 import javax.ws.rs.core.MediaType;
  18 import javax.ws.rs.core.UriInfo;
  19 import org.opendaylight.restconf.common.context.NormalizedNodeContext;
  20 import org.opendaylight.restconf.nb.rfc8040.Rfc8040;
  21 import org.opendaylight.restconf.nb.rfc8040.services.simple.api.UpdateHandlers;
  22 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
  23
  24 /**
  25  * An operation resource represents a protocol operation defined with the YANG
  26  * "rpc" statement. It is invoked using a POST method on the operation resource.
  27  *
  28  */
  29 public interface RestconfInvokeOperationsService extends UpdateHandlers {
  30
  31     /**
  32      * Invoke RPC operation.
  33      *
  34      * @param identifier
  35      *             module name and rpc identifier string for the desired
  36      *            operation
  37      * @param payload
  38      *             {@link NormalizedNodeContext} - the body of the operation
  39      * @param uriInfo
  40      *             URI info
  41      * @return {@link NormalizedNodeContext}
  42      */
  43     @POST
  44     @Path("/operations/{identifier:.+}")
  45     @Produces({ Rfc8040.MediaTypes.DATA + RestconfConstants.JSON, Rfc8040.MediaTypes.DATA + RestconfConstants.XML,
  46             MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  47     @Consumes({ Rfc8040.MediaTypes.DATA + RestconfConstants.JSON, Rfc8040.MediaTypes.DATA + RestconfConstants.XML,
  48             MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  49     NormalizedNodeContext invokeRpc(@Encoded @PathParam("identifier") String identifier,
  50             NormalizedNodeContext payload, @Context UriInfo uriInfo);
  51 }