yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/DefaultReactors.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.yangtools.yang.parser.impl;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.treeScoped;
  11
  12 import com.google.common.annotations.Beta;
  13 import org.opendaylight.yangtools.openconfig.parser.EncryptedValueStatementSupport;
  14 import org.opendaylight.yangtools.openconfig.parser.HashedValueStatementSupport;
  15 import org.opendaylight.yangtools.rfc7952.parser.AnnotationStatementSupport;
  16 import org.opendaylight.yangtools.rfc8040.parser.YangDataStatementSupport;
  17 import org.opendaylight.yangtools.yang.parser.odlext.namespace.AnyxmlSchemaLocationNamespace;
  18 import org.opendaylight.yangtools.yang.parser.odlext.stmt.AnyxmlSchemaLocationSupport;
  19 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.CustomCrossSourceStatementReactorBuilder;
  20 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
  21 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  22 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  23 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.Builder;
  24
  25 /**
  26  * Utility class for instantiating default-configured {@link CrossSourceStatementReactor}s.
  27  *
  28  * @author Robert Varga
  29  */
  30 @Beta
  31 public final class DefaultReactors {
  32     private static final CrossSourceStatementReactor DEFAULT_REACTOR = defaultReactorBuilder().build();
  33
  34     private DefaultReactors() {
  35         throw new UnsupportedOperationException();
  36     }
  37
  38     /**
  39      * Get a shared default-configured reactor instance. This instance is configured to handle both RFC6020 and RFC7950,
  40      * as well as RFC8040's yang-data extension.
  41      *
  42      * @return a shared default-configured reactor instance.
  43      */
  44     public static CrossSourceStatementReactor defaultReactor() {
  45         return DEFAULT_REACTOR;
  46     }
  47
  48     /**
  49      * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
  50      * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
  51      *
  52      * @return A populated CrossSourceStatementReactor builder.
  53      */
  54     public static CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
  55         return RFC7950Reactors.defaultReactorBuilder()
  56                 // AnyxmlSchemaLocation support
  57                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AnyxmlSchemaLocationSupport.getInstance())
  58                 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION,
  59                     treeScoped(AnyxmlSchemaLocationNamespace.class))
  60
  61                 // RFC7952 annotation support
  62                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AnnotationStatementSupport.getInstance())
  63
  64                 // RFC8040 yang-data support
  65                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataStatementSupport.getInstance())
  66
  67                 // OpenConfig extensions support (except openconfig-version)
  68                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
  69                     EncryptedValueStatementSupport.getInstance())
  70                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
  71                     HashedValueStatementSupport.getInstance());
  72     }
  73 }