yang/yang-repo-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinTextSchemaSource.java

   1 /*
   2  * Copyright (c) 2015 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.yangtools.yang.model.repo.api;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.base.MoreObjects;
  15 import com.google.common.base.MoreObjects.ToStringHelper;
  16 import com.google.common.io.ByteSource;
  17 import com.google.common.io.Resources;
  18 import java.io.InputStream;
  19 import java.nio.file.Files;
  20 import java.nio.file.Path;
  21 import java.util.Map.Entry;
  22 import org.eclipse.jdt.annotation.NonNull;
  23 import org.opendaylight.yangtools.yang.common.Revision;
  24 import org.opendaylight.yangtools.yang.common.YangConstants;
  25 import org.opendaylight.yangtools.yang.common.YangNames;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 /**
  30  * YIN text schema source representation. Exposes an RFC6020 or RFC7950 XML representation as an {@link InputStream}.
  31  */
  32 @Beta
  33 public abstract class YinTextSchemaSource extends ByteSource implements YinSchemaSourceRepresentation {
  34     private static final Logger LOG = LoggerFactory.getLogger(YinTextSchemaSource.class);
  35     private static final String XML_EXTENSION = ".xml";
  36
  37     private final @NonNull SourceIdentifier identifier;
  38
  39     protected YinTextSchemaSource(final SourceIdentifier identifier) {
  40         this.identifier = requireNonNull(identifier);
  41     }
  42
  43     public static @NonNull SourceIdentifier identifierFromFilename(final String name) {
  44         final String baseName;
  45         if (name.endsWith(YangConstants.RFC6020_YIN_FILE_EXTENSION)) {
  46             baseName = name.substring(0, name.length() - YangConstants.RFC6020_YIN_FILE_EXTENSION.length());
  47         } else if (name.endsWith(XML_EXTENSION)) {
  48             // FIXME: BUG-7061: remove this once we do not need it
  49             LOG.warn("XML file {} being loaded as YIN", name);
  50             baseName = name.substring(0, name.length() - XML_EXTENSION.length());
  51         } else {
  52             throw new IllegalArgumentException("Filename " + name + " does not have a .yin or .xml extension");
  53         }
  54
  55         final Entry<String, String> parsed = YangNames.parseFilename(baseName);
  56         return RevisionSourceIdentifier.create(parsed.getKey(), Revision.ofNullable(parsed.getValue()));
  57     }
  58
  59     @Override
  60     public final SourceIdentifier getIdentifier() {
  61         return identifier;
  62     }
  63
  64     @Override
  65     public Class<? extends YinTextSchemaSource> getType() {
  66         return YinTextSchemaSource.class;
  67     }
  68
  69     @Override
  70     public final String toString() {
  71         return addToStringAttributes(MoreObjects.toStringHelper(this).add("identifier", identifier)).toString();
  72     }
  73
  74     /**
  75      * Add subclass-specific attributes to the output {@link #toString()} output. Since
  76      * subclasses are prevented from overriding {@link #toString()} for consistency
  77      * reasons, they can add their specific attributes to the resulting string by attaching
  78      * attributes to the supplied {@link ToStringHelper}.
  79      *
  80      * @param toStringHelper ToStringHelper onto the attributes can be added
  81      * @return ToStringHelper supplied as input argument.
  82      */
  83     protected abstract ToStringHelper addToStringAttributes(@NonNull ToStringHelper toStringHelper);
  84
  85     /**
  86      * Create a new YinTextSchemaSource with a specific source identifier and backed
  87      * by ByteSource, which provides the actual InputStreams.
  88      *
  89      * @param identifier SourceIdentifier of the resulting schema source
  90      * @param delegate Backing ByteSource instance
  91      * @return A new YinTextSchemaSource
  92      */
  93     public static @NonNull YinTextSchemaSource delegateForByteSource(final SourceIdentifier identifier,
  94             final ByteSource delegate) {
  95         return new DelegatedYinTextSchemaSource(identifier, delegate);
  96     }
  97
  98     public static @NonNull YinTextSchemaSource forPath(final Path path) {
  99         checkArgument(Files.isRegularFile(path), "Supplied path %s is not a regular file", path);
 100         return new YinTextFileSchemaSource(identifierFromFilename(path.toFile().getName()), path);
 101     }
 102
 103     public static @NonNull YinTextSchemaSource forResource(final Class<?> clazz, final String resourceName) {
 104         final String fileName = resourceName.substring(resourceName.lastIndexOf('/') + 1);
 105         return new ResourceYinTextSchemaSource(identifierFromFilename(fileName),
 106             Resources.getResource(clazz, resourceName));
 107     }
 108 }