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.AugmentIdentifierStatementSupport;
  13 import org.opendaylight.yangtools.odlext.parser.ContextInstanceStatementSupport;
  14 import org.opendaylight.yangtools.odlext.parser.ContextReferenceStatementSupport;
  15 import org.opendaylight.yangtools.odlext.parser.InstanceTargetStatementSupport;
  16 import org.opendaylight.yangtools.odlext.parser.RpcContextReferenceStatementSupport;
  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.ImpliedStatementSupport;
  26 import org.opendaylight.yangtools.rfc6643.parser.MaxAccessStatementSupport;
  27 import org.opendaylight.yangtools.rfc6643.parser.OidStatementSupport;
  28 import org.opendaylight.yangtools.rfc6643.parser.SubIdStatementSupport;
  29 import org.opendaylight.yangtools.rfc7952.parser.AnnotationStatementSupport;
  30 import org.opendaylight.yangtools.rfc8040.parser.YangDataArgumentNamespace;
  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 import org.opendaylight.yangtools.yang.xpath.api.YangXPathParserFactory;
  39
  40 /**
  41  * Utility class for instantiating default-configured {@link CrossSourceStatementReactor}s.
  42  *
  43  * @author Robert Varga
  44  */
  45 @Beta
  46 public final class DefaultReactors {
  47     private static final class DefaultReactor {
  48         // Thread-safe lazy init
  49         static final @NonNull CrossSourceStatementReactor INSTANCE = defaultReactorBuilder().build();
  50     }
  51
  52     private DefaultReactors() {
  53         // Hidden on purpose
  54     }
  55
  56     /**
  57      * Get a shared default-configured reactor instance. This instance is configured to handle both RFC6020 and RFC7950,
  58      * as well as
  59      * <ul>
  60      * <li>RFC6536's default-deny-{all,write} extensions</li>
  61      * <li>RFC7952's annotation extension</li>
  62      * <li>RFC8040's yang-data extension</li>
  63      * <li>OpenConfig extensions</li>
  64      * <li>OpenDaylight extensions</li>
  65      * </ul>
  66      *
  67      * @return a shared default-configured reactor instance.
  68      */
  69     public static @NonNull CrossSourceStatementReactor defaultReactor() {
  70         return DefaultReactor.INSTANCE;
  71     }
  72
  73     /**
  74      * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
  75      * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
  76      *
  77      * @return A populated CrossSourceStatementReactor builder.
  78      */
  79     public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
  80         return addExtensions(RFC7950Reactors.defaultReactorBuilder());
  81     }
  82
  83     /**
  84      * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
  85      * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
  86      *
  87      * @return A populated CrossSourceStatementReactor builder.
  88      */
  89     public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder(
  90             final YangXPathParserFactory xpathFactory) {
  91         return addExtensions(RFC7950Reactors.defaultReactorBuilder(xpathFactory));
  92     }
  93
  94     private static @NonNull CustomCrossSourceStatementReactorBuilder addExtensions(
  95             final @NonNull CustomCrossSourceStatementReactorBuilder builder) {
  96         return builder
  97                 // OpenDaylight extensions
  98                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AugmentIdentifierStatementSupport.INSTANCE)
  99                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, ContextInstanceStatementSupport.INSTANCE)
 100                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, ContextReferenceStatementSupport.INSTANCE)
 101                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, InstanceTargetStatementSupport.INSTANCE)
 102                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 103                     RpcContextReferenceStatementSupport.INSTANCE)
 104
 105                 // RFC6241 get-filter-element-attributes support
 106                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 107                     GetFilterElementAttributesStatementSupport.getInstance())
 108
 109                 // RFC6536 default-deny-{all,write} support
 110                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 111                     DefaultDenyAllStatementSupport.getInstance())
 112                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 113                     DefaultDenyWriteStatementSupport.getInstance())
 114
 115                 // RFC6643 extensions
 116                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, DisplayHintStatementSupport.getInstance())
 117                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, MaxAccessStatementSupport.getInstance())
 118                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, DefValStatementSupport.getInstance())
 119                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, ImpliedStatementSupport.getInstance())
 120                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AliasStatementSupport.getInstance())
 121                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, OidStatementSupport.getInstance())
 122                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, SubIdStatementSupport.getInstance())
 123
 124                 // RFC7952 annotation support
 125                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AnnotationStatementSupport.getInstance())
 126
 127                 // RFC8040 yang-data support
 128                 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataArgumentNamespace.BEHAVIOUR)
 129                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataStatementSupport.getInstance())
 130
 131                 // RFC8528 yang-data support
 132                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, MountPointStatementSupport.getInstance())
 133
 134                 // OpenConfig extensions support (except openconfig-version)
 135                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 136                     EncryptedValueStatementSupport.getInstance())
 137                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
 138                     HashedValueStatementSupport.getInstance());
 139     }
 140 }