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