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