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