yang/yang-model-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.File;
  19 import java.io.IOException;
  20 import java.io.InputStream;
  21 import java.net.URL;
  22 import java.util.Map.Entry;
  23 import java.util.Optional;
  24 import javax.annotation.Nonnull;
  25 import org.opendaylight.yangtools.concepts.Delegator;
  26 import org.opendaylight.yangtools.yang.common.YangConstants;
  27 import org.opendaylight.yangtools.yang.common.YangNames;
  28 import org.slf4j.Logger;
  29 import org.slf4j.LoggerFactory;
  30
  31 /**
  32  * YIN text schema source representation. Exposes an RFC6020 or RFC7950 XML representation as an {@link InputStream}.
  33  */
  34 @Beta
  35 public abstract class YinTextSchemaSource extends ByteSource implements YinSchemaSourceRepresentation {
  36     private static final Logger LOG = LoggerFactory.getLogger(YinTextSchemaSource.class);
  37     private static final String XML_EXTENSION = ".xml";
  38
  39     private final SourceIdentifier identifier;
  40
  41     protected YinTextSchemaSource(final SourceIdentifier identifier) {
  42         this.identifier = requireNonNull(identifier);
  43     }
  44
  45     public static SourceIdentifier identifierFromFilename(final String name) {
  46         final String baseName;
  47         if (name.endsWith(YangConstants.RFC6020_YIN_FILE_EXTENSION)) {
  48             baseName = name.substring(0, name.length() - YangConstants.RFC6020_YIN_FILE_EXTENSION.length());
  49         } else if (name.endsWith(XML_EXTENSION)) {
  50             // FIXME: BUG-7061: remove this once we do not need it
  51             LOG.warn("XML file {} being loaded as YIN", name);
  52             baseName = name.substring(0, name.length() - XML_EXTENSION.length());
  53         } else {
  54             throw new IllegalArgumentException("Filename " + name + " does not have a .yin or .xml extension");
  55         }
  56
  57         final Entry<String, String> parsed = YangNames.parseFilename(baseName);
  58         return RevisionSourceIdentifier.create(parsed.getKey(), Optional.ofNullable(parsed.getValue()));
  59     }
  60
  61     @Override
  62     public final SourceIdentifier getIdentifier() {
  63         return identifier;
  64     }
  65
  66     @Nonnull
  67     @Override
  68     public Class<? extends YinTextSchemaSource> getType() {
  69         return YinTextSchemaSource.class;
  70     }
  71
  72     @Override
  73     public final String toString() {
  74         return addToStringAttributes(MoreObjects.toStringHelper(this).add("identifier", identifier)).toString();
  75     }
  76
  77     /**
  78      * Add subclass-specific attributes to the output {@link #toString()} output. Since
  79      * subclasses are prevented from overriding {@link #toString()} for consistency
  80      * reasons, they can add their specific attributes to the resulting string by attaching
  81      * attributes to the supplied {@link ToStringHelper}.
  82      *
  83      * @param toStringHelper ToStringHelper onto the attributes can be added
  84      * @return ToStringHelper supplied as input argument.
  85      */
  86     protected abstract ToStringHelper addToStringAttributes(ToStringHelper toStringHelper);
  87
  88     /**
  89      * Create a new YinTextSchemaSource with a specific source identifier and backed
  90      * by ByteSource, which provides the actual InputStreams.
  91      *
  92      * @param identifier SourceIdentifier of the resulting schema source
  93      * @param delegate Backing ByteSource instance
  94      * @return A new YinTextSchemaSource
  95      */
  96     public static YinTextSchemaSource delegateForByteSource(final SourceIdentifier identifier,
  97             final ByteSource delegate) {
  98         return new DelegatedYinTextSchemaSource(identifier, delegate);
  99     }
 100
 101     public static YinTextSchemaSource forFile(final File file) {
 102         checkArgument(file.isFile(), "Supplied file %s is not a file", file);
 103         return new YinTextFileSchemaSource(identifierFromFilename(file.getName()), file);
 104     }
 105
 106     public static YinTextSchemaSource forResource(final Class<?> clazz, final String resourceName) {
 107         final String fileName = resourceName.substring(resourceName.lastIndexOf('/') + 1);
 108         final SourceIdentifier identifier = identifierFromFilename(fileName);
 109         final URL url = Resources.getResource(clazz, resourceName);
 110         return new ResourceYinTextSchemaSource(identifier, url);
 111     }
 112
 113     private static final class DelegatedYinTextSchemaSource extends YinTextSchemaSource
 114             implements Delegator<ByteSource> {
 115         private final ByteSource delegate;
 116
 117         private DelegatedYinTextSchemaSource(final SourceIdentifier identifier, final ByteSource delegate) {
 118             super(identifier);
 119             this.delegate = requireNonNull(delegate);
 120         }
 121
 122         @Override
 123         public ByteSource getDelegate() {
 124             return delegate;
 125         }
 126
 127         @Override
 128         public InputStream openStream() throws IOException {
 129             return delegate.openStream();
 130         }
 131
 132         @Override
 133         protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 134             return toStringHelper.add("delegate", delegate);
 135         }
 136     }
 137 }