restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/RestconfStreamsConstants.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.utils;
   9
  10 import com.google.common.collect.ImmutableSet;
  11 import java.net.URI;
  12 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  13 import org.opendaylight.restconf.common.util.DataChangeScope;
  14 import org.opendaylight.restconf.nb.rfc8040.utils.RestconfConstants;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  17 import org.opendaylight.yangtools.yang.common.Revision;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  19
  20 /**
  21  * Constants for streams.
  22  */
  23 public final class RestconfStreamsConstants {
  24
  25     public static final QNameModule SAL_REMOTE_AUGMENT = QNameModule.create(
  26             URI.create("urn:sal:restconf:event:subscription"),
  27             Revision.of("2014-07-08"));
  28     public static final QNameModule SUBSCRIBE_TO_NOTIFICATION = QNameModule.create(
  29             URI.create("subscribe:to:notification"),
  30             Revision.of("2016-10-28"));
  31
  32     public static final QName SAL_REMOTE_NAMESPACE = QName.create(
  33             "urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote",
  34             "2014-01-14",
  35             "sal-remote");
  36
  37     public static final String STREAM_PATH_PARAM_NAME = "path";
  38     public static final String DATASTORE_PARAM_NAME = "datastore";
  39     public static final String SCOPE_PARAM_NAME = "scope";
  40     public static final String OUTPUT_TYPE_PARAM_NAME = "notification-output-type";
  41     public static final String OUTPUT_CONTAINER_NAME = "output";
  42     public static final String OUTPUT_STREAM_NAME = "stream-name";
  43
  44
  45     public static final AugmentationIdentifier SAL_REMOTE_AUG_IDENTIFIER = new AugmentationIdentifier(ImmutableSet.of(
  46             QName.create(SAL_REMOTE_AUGMENT, SCOPE_PARAM_NAME),
  47             QName.create(SAL_REMOTE_AUGMENT, DATASTORE_PARAM_NAME),
  48             QName.create(SAL_REMOTE_AUGMENT, OUTPUT_TYPE_PARAM_NAME)));
  49
  50     public static final QName LOCATION_QNAME = QName.create(SUBSCRIBE_TO_NOTIFICATION, "location");
  51     public static final QName NOTIFI_QNAME = QName.create(SUBSCRIBE_TO_NOTIFICATION, "notifi");
  52
  53     public static final DataChangeScope DEFAULT_SCOPE = DataChangeScope.BASE;
  54     public static final LogicalDatastoreType DEFAULT_DS = LogicalDatastoreType.CONFIGURATION;
  55
  56     public static final char EQUAL = '=';
  57     public static final String DS_URI = RestconfConstants.SLASH + DATASTORE_PARAM_NAME + EQUAL;
  58     public static final String SCOPE_URI = RestconfConstants.SLASH + SCOPE_PARAM_NAME + EQUAL;
  59
  60     public static final String DATA_SUBSCRIPTION = "data-change-event-subscription";
  61     public static final String CREATE_DATA_SUBSCRIPTION = "create-" + DATA_SUBSCRIPTION;
  62     public static final String NOTIFICATION_STREAM = "notification-stream";
  63     public static final String CREATE_NOTIFICATION_STREAM = "create-" + NOTIFICATION_STREAM;
  64
  65     public static final String STREAMS_PATH = "ietf-restconf-monitoring:restconf-state/streams";
  66     public static final String STREAM_PATH_PART = "/stream=";
  67     public static final String STREAM_PATH = STREAMS_PATH + STREAM_PATH_PART;
  68     public static final String STREAM_ACCESS_PATH_PART = "/access=";
  69     public static final String STREAM_LOCATION_PATH_PART = "/location";
  70
  71     public static final String DATA_CHANGE_EVENT_STREAM_PATTERN = '/' + DATA_SUBSCRIPTION + "/*";
  72     public static final String YANG_NOTIFICATION_STREAM_PATTERN = '/' + NOTIFICATION_STREAM + "/*";
  73
  74     private RestconfStreamsConstants() {
  75         throw new UnsupportedOperationException("Util class.");
  76     }
  77 }