restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/services/api/RestconfStreamsSubscriptionService.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.Encoded;
  11 import javax.ws.rs.GET;
  12 import javax.ws.rs.Path;
  13 import javax.ws.rs.PathParam;
  14 import javax.ws.rs.core.Context;
  15 import javax.ws.rs.core.UriInfo;
  16 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  17
  18 /**
  19  * Subscribing to streams.
  20  */
  21 public interface RestconfStreamsSubscriptionService {
  22     /**
  23      * Subscribing to receive notification from stream support.
  24      *
  25      * @param identifier
  26      *             name of stream
  27      * @param uriInfo
  28      *             URI info
  29      * @return {@link NormalizedNodePayload}
  30      */
  31     @GET
  32     @Path("data/ietf-restconf-monitoring:restconf-state/streams/stream/{identifier:.+}")
  33     NormalizedNodePayload subscribeToStream(@Encoded @PathParam("identifier") String identifier,
  34             @Context UriInfo uriInfo);
  35 }