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