Deprecate public InstanceIdentifierContext

[netconf.git] / restconf / restconf-nb-bierman02 / src / main / java / org / opendaylight / netconf / sal / restconf / impl / ControllerContext.java

diff --git a/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/impl/ControllerContext.java b/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/impl/ControllerContext.java
index bf0f2ebbb045fc71139b7e7c022642110f3e90d8..6c338cc1c03a33b0934b1fbac137b110279d981f 100644 (file)
--- a/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/impl/ControllerContext.java
+++ b/restconf/restconf-nb-bierman02/src/main/java/org/opendaylight/netconf/sal/restconf/impl/ControllerContext.java
@@ -35,7 +35,6 @@ import javax.annotation.PreDestroy;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import javax.ws.rs.core.Response.Status;
-import org.apache.aries.blueprint.annotation.service.Reference;
 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
@@ -44,11 +43,11 @@ import org.opendaylight.netconf.sal.rest.api.Draft02;
 import org.opendaylight.netconf.sal.rest.api.Draft02.RestConfModule;
 import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
 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.RestUtil;
 import org.opendaylight.yangtools.concepts.IllegalArgumentCodec;
 import org.opendaylight.yangtools.concepts.ListenerRegistration;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.Revision;
 import org.opendaylight.yangtools.yang.common.XMLNamespace;
@@ -103,10 +102,10 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     private volatile DataNormalizer dataNormalizer;
 
     @Inject
