Bug 8153: Enforce check-style rules for netconf - sal-netconf-connector

[netconf.git] / netconf / sal-netconf-connector / src / main / java / org / opendaylight / netconf / sal / connect / netconf / schema / NetconfRemoteSchemaYangSourceProvider.java

diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/schema/NetconfRemoteSchemaYangSourceProvider.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/schema/NetconfRemoteSchemaYangSourceProvider.java
index 3a65ce74324f2b7c80e277085e2a86f4279e991a..6bb12e7e4b19e083bf6aa6c0748f7c36375650c2 100644 (file)
--- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/schema/NetconfRemoteSchemaYangSourceProvider.java
+++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/schema/NetconfRemoteSchemaYangSourceProvider.java
@@ -11,7 +11,6 @@ import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTr
 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_QNAME;
 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
 
-import com.google.common.base.Charsets;
 import com.google.common.base.Function;
 import com.google.common.base.MoreObjects;
 import com.google.common.base.Optional;
@@ -22,6 +21,7 @@ import com.google.common.util.concurrent.ListenableFuture;
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
 import javax.xml.transform.dom.DOMSource;
 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
 import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
@@ -31,6 +31,7 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.mon
 import org.opendaylight.yangtools.util.concurrent.ExceptionMapper;
 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.schema.AnyXmlNode;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
@@ -54,8 +55,8 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
     private static final ExceptionMapper<SchemaSourceException> MAPPER = new ExceptionMapper<SchemaSourceException>(
             "schemaDownload", SchemaSourceException.class) {
         @Override
-        protected SchemaSourceException newWithCause(final String s, final Throwable throwable) {
-            return new SchemaSourceException(s, throwable);
+        protected SchemaSourceException newWithCause(final String message, final Throwable throwable) {
+            return new SchemaSourceException(message, throwable);
         }
     };
 
@@ -67,26 +68,31 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
         this.rpc = Preconditions.checkNotNull(rpc);
     }
 
-    public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
-        final QName identifierQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier"));
-        final YangInstanceIdentifier.NodeIdentifier identifierId = new YangInstanceIdentifier.NodeIdentifier(identifierQName);
-        final LeafNode<String> identifier = Builders.<String>leafBuilder().withNodeIdentifier(identifierId).withValue(moduleName).build();
-
-        final QName formatQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format"));
-        final YangInstanceIdentifier.NodeIdentifier formatId = new YangInstanceIdentifier.NodeIdentifier(formatQName);
-        final LeafNode<QName> format = Builders.<QName>leafBuilder().withNodeIdentifier(formatId).withValue(Yang.QNAME).build();
+    private static final NodeIdentifier FORMAT_PATHARG =
+            new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "format").intern());
+    private static final NodeIdentifier GET_SCHEMA_PATHARG =
+            new NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME);
+    private static final NodeIdentifier IDENTIFIER_PATHARG =
+            new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "identifier").intern());
+    private static final NodeIdentifier VERSION_PATHARG =
+            new NodeIdentifier(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version").intern());
 
-        final DataContainerNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> builder = Builders.containerBuilder();
+    private static final LeafNode<?> FORMAT_LEAF =
+            Builders.leafBuilder().withNodeIdentifier(FORMAT_PATHARG).withValue(Yang.QNAME).build();
 
-        builder.withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NetconfMessageTransformUtil.GET_SCHEMA_QNAME))
-                .withChild(identifier).withChild(format);
+    private static final QName NETCONF_DATA =
+            QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()).intern();
+    private static final NodeIdentifier NETCONF_DATA_PATHARG = toId(NETCONF_DATA);
 
