dom/mdsal-dom-spi/src/main/java/org/opendaylight/mdsal/dom/spi/FixedDOMSchemaService.java

   1 /*
   2  * Copyright (c) 2019 Red Hat, 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.mdsal.dom.spi;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import java.util.List;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  17 import org.opendaylight.mdsal.dom.api.DOMYangTextSourceProvider;
  18 import org.opendaylight.yangtools.concepts.Registration;
  19 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  20 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
  21 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextProvider;
  22 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  23 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  24 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  25
  26 /**
  27  * {@link DOMSchemaService} (and {@link DOMYangTextSourceProvider}) implementations backed by a
  28  * {@link EffectiveModelContextProvider} (and {@link SchemaSourceProvider}) which are known to be fixed and never change
  29  * schemas.
  30  *
  31  * @author Michael Vorburger.ch
  32  */
  33 @Beta
  34 public class FixedDOMSchemaService extends AbstractDOMSchemaService {
  35     private static final class WithYangTextSources extends FixedDOMSchemaService implements DOMYangTextSourceProvider {
  36         private final @NonNull SchemaSourceProvider<YangTextSchemaSource> schemaSourceProvider;
  37
  38         WithYangTextSources(final EffectiveModelContextProvider schemaContextProvider,
  39                 final SchemaSourceProvider<YangTextSchemaSource> schemaSourceProvider) {
  40             super(schemaContextProvider);
  41             this.schemaSourceProvider = requireNonNull(schemaSourceProvider);
  42         }
  43
  44         @Override
  45         public List<Extension> supportedExtensions() {
  46             return List.of(this);
  47         }
  48
  49         @Override
  50         public ListenableFuture<? extends YangTextSchemaSource> getSource(final SourceIdentifier sourceIdentifier) {
  51             return schemaSourceProvider.getSource(sourceIdentifier);
  52         }
  53     }
  54
  55     private final @NonNull EffectiveModelContextProvider schemaContextProvider;
  56
  57     private FixedDOMSchemaService(final EffectiveModelContextProvider schemaContextProvider) {
  58         this.schemaContextProvider = requireNonNull(schemaContextProvider);
  59     }
  60
  61     public static @NonNull DOMSchemaService of(final EffectiveModelContext effectiveModel) {
  62         final var checked = requireNonNull(effectiveModel);
  63         return of(() -> checked);
  64     }
  65
  66     public static @NonNull DOMSchemaService of(final EffectiveModelContextProvider schemaContextProvider) {
  67         return new FixedDOMSchemaService(schemaContextProvider);
  68     }
  69
  70     public static @NonNull DOMSchemaService of(final EffectiveModelContextProvider schemaContextProvider,
  71             final SchemaSourceProvider<YangTextSchemaSource> yangTextSourceProvider) {
  72         return new WithYangTextSources(schemaContextProvider, requireNonNull(yangTextSourceProvider));
  73     }
  74
  75     @Override
  76     public final @NonNull EffectiveModelContext getGlobalContext() {
  77         return schemaContextProvider.getEffectiveModelContext();
  78     }
  79
  80     @Override
  81     public final Registration registerSchemaContextListener(final EffectiveModelContextListener listener) {
  82         listener.onModelContextUpdated(getGlobalContext());
  83         return () -> { };
  84     }
  85 }