/* * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.restconf.nb.rfc8040.rests.services.impl; import static java.util.Objects.requireNonNull; import com.google.common.collect.ImmutableList; import java.util.Optional; import org.opendaylight.mdsal.common.api.LogicalDatastoreType; import org.opendaylight.mdsal.dom.api.DOMRpcResult; import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult; import org.opendaylight.restconf.common.context.NormalizedNodeContext; import org.opendaylight.restconf.common.errors.RestconfDocumentedException; import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag; import org.opendaylight.restconf.common.errors.RestconfError.ErrorType; import org.opendaylight.restconf.common.util.DataChangeScope; import org.opendaylight.restconf.nb.rfc8040.rests.utils.ResolveEnumUtil; import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfStreamsConstants; import org.opendaylight.restconf.nb.rfc8040.streams.listeners.ListenersBroker; import org.opendaylight.restconf.nb.rfc8040.streams.listeners.NotificationListenerAdapter; import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserIdentifier; import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode; import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes; import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder; import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.NotificationDefinition; import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Utility class for creation of data-change-event or YANG notification streams. */ final class CreateStreamUtil { private static final Logger LOG = LoggerFactory.getLogger(CreateStreamUtil.class); private CreateStreamUtil() { throw new UnsupportedOperationException("Utility class"); } /** * Create data-change-event or notification stream with POST operation via RPC. * * @param payload Input of RPC - example in JSON (data-change-event stream): *
* {@code * { * "input": { * "path": "/toaster:toaster/toaster:toasterStatus", * "sal-remote-augment:datastore": "OPERATIONAL", * "sal-remote-augment:scope": "ONE" * } * } * } ** @param refSchemaCtx Reference to {@link EffectiveModelContext}. * @return {@link DOMRpcResult} - Output of RPC - example in JSON: *
* {@code * { * "output": { * "stream-name": "toaster:toaster/toaster:toasterStatus/datastore=OPERATIONAL/scope=ONE" * } * } * } **/ static DOMRpcResult createDataChangeNotifiStream(final NormalizedNodeContext payload, final EffectiveModelContext refSchemaCtx) { // parsing out of container with settings and path final ContainerNode data = (ContainerNode) requireNonNull(payload).getData(); final QName qname = payload.getInstanceIdentifierContext().getSchemaNode().getQName(); final YangInstanceIdentifier path = preparePath(data, qname); // building of stream name final StringBuilder streamNameBuilder = new StringBuilder( prepareDataChangeNotifiStreamName(path, requireNonNull(refSchemaCtx), data)); final NotificationOutputType outputType = prepareOutputType(data); if (outputType.equals(NotificationOutputType.JSON)) { streamNameBuilder.append('/').append(outputType.getName()); } final String streamName = streamNameBuilder.toString(); // registration of the listener ListenersBroker.getInstance().registerDataChangeListener(path, streamName, outputType); // building of output final QName outputQname = QName.create(qname, "output"); final QName streamNameQname = QName.create(qname, "stream-name"); final ContainerNode output = ImmutableContainerNodeBuilder.create() .withNodeIdentifier(new NodeIdentifier(outputQname)) .withChild(ImmutableNodes.leafNode(streamNameQname, streamName)).build(); return new DefaultDOMRpcResult(output); } /** * Prepare {@link NotificationOutputType}. * * @param data Container with stream settings (RPC create-stream). * @return Parsed {@link NotificationOutputType}. */ private static NotificationOutputType prepareOutputType(final ContainerNode data) { NotificationOutputType outputType = parseEnum( data, NotificationOutputType.class, RestconfStreamsConstants.OUTPUT_TYPE_PARAM_NAME); return outputType == null ? NotificationOutputType.XML : outputType; } /** * Prepare stream name. * * @param path Path of element from which data-change-event notifications are going to be generated. * @param schemaContext Schema context. * @param data Container with stream settings (RPC create-stream). * @return Parsed stream name. */ private static String prepareDataChangeNotifiStreamName(final YangInstanceIdentifier path, final EffectiveModelContext schemaContext, final ContainerNode data) { LogicalDatastoreType datastoreType = parseEnum( data, LogicalDatastoreType.class, RestconfStreamsConstants.DATASTORE_PARAM_NAME); datastoreType = datastoreType == null ? LogicalDatastoreType.CONFIGURATION : datastoreType; DataChangeScope scope = parseEnum(data, DataChangeScope.class, RestconfStreamsConstants.SCOPE_PARAM_NAME); scope = scope == null ? DataChangeScope.BASE : scope; return RestconfStreamsConstants.DATA_SUBSCRIPTION + "/" + ListenersBroker.createStreamNameFromUri( ParserIdentifier.stringFromYangInstanceIdentifier(path, schemaContext) + RestconfStreamsConstants.DS_URI + datastoreType + RestconfStreamsConstants.SCOPE_URI + scope); } /** * Prepare {@link YangInstanceIdentifier} of stream source. * * @param data Container with stream settings (RPC create-stream). * @param qualifiedName QName of the input RPC context (used only in debugging). * @return Parsed {@link YangInstanceIdentifier} of data element from which the data-change-event notifications * are going to be generated. */ private static YangInstanceIdentifier preparePath(final ContainerNode data, final QName qualifiedName) { final Optional