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