+++ /dev/null
-/*
- * 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.utils.parser;
-
-import com.google.common.base.Optional;
-import com.google.common.base.Splitter;
-import com.google.common.collect.Iterables;
-import java.text.ParseException;
-import java.util.Date;
-import java.util.Iterator;
-import java.util.List;
-import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
-import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
-import org.opendaylight.netconf.md.sal.rest.schema.SchemaExportContext;
-import org.opendaylight.netconf.sal.restconf.impl.InstanceIdentifierContext;
-import org.opendaylight.netconf.sal.restconf.impl.RestconfDocumentedException;
-import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
-import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
-import org.opendaylight.restconf.parser.IdentifierCodec;
-import org.opendaylight.restconf.utils.RestconfConstants;
-import org.opendaylight.restconf.utils.validation.RestconfValidation;
-import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
-import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
-import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.SchemaNode;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Util class for parsing identifier.
- */
-public final class ParserIdentifier {
-
- private static final Logger LOG = LoggerFactory.getLogger(ParserIdentifier.class);
-
- private ParserIdentifier() {
- throw new UnsupportedOperationException("Util class.");
- }
-
- /**
- * Make {@link InstanceIdentifierContext} from {@link String} identifier
- * <br>
- * For identifiers of data NOT behind mount points returned
- * {@link InstanceIdentifierContext} is prepared with {@code null} reference of {@link DOMMountPoint} and with
- * controller's {@link SchemaContext}.
- * <br>
- * For identifiers of data behind mount points returned
- * {@link InstanceIdentifierContext} is prepared with reference of {@link DOMMountPoint} and its
- * own {@link SchemaContext}.
- *
- * @param identifier
- * - path identifier
- * @param schemaContext
- * - controller schema context
- * @param mountPointService
- * - mount point service
- * @return {@link InstanceIdentifierContext}
- */
- public static InstanceIdentifierContext<?> toInstanceIdentifier(
- final String identifier,
- final SchemaContext schemaContext,
- final Optional<DOMMountPointService> mountPointService) {
- if (identifier != null && identifier.contains(RestconfConstants.MOUNT)) {
- if (!mountPointService.isPresent()) {
- throw new RestconfDocumentedException("Mount point service is not available");
- }
-
- final Iterator<String> pathsIt = Splitter.on("/" + RestconfConstants.MOUNT).split(identifier).iterator();
-
- final String mountPointId = pathsIt.next();
- final YangInstanceIdentifier mountYangInstanceIdentifier = IdentifierCodec.deserialize(
- mountPointId, schemaContext);
- final Optional<DOMMountPoint> mountPoint =
- mountPointService.get().getMountPoint(mountYangInstanceIdentifier);
-
- if (!mountPoint.isPresent()) {
- throw new RestconfDocumentedException(
- "Mount point does not exist.", ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
- }
-
- final DOMMountPoint domMountPoint = mountPoint.get();
- final SchemaContext mountSchemaContext = domMountPoint.getSchemaContext();
-
- final String pathId = pathsIt.next().replaceFirst("/", "");
- final YangInstanceIdentifier pathYangInstanceIdentifier = IdentifierCodec.deserialize(
- pathId, mountSchemaContext);
-
- final DataSchemaContextNode<?> child = DataSchemaContextTree.from(mountSchemaContext)
- .getChild(pathYangInstanceIdentifier);
- if (child != null) {
- return new InstanceIdentifierContext<SchemaNode>(pathYangInstanceIdentifier, child.getDataSchemaNode(),
- domMountPoint, mountSchemaContext);
- }
- final QName rpcQName = pathYangInstanceIdentifier.getLastPathArgument().getNodeType();
- RpcDefinition def = null;
- for (final RpcDefinition rpcDefinition : mountSchemaContext
- .findModuleByNamespaceAndRevision(rpcQName.getNamespace(), rpcQName.getRevision()).getRpcs()) {
- if (rpcDefinition.getQName().getLocalName().equals(rpcQName.getLocalName())) {
- def = rpcDefinition;
- break;
- }
- }
- return new InstanceIdentifierContext<>(pathYangInstanceIdentifier, def, domMountPoint, mountSchemaContext);
- } else {
- final YangInstanceIdentifier deserialize = IdentifierCodec.deserialize(identifier, schemaContext);
- final DataSchemaContextNode<?> child = DataSchemaContextTree.from(schemaContext).getChild(deserialize);
-
- if (child != null) {
- return new InstanceIdentifierContext<SchemaNode>(
- deserialize, child.getDataSchemaNode(), null, schemaContext);
- }
- final QName rpcQName = deserialize.getLastPathArgument().getNodeType();
- RpcDefinition def = null;
- for (final RpcDefinition rpcDefinition
- : schemaContext.findModuleByNamespaceAndRevision(rpcQName.getNamespace(),
- rpcQName.getRevision()).getRpcs()) {
- if (rpcDefinition.getQName().getLocalName().equals(rpcQName.getLocalName())) {
- def = rpcDefinition;
- break;
- }
- }
- return new InstanceIdentifierContext<>(deserialize, def, null, schemaContext);
- }
- }
-
- /**
- * Make {@link String} from {@link YangInstanceIdentifier}.
- *
- * @param instanceIdentifier Instance identifier
- * @param schemaContext Schema context
- * @return Yang instance identifier serialized to String
- */
- public static String stringFromYangInstanceIdentifier(final YangInstanceIdentifier instanceIdentifier,
- final SchemaContext schemaContext) {
- return IdentifierCodec.serialize(instanceIdentifier, schemaContext);
- }
-
- /**
- * Make a {@link QName} from identifier.
- *
- * @param identifier
- * path parameter
- * @return {@link QName}
- */
- public static QName makeQNameFromIdentifier(final String identifier) {
- // check if more than one slash is not used as path separator
- if (identifier.contains(
- String.valueOf(RestconfConstants.SLASH).concat(String.valueOf(RestconfConstants.SLASH)))) {
- LOG.debug("URI has bad format. It should be \'moduleName/yyyy-MM-dd\' " + identifier);
- throw new RestconfDocumentedException(
- "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
- ErrorTag.INVALID_VALUE);
- }
-
- final int mountIndex = identifier.indexOf(RestconfConstants.MOUNT);
- final String moduleNameAndRevision;
- if (mountIndex >= 0) {
- moduleNameAndRevision = identifier.substring(mountIndex + RestconfConstants.MOUNT.length())
- .replaceFirst(String.valueOf(RestconfConstants.SLASH), "");
- } else {
- moduleNameAndRevision = identifier;
- }
-
- final List<String> pathArgs = RestconfConstants.SLASH_SPLITTER.splitToList(moduleNameAndRevision);
- if (pathArgs.size() != 2) {
- LOG.debug("URI has bad format '{}'. It should be 'moduleName/yyyy-MM-dd'", identifier);
- throw new RestconfDocumentedException(
- "URI has bad format. End of URI should be in format \'moduleName/yyyy-MM-dd\'", ErrorType.PROTOCOL,
- ErrorTag.INVALID_VALUE);
- }
-
- final Date moduleRevision;
- try {
- moduleRevision = SimpleDateFormatUtil.getRevisionFormat().parse(pathArgs.get(1));
- } catch (final ParseException e) {
- LOG.debug("URI has bad format: '{}'. It should be 'moduleName/yyyy-MM-dd'", identifier);
- throw new RestconfDocumentedException("URI has bad format. It should be \'moduleName/yyyy-MM-dd\'",
- ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
- }
-
- return QName.create(null, moduleRevision, pathArgs.get(0));
- }
-
- /**
- * Parsing {@link Module} module by {@link String} module name and
- * {@link Date} revision and from the parsed module create
- * {@link SchemaExportContext}.
- *
- * @param schemaContext
- * {@link SchemaContext}
- * @param identifier
- * path parameter
- * @param domMountPointService
- * {@link DOMMountPointService}
- * @return {@link SchemaExportContext}
- */
- public static SchemaExportContext toSchemaExportContextFromIdentifier(final SchemaContext schemaContext,
- final String identifier, final DOMMountPointService domMountPointService) {
- final Iterable<String> pathComponents = RestconfConstants.SLASH_SPLITTER.split(identifier);
- final Iterator<String> componentIter = pathComponents.iterator();
- if (!Iterables.contains(pathComponents, RestconfConstants.MOUNT)) {
- final String moduleName = RestconfValidation.validateAndGetModulName(componentIter);
- final Date revision = RestconfValidation.validateAndGetRevision(componentIter);
- final Module module = schemaContext.findModuleByName(moduleName, revision);
- return new SchemaExportContext(schemaContext, module);
- } else {
- final StringBuilder pathBuilder = new StringBuilder();
- while (componentIter.hasNext()) {
- final String current = componentIter.next();
-
- if (RestconfConstants.MOUNT.equals(current)) {
- pathBuilder.append("/");
- pathBuilder.append(RestconfConstants.MOUNT);
- break;
- }
-
- if (pathBuilder.length() != 0) {
- pathBuilder.append("/");
- }
-
- pathBuilder.append(current);
- }
- final InstanceIdentifierContext<?> point = ParserIdentifier
- .toInstanceIdentifier(pathBuilder.toString(), schemaContext, Optional.of(domMountPointService));
- final String moduleName = RestconfValidation.validateAndGetModulName(componentIter);
- final Date revision = RestconfValidation.validateAndGetRevision(componentIter);
- final Module module = point.getMountPoint().getSchemaContext().findModuleByName(moduleName, revision);
- return new SchemaExportContext(point.getMountPoint().getSchemaContext(), module);
- }
- }
-}
Code Review / netconf.git / blobdiff