restconf/sal-rest-connector/src/main/java/org/opendaylight/restconf/rest/services/api/RestconfStreamsService.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.rest.services.api;
   9
  10 import javax.ws.rs.GET;
  11 import javax.ws.rs.Path;
  12 import javax.ws.rs.Produces;
  13 import javax.ws.rs.core.Context;
  14 import javax.ws.rs.core.MediaType;
  15 import javax.ws.rs.core.UriInfo;
  16 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
  17 import org.opendaylight.restconf.Draft15;
  18 import org.opendaylight.restconf.utils.RestconfConstants;
  19
  20 /**
  21  * Container that provides access to the event notification streams supported by
  22  * the server.
  23  *
  24  */
  25 public interface RestconfStreamsService {
  26
  27     /**
  28      * List of streams supported by the server.
  29      *
  30      * @param uriInfo
  31      *            - URI information
  32      * @return {@link NormalizedNodeContext}
  33      */
  34     @GET
  35     @Path("data/ietf-restconf-monitoring:restconf-state/streams")
  36     @Produces({ Draft15.MediaTypes.DATA + RestconfConstants.JSON, Draft15.MediaTypes.DATA, MediaType.APPLICATION_JSON,
  37             MediaType.APPLICATION_XML, MediaType.TEXT_XML })
  38     public NormalizedNodeContext getAvailableStreams(@Context UriInfo uriInfo);
  39 }