2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.impl;
10 import static org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.sourceLocal;
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 import org.opendaylight.yangtools.yang.xpath.api.YangXPathParserFactory;
41 * Utility class for instantiating default-configured {@link CrossSourceStatementReactor}s.
43 * @author Robert Varga
46 public final class DefaultReactors {
47 private static final class DefaultReactor {
48 // Thread-safe lazy init
49 static final @NonNull CrossSourceStatementReactor INSTANCE = defaultReactorBuilder().build();
52 private DefaultReactors() {
57 * Get a shared default-configured reactor instance. This instance is configured to handle both RFC6020 and RFC7950,
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>
67 * @return a shared default-configured reactor instance.
69 public static @NonNull CrossSourceStatementReactor defaultReactor() {
70 return DefaultReactor.INSTANCE;
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.
77 * @return A populated CrossSourceStatementReactor builder.
79 public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
80 return addExtensions(RFC7950Reactors.defaultReactorBuilder());
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.
87 * @return A populated CrossSourceStatementReactor builder.
89 public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder(
90 final YangXPathParserFactory xpathFactory) {
91 return addExtensions(RFC7950Reactors.defaultReactorBuilder(xpathFactory));
94 private static @NonNull CustomCrossSourceStatementReactorBuilder addExtensions(
95 final @NonNull CustomCrossSourceStatementReactorBuilder builder) {
97 // AnyxmlSchemaLocation support
98 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
99 AnyxmlSchemaLocationStatementSupport.getInstance())
100 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION, AnyxmlSchemaLocationNamespace.BEHAVIOUR)
101 .overrideStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
102 AnyxmlStatementSupportOverride.getInstance())
104 // RFC6241 get-filter-element-attributes support
105 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
106 GetFilterElementAttributesStatementSupport.getInstance())
108 // RFC6536 default-deny-{all,write} support
109 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
110 DefaultDenyAllStatementSupport.getInstance())
111 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
112 DefaultDenyWriteStatementSupport.getInstance())
114 // RFC6643 extensions
115 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, DisplayHintStatementSupport.getInstance())
116 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, MaxAccessStatementSupport.getInstance())
117 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, DefValStatementSupport.getInstance())
118 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, ImpliedStatementSupport.getInstance())
119 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AliasStatementSupport.getInstance())
120 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, OidStatementSupport.getInstance())
121 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, SubIdStatementSupport.getInstance())
122 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION, sourceLocal(IetfYangSmiv2Namespace.class))
124 // RFC7952 annotation support
125 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AnnotationStatementSupport.getInstance())
127 // RFC8040 yang-data support
128 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataStatementSupport.getInstance())
130 // RFC8528 yang-data support
131 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, MountPointStatementSupport.getInstance())
133 // OpenConfig extensions support (except openconfig-version)
134 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
135 EncryptedValueStatementSupport.getInstance())
136 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
137 HashedValueStatementSupport.getInstance());