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