-        if(revision.isPresent()) {
-            final QName revisionQName = QName.cachedReference(QName.create(NetconfMessageTransformUtil.GET_SCHEMA_QNAME, "version"));
-            final YangInstanceIdentifier.NodeIdentifier revisionId = new YangInstanceIdentifier.NodeIdentifier(revisionQName);
-            final LeafNode<String> revisionNode = Builders.<String>leafBuilder().withNodeIdentifier(revisionId).withValue(revision.get()).build();
-
-            builder.withChild(revisionNode);
+    public static ContainerNode createGetSchemaRequest(final String moduleName, final Optional<String> revision) {
+        final LeafNode<?> identifier =
+                Builders.leafBuilder().withNodeIdentifier(IDENTIFIER_PATHARG).withValue(moduleName).build();
+        final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = Builders.containerBuilder()
+                .withNodeIdentifier(GET_SCHEMA_PATHARG).withChild(identifier).withChild(FORMAT_LEAF);
+
+        if (revision.isPresent()) {
+            builder.withChild(Builders.leafBuilder()
+                    .withNodeIdentifier(VERSION_PATHARG).withValue(revision.get()).build());
         }
 
         return builder.build();
@@ -97,12 +103,12 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
             return Optional.absent();
         }
 
-        final QName schemaWrapperNode = QName.cachedReference(QName.create(GET_SCHEMA_QNAME, NETCONF_DATA_QNAME.getLocalName()));
-        final Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child = ((ContainerNode) result).getChild(toId(schemaWrapperNode));
+        final Optional<DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?>> child =
+                ((ContainerNode) result).getChild(NETCONF_DATA_PATHARG);
 
         Preconditions.checkState(child.isPresent() && child.get() instanceof AnyXmlNode,
                 "%s Unexpected response to get-schema, expected response with one child %s, but was %s", id,
-                schemaWrapperNode, result);
+                NETCONF_DATA, result);
 
         final DOMSource wrappedNode = ((AnyXmlNode) child.get()).getValue();
         Preconditions.checkNotNull(wrappedNode.getNode());
@@ -112,11 +118,13 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
     }
 
     @Override
-    public CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(final SourceIdentifier sourceIdentifier) {
+    public CheckedFuture<YangTextSchemaSource, SchemaSourceException> getSource(
+            final SourceIdentifier sourceIdentifier) {
         final String moduleName = sourceIdentifier.getName();
 
         // If formatted revision is SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION, we have to omit it from request
-        final String formattedRevision = sourceIdentifier.getRevision().equals(SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION) ? null : sourceIdentifier.getRevision();
+        final String badRev = sourceIdentifier.getRevision();
+        final String formattedRevision = SourceIdentifier.NOT_PRESENT_FORMATTED_REVISION.equals(badRev) ? null : badRev;
         final Optional<String> revision = Optional.fromNullable(formattedRevision);
         final NormalizedNode<?, ?> getSchemaRequest = createGetSchemaRequest(moduleName, revision);
 
@@ -127,13 +135,14 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
                 rpc.invokeRpc(SchemaPath.create(true, NetconfMessageTransformUtil.GET_SCHEMA_QNAME), getSchemaRequest),
                 new ResultToYangSourceTransformer(id, sourceIdentifier, moduleName, revision));
 
-        final CheckedFuture<YangTextSchemaSource, SchemaSourceException> checked = Futures.makeChecked(transformed, MAPPER);
+        final CheckedFuture<YangTextSchemaSource, SchemaSourceException> checked =
+                Futures.makeChecked(transformed, MAPPER);
 
         return checked;
     }
 
     /**
-     * Transform composite node to string schema representation and then to ASTSchemaSource
+     * Transform composite node to string schema representation and then to ASTSchemaSource.
      */
     private static final class ResultToYangSourceTransformer implements
             Function<DOMRpcResult, YangTextSchemaSource> {
@@ -143,7 +152,7 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
         private final String moduleName;
         private final Optional<String> revision;
 
-        public ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
+        ResultToYangSourceTransformer(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
                 final String moduleName, final Optional<String> revision) {
             this.id = id;
             this.sourceIdentifier = sourceIdentifier;
@@ -159,7 +168,8 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
                 final Optional<String> schemaString = getSchemaFromRpc(id, input.getResult());
 
                 Preconditions.checkState(schemaString.isPresent(),
-                        "%s: Unexpected response to get-schema, schema not present in message for: %s", id, sourceIdentifier);
+                        "%s: Unexpected response to get-schema, schema not present in message for: %s",
+                        id, sourceIdentifier);
 
                 LOG.debug("{}: YANG Schema successfully retrieved for {}:{}",
                         id, moduleName, revision);
@@ -181,8 +191,9 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
         private final RemoteDeviceId id;
         private final Optional<String> schemaString;
 
-        public NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sId, final Optional<String> schemaString) {
-            super(sId);
+        NetconfYangTextSchemaSource(final RemoteDeviceId id, final SourceIdentifier sourceIdentifier,
+                                           final Optional<String> schemaString) {
+            super(sourceIdentifier);
             this.id = id;
             this.schemaString = schemaString;
         }
@@ -194,7 +205,7 @@ public final class NetconfRemoteSchemaYangSourceProvider implements SchemaSource
 
         @Override
         public InputStream openStream() throws IOException {
-            return new ByteArrayInputStream(schemaString.get().getBytes(Charsets.UTF_8));
+            return new ByteArrayInputStream(schemaString.get().getBytes(StandardCharsets.UTF_8));
         }
     }
 }