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