restconf/restconf-nb-rfc8040/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.common.context.NormalizedNodeContext;
  17 import org.opendaylight.restconf.nb.rfc8040.services.simple.api.UpdateHandlers;
  18
  19 /**
  20  * Subscribing to streams.
  21  *
  22  */
  23 public interface RestconfStreamsSubscriptionService extends UpdateHandlers {
  24
  25     /**
  26      * Subscribing to receive notification from stream support.
  27      *
  28      * @param identifier
  29      *             name of stream
  30      * @param uriInfo
  31      *             URI info
  32      * @return {@link NormalizedNodeContext}
  33      */
  34     @GET
  35     @Path("data/ietf-restconf-monitoring:restconf-state/streams/stream/{identifier:.+}")
  36     NormalizedNodeContext subscribeToStream(@Encoded @PathParam("identifier") String identifier,
  37             @Context UriInfo uriInfo);
  38 }