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.sourceLocal;
  11
  12 import com.google.common.annotations.Beta;
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.opendaylight.yangtools.odlext.parser.AnyxmlSchemaLocationNamespace;
  15 import org.opendaylight.yangtools.odlext.parser.AnyxmlSchemaLocationStatementSupport;
  16 import org.opendaylight.yangtools.odlext.parser.AnyxmlStatementSupportOverride;
  17 import org.opendaylight.yangtools.openconfig.parser.EncryptedValueStatementSupport;
  18 import org.opendaylight.yangtools.openconfig.parser.HashedValueStatementSupport;
  19 import org.opendaylight.yangtools.rfc6241.parser.GetFilterElementAttributesStatementSupport;
  20 import org.opendaylight.yangtools.rfc6536.parser.DefaultDenyAllStatementSupport;
  21 import org.opendaylight.yangtools.rfc6536.parser.DefaultDenyWriteStatementSupport;
  22 import org.opendaylight.yangtools.rfc6643.parser.AliasStatementSupport;
  23 import org.opendaylight.yangtools.rfc6643.parser.DefValStatementSupport;
  24 import org.opendaylight.yangtools.rfc6643.parser.DisplayHintStatementSupport;
  25 import org.opendaylight.yangtools.rfc6643.parser.IetfYangSmiv2Namespace;
  26 import org.opendaylight.yangtools.rfc6643.parser.ImpliedStatementSupport;
  27 import org.opendaylight.yangtools.rfc6643.parser.MaxAccessStatementSupport;
  28 import org.opendaylight.yangtools.rfc6643.parser.OidStatementSupport;
  29 import org.opendaylight.yangtools.rfc6643.parser.SubIdStatementSupport;
  30 import org.opendaylight.yangtools.rfc7952.parser.AnnotationStatementSupport;
  31 import org.opendaylight.yangtools.rfc8040.parser.YangDataStatementSupport;
  32 import org.opendaylight.yangtools.rfc8528.parser.MountPointStatementSupport;
  33 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.CustomCrossSourceStatementReactorBuilder;
  34 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  36 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  37 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.Builder;
  38
  39 /**
  40  * Utility class for instantiating default-configured {@link CrossSourceStatementReactor}s.
  41  *
  42  * @author Robert Varga
  43  */
  44 @Beta
  45 public final class DefaultReactors {
  46     private static final @NonNull CrossSourceStatementReactor DEFAULT_REACTOR = defaultReactorBuilder().build();
  47
  48     private DefaultReactors() {
  49         // Hidden on purpose
  50     }
  51
  52     /**
  53      * Get a shared default-configured reactor instance. This instance is configured to handle both RFC6020 and RFC7950,
  54      * as well as
  55      * <ul>
  56      * <li>RFC6536's default-deny-{all,write} extensions</li>
  57      * <li>RFC7952's annotation extension</li>
  58      * <li>RFC8040's yang-data extension</li>
  59      * <li>OpenConfig extensions</li>
  60      * <li>OpenDaylight extensions</li>
  61      * </ul>
  62      *
  63      * @return a shared default-configured reactor instance.
  64      */
  65     public static @NonNull CrossSourceStatementReactor defaultReactor() {
  66         return DEFAULT_REACTOR;
  67     }
  68
  69     /**
  70      * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
  71      * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
  72      *
  73      * @return A populated CrossSourceStatementReactor builder.
  74      */
  75     public static CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
  76         return RFC7950Reactors.defaultReactorBuilder()
  77                 // AnyxmlSchemaLocation support
  78                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
  79                     AnyxmlSchemaLocationStatementSupport.getInstance())
  80                 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION, AnyxmlSchemaLocationNamespace.BEHAVIOUR)
  81                 .overrideStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
  82                     AnyxmlStatementSupportOverride.getInstance())
  83
  84                 // RFC6241 get-filter-element-attributes support
  85                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
  86                     GetFilterElementAttributesStatementSupport.getInstance())
  87
  88                 // RFC6536 default-deny-{all,write} support
  89                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
  90                     DefaultDenyAllStatementSupport.getInstance())
  91                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
  92                     DefaultDenyWriteStatementSupport.getInstance())
  93
  94                 // RFC6643 extensions
  95                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, DisplayHintStatementSupport.getInstance())
  96                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, MaxAccessStatementSupport.getInstance())
  97                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, DefValStatementSupport.getInstance())
  98                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, ImpliedStatementSupport.getInstance())
  99                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AliasStatementSupport.getInstance())
 100                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, OidStatementSupport.getInstance())
 101                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, SubIdStatementSupport.getInstance())
 102                 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION, sourceLocal(IetfYangSmiv2Namespace.class))
 103
 104                 // RFC7952 annotation support
 105                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AnnotationStatementSupport.getInstance())
 106
 107                 // RFC8040 yang-data support
 108                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataStatementSupport.getInstance())
 109
 110                 // RFC8528 yang-data support
 111                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, MountPointStatementSupport.getInstance())
 112
 113                 // OpenConfig extensions support (except openconfig-version)
 114                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 115                     EncryptedValueStatementSupport.getInstance())
 116                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 117                     HashedValueStatementSupport.getInstance());
 118     }
 119 }