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