-    public ControllerContext(final @Reference DOMSchemaService schemaService,
-            final @Reference DOMMountPointService mountService, final @Reference DOMSchemaService domSchemaService) {
+    public ControllerContext(final DOMSchemaService schemaService, final DOMMountPointService mountService,
+            final DOMSchemaService domSchemaService) {
         this.mountService = mountService;
-        this.yangTextSourceProvider = domSchemaService.getExtensions().getInstance(DOMYangTextSourceProvider.class);
+        yangTextSourceProvider = domSchemaService.getExtensions().getInstance(DOMYangTextSourceProvider.class);
 
         onModelContextUpdated(schemaService.getGlobalContext());
         listenerRegistration = schemaService.registerSchemaContextListener(this);
@@ -127,7 +126,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
 
     private void setGlobalSchema(final EffectiveModelContext globalSchema) {
         this.globalSchema = globalSchema;
-        this.dataNormalizer = new DataNormalizer(globalSchema);
+        dataNormalizer = new DataNormalizer(globalSchema);
     }
 
     public DOMYangTextSourceProvider getYangTextSourceProvider() {
@@ -135,7 +134,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     }
 
     private void checkPreconditions() {
-        if (this.globalSchema == null) {
+        if (globalSchema == null) {
             throw new RestconfDocumentedException(Status.SERVICE_UNAVAILABLE);
         }
     }
@@ -150,25 +149,24 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         onModelContextUpdated(schemas);
     }
 
-    public InstanceIdentifierContext<?> toInstanceIdentifier(final String restconfInstance) {
+    public InstanceIdentifierContext toInstanceIdentifier(final String restconfInstance) {
         return toIdentifier(restconfInstance, false);
     }
 
     public EffectiveModelContext getGlobalSchema() {
-        return this.globalSchema;
+        return globalSchema;
     }
 
-    public InstanceIdentifierContext<?> toMountPointIdentifier(final String restconfInstance) {
+    public InstanceIdentifierContext toMountPointIdentifier(final String restconfInstance) {
         return toIdentifier(restconfInstance, true);
     }
 
-    private InstanceIdentifierContext<?> toIdentifier(final String restconfInstance,
-                                                      final boolean toMountPointIdentifier) {
+    private InstanceIdentifierContext toIdentifier(final String restconfInstance,
+                                                   final boolean toMountPointIdentifier) {
         checkPreconditions();
 
         if (restconfInstance == null) {
-            return new InstanceIdentifierContext<>(YangInstanceIdentifier.empty(), this.globalSchema, null,
-                    this.globalSchema);
+            return InstanceIdentifierContext.ofLocalRoot(globalSchema);
         }
 
         final List<String> pathArgs = urlPathArgsDecode(SLASH_SPLITTER.split(restconfInstance));
@@ -185,14 +183,14 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         }
 
         final InstanceIdentifierBuilder builder = YangInstanceIdentifier.builder();
-        final Collection<? extends Module> latestModule = this.globalSchema.findModules(startModule);
+        final Collection<? extends Module> latestModule = globalSchema.findModules(startModule);
 
         if (latestModule.isEmpty()) {
             throw new RestconfDocumentedException("The module named '" + startModule + "' does not exist.",
                     ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
         }
 
-        final InstanceIdentifierContext<?> iiWithSchemaNode =
+        final InstanceIdentifierContext iiWithSchemaNode =
                 collectPathArguments(builder, pathArgs, latestModule.iterator().next(), null, toMountPointIdentifier);
 
         if (iiWithSchemaNode == null) {
@@ -227,7 +225,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     public Module findModuleByName(final String moduleName) {
         checkPreconditions();
         checkArgument(moduleName != null && !moduleName.isEmpty());
-        return this.globalSchema.findModules(moduleName).stream().findFirst().orElse(null);
+        return globalSchema.findModules(moduleName).stream().findFirst().orElse(null);
     }
 
     public static Module findModuleByName(final DOMMountPoint mountPoint, final String moduleName) {
@@ -241,7 +239,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     public Module findModuleByNamespace(final XMLNamespace namespace) {
         checkPreconditions();
         checkArgument(namespace != null);
-        return this.globalSchema.findModules(namespace).stream().findFirst().orElse(null);
+        return globalSchema.findModules(namespace).stream().findFirst().orElse(null);
     }
 
     public static Module findModuleByNamespace(final DOMMountPoint mountPoint, final XMLNamespace namespace) {
@@ -256,7 +254,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         checkPreconditions();
         checkArgument(name != null && revision != null);
 
-        return this.globalSchema.findModule(name, revision).orElse(null);
+        return globalSchema.findModule(name, revision).orElse(null);
     }
 
     public Module findModuleByNameAndRevision(final DOMMountPoint mountPoint, final String name,
@@ -274,7 +272,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         final Iterable<PathArgument> elements = path.getPathArguments();
         final PathArgument head = elements.iterator().next();
         final QName startQName = head.getNodeType();
-        final Module initialModule = this.globalSchema.findModule(startQName.getModule()).orElse(null);
+        final Module initialModule = globalSchema.findModule(startQName.getModule()).orElse(null);
         DataNodeContainer node = initialModule;
         for (final PathArgument element : elements) {
             final QName _nodeType = element.getNodeType();
@@ -299,7 +297,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         if (mount != null) {
             schemaContext = getModelContext(mount);
         } else {
-            schemaContext = this.globalSchema;
+            schemaContext = globalSchema;
         }
         final Module initialModule = schemaContext.findModule(startQName.getModule()).orElse(null);
         DataNodeContainer node = initialModule;
@@ -327,8 +325,8 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         return module == null ? null : module.getName();
     }
 
-    public String findModuleNameByNamespace(final DOMMountPoint mountPoint, final XMLNamespace namespace) {
-        final Module module = this.findModuleByNamespace(mountPoint, namespace);
+    public static String findModuleNameByNamespace(final DOMMountPoint mountPoint, final XMLNamespace namespace) {
+        final Module module = findModuleByNamespace(mountPoint, namespace);
         return module == null ? null : module.getName();
     }
 
@@ -337,8 +335,8 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         return module == null ? null : module.getNamespace();
     }
 
-    public XMLNamespace findNamespaceByModuleName(final DOMMountPoint mountPoint, final String moduleName) {
-        final Module module = this.findModuleByName(mountPoint, moduleName);
+    public static XMLNamespace findNamespaceByModuleName(final DOMMountPoint mountPoint, final String moduleName) {
+        final Module module = findModuleByName(mountPoint, moduleName);
         return module == null ? null : module.getNamespace();
     }
 
@@ -351,7 +349,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
 
     public Collection<? extends Module> getAllModules() {
         checkPreconditions();
-        return this.globalSchema.getModules();
+        return globalSchema.getModules();
     }
 
     private static String toRestconfIdentifier(final EffectiveModelContext context, final QName qname) {
@@ -367,7 +365,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     public String toRestconfIdentifier(final QName qname) {
         checkPreconditions();
 
-        return toRestconfIdentifier(this.globalSchema, qname);
+        return toRestconfIdentifier(globalSchema, qname);
     }
 
     public static String toRestconfIdentifier(final DOMMountPoint mountPoint, final QName qname) {
@@ -463,7 +461,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     }
 
     private static DataSchemaNode childByQName(final CaseSchemaNode container, final QName name) {
-        return container.getDataChildByName(name);
+        return container.dataChildByName(name);
     }
 
     private static DataSchemaNode childByQName(final ContainerSchemaNode container, final QName name) {
@@ -503,7 +501,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     }
 
     private static DataSchemaNode dataNodeChildByQName(final DataNodeContainer container, final QName name) {
-        final DataSchemaNode ret = container.getDataChildByName(name);
+        final DataSchemaNode ret = container.dataChildByName(name);
         if (ret == null) {
             for (final DataSchemaNode node : container.getChildNodes()) {
                 if (node instanceof ChoiceSchemaNode) {
@@ -525,7 +523,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     }
 
     @SuppressFBWarnings(value = "RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE", justification = "Unrecognised NullableDecl")
-    private InstanceIdentifierContext<?> collectPathArguments(final InstanceIdentifierBuilder builder,
+    private InstanceIdentifierContext collectPathArguments(final InstanceIdentifierBuilder builder,
             final List<String> strings, final DataNodeContainer parentNode, final DOMMountPoint mountPoint,
             final boolean returnJustMountPoint) {
         requireNonNull(strings);
@@ -536,7 +534,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
 
         if (strings.isEmpty()) {
             return createContext(builder.build(), (DataSchemaNode) parentNode, mountPoint,
-                mountPoint != null ? getModelContext(mountPoint) : this.globalSchema);
+                mountPoint != null ? getModelContext(mountPoint) : globalSchema);
         }
 
         final String head = strings.iterator().next();
@@ -557,14 +555,14 @@ public final class ControllerContext implements EffectiveModelContextListener, C
                             ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED);
                 }
 
-                if (this.mountService == null) {
+                if (mountService == null) {
                     throw new RestconfDocumentedException(
                             "MountService was not found. Finding behind mount points does not work.",
                             ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED);
                 }
 
-                final YangInstanceIdentifier partialPath = this.dataNormalizer.toNormalized(builder.build());
-                final Optional<DOMMountPoint> mountOpt = this.mountService.getMountPoint(partialPath);
+                final YangInstanceIdentifier partialPath = dataNormalizer.toNormalized(builder.build());
+                final Optional<DOMMountPoint> mountOpt = mountService.getMountPoint(partialPath);
                 if (mountOpt.isEmpty()) {
                     LOG.debug("Instance identifier to missing mount point: {}", partialPath);
                     throw new RestconfDocumentedException("Mount point does not exist.", ErrorType.PROTOCOL,
@@ -579,8 +577,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
                 }
 
                 if (returnJustMountPoint || strings.size() == 1) {
-                    return new InstanceIdentifierContext<>(YangInstanceIdentifier.empty(), mountPointSchema, mount,
-                        mountPointSchema);
+                    return InstanceIdentifierContext.ofMountPointRoot(mount, mountPointSchema);
                 }
 
                 final String moduleNameBehindMountPoint = toModuleName(strings.get(1));
@@ -605,7 +602,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
             Module module = null;
             if (mountPoint == null) {
                 checkPreconditions();
-                module = this.globalSchema.findModules(moduleName).stream().findFirst().orElse(null);
+                module = globalSchema.findModules(moduleName).stream().findFirst().orElse(null);
                 if (module == null) {
                     throw new RestconfDocumentedException("\"" + moduleName + "\" module does not exist.",
                             ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
@@ -634,8 +631,8 @@ public final class ControllerContext implements EffectiveModelContextListener, C
                     rpc = getRpcDefinition(module, rpcName);
                 }
                 if (rpc != null) {
-                    return new InstanceIdentifierContext<>(builder.build(), rpc, mountPoint,
-                            mountPoint != null ? getModelContext(mountPoint) : this.globalSchema);
+                    return new InstanceIdentifierContext(builder.build(), rpc, mountPoint,
+                            mountPoint != null ? getModelContext(mountPoint) : globalSchema);
                 }
             }
 
@@ -714,14 +711,14 @@ public final class ControllerContext implements EffectiveModelContextListener, C
         }
 
         return createContext(builder.build(), targetNode, mountPoint,
-            mountPoint != null ? getModelContext(mountPoint) : this.globalSchema);
+            mountPoint != null ? getModelContext(mountPoint) : globalSchema);
     }
 
-    private static InstanceIdentifierContext<?> createContext(final YangInstanceIdentifier instance,
+    private static InstanceIdentifierContext createContext(final YangInstanceIdentifier instance,
             final DataSchemaNode dataSchemaNode, final DOMMountPoint mountPoint,
             final EffectiveModelContext schemaContext) {
         final YangInstanceIdentifier instanceIdentifier = new DataNormalizer(schemaContext).toNormalized(instance);
-        return new InstanceIdentifierContext<>(instanceIdentifier, dataSchemaNode, mountPoint, schemaContext);
+        return new InstanceIdentifierContext(instanceIdentifier, dataSchemaNode, mountPoint, schemaContext);
     }
 
     public static DataSchemaNode findInstanceDataChildByNameAndNamespace(final DataNodeContainer container,
@@ -851,13 +848,13 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     }
 
     public RpcDefinition getRpcDefinition(final String name, final Optional<Revision> revisionDate) {
-        final QName validName = toQName(this.globalSchema, name, revisionDate);
-        return validName == null ? null : this.qnameToRpc.get().get(validName);
+        final QName validName = toQName(globalSchema, name, revisionDate);
+        return validName == null ? null : qnameToRpc.get().get(validName);
     }
 
     public RpcDefinition getRpcDefinition(final String name) {
-        final QName validName = toQName(this.globalSchema, name);
-        return validName == null ? null : this.qnameToRpc.get().get(validName);
+        final QName validName = toQName(globalSchema, name);
+        return validName == null ? null : qnameToRpc.get().get(validName);
     }
 
     private static RpcDefinition getRpcDefinition(final Module module, final String rpcName) {
@@ -881,7 +878,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
             }
 
             // FIXME: still not completely atomic
-            this.qnameToRpc.set(ImmutableMap.copyOf(newMap));
+            qnameToRpc.set(ImmutableMap.copyOf(newMap));
             setGlobalSchema(context);
         }
     }
@@ -958,7 +955,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
 
     public YangInstanceIdentifier toNormalized(final YangInstanceIdentifier legacy) {
         try {
-            return this.dataNormalizer.toNormalized(legacy);
+            return dataNormalizer.toNormalized(legacy);
         } catch (final NullPointerException e) {
             throw new RestconfDocumentedException("Data normalizer isn't set. Normalization isn't possible", e);
         }
@@ -966,7 +963,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
 
     public YangInstanceIdentifier toXpathRepresentation(final YangInstanceIdentifier instanceIdentifier) {
         try {
-            return this.dataNormalizer.toLegacy(instanceIdentifier);
+            return dataNormalizer.toLegacy(instanceIdentifier);
         } catch (final NullPointerException e) {
             throw new RestconfDocumentedException("Data normalizer isn't set. Normalization isn't possible", e);
         } catch (final DataNormalizationException e) {
@@ -977,7 +974,7 @@ public final class ControllerContext implements EffectiveModelContextListener, C
     public boolean isNodeMixin(final YangInstanceIdentifier path) {
         final DataNormalizationOperation<?> operation;
         try {
-            operation = this.dataNormalizer.getOperation(path);
+            operation = dataNormalizer.getOperation(path);
         } catch (final DataNormalizationException e) {
             throw new RestconfDocumentedException("Data normalizer failed. Normalization isn't possible", e);
         }