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 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.openconfig.parser.OpenConfigVersionSupport;
20 import org.opendaylight.yangtools.rfc6241.parser.GetFilterElementAttributesStatementSupport;
21 import org.opendaylight.yangtools.rfc6536.parser.DefaultDenyAllStatementSupport;
22 import org.opendaylight.yangtools.rfc6536.parser.DefaultDenyWriteStatementSupport;
23 import org.opendaylight.yangtools.rfc6643.parser.AliasStatementSupport;
24 import org.opendaylight.yangtools.rfc6643.parser.DefValStatementSupport;
25 import org.opendaylight.yangtools.rfc6643.parser.DisplayHintStatementSupport;
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.YangDataArgumentNamespace;
32 import org.opendaylight.yangtools.rfc8040.parser.YangDataStatementSupport;
33 import org.opendaylight.yangtools.rfc8528.parser.MountPointStatementSupport;
34 import org.opendaylight.yangtools.rfc8639.parser.SubscriptionStateNotificationStatementSupport;
35 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
36 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.CustomCrossSourceStatementReactorBuilder;
37 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
39 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
40 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.Builder;
41 import org.opendaylight.yangtools.yang.xpath.api.YangXPathParserFactory;
44 * Utility class for instantiating default-configured {@link CrossSourceStatementReactor}s.
46 * @author Robert Varga
49 public final class DefaultReactors {
50 private static final class DefaultReactor {
51 // Thread-safe lazy init
52 static final @NonNull CrossSourceStatementReactor INSTANCE = defaultReactorBuilder().build();
55 private DefaultReactors() {
60 * Get a shared default-configured reactor instance. This instance is configured to handle both RFC6020 and RFC7950,
63 * <li>RFC6536's default-deny-{all,write} extensions</li>
64 * <li>RFC7952's annotation extension</li>
65 * <li>RFC8040's yang-data extension</li>
66 * <li>OpenConfig extensions</li>
67 * <li>OpenDaylight extensions</li>
70 * @return a shared default-configured reactor instance.
72 public static @NonNull CrossSourceStatementReactor defaultReactor() {
73 return DefaultReactor.INSTANCE;
77 * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
78 * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
80 * @return A populated CrossSourceStatementReactor builder.
82 public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
83 return defaultReactorBuilder(YangParserConfiguration.DEFAULT);
87 * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
88 * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
90 * @param config parser configuration
91 * @return A populated CrossSourceStatementReactor builder.
93 public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder(
94 final YangParserConfiguration config) {
95 return addExtensions(RFC7950Reactors.defaultReactorBuilder(config), config);
99 * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
100 * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
102 * @return A populated CrossSourceStatementReactor builder.
104 public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder(
105 final YangXPathParserFactory xpathFactory) {
106 return defaultReactorBuilder(xpathFactory, YangParserConfiguration.DEFAULT);
110 * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
111 * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
113 * @param config parser configuration
114 * @return A populated CrossSourceStatementReactor builder.
116 public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder(
117 final YangXPathParserFactory xpathFactory, final YangParserConfiguration config) {
118 return addExtensions(RFC7950Reactors.defaultReactorBuilder(xpathFactory, config), config);
121 private static @NonNull CustomCrossSourceStatementReactorBuilder addExtensions(
122 final @NonNull CustomCrossSourceStatementReactorBuilder builder, final YangParserConfiguration config) {
124 // OpenDaylight extensions
125 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new AugmentIdentifierStatementSupport(config))
126 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new ContextInstanceStatementSupport(config))
127 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new ContextReferenceStatementSupport(config))
128 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new InstanceTargetStatementSupport(config))
129 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new RpcContextReferenceStatementSupport(config))
131 // RFC6241 get-filter-element-attributes support
132 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
133 new GetFilterElementAttributesStatementSupport(config))
135 // RFC6536 default-deny-{all,write} support
136 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new DefaultDenyAllStatementSupport(config))
137 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new DefaultDenyWriteStatementSupport(config))
139 // RFC6643 extensions
140 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new DisplayHintStatementSupport(config))
141 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new MaxAccessStatementSupport(config))
142 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new DefValStatementSupport(config))
143 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new ImpliedStatementSupport(config))
144 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new AliasStatementSupport(config))
145 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new OidStatementSupport(config))
146 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new SubIdStatementSupport(config))
148 // RFC7952 annotation support
149 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new AnnotationStatementSupport(config))
151 // RFC8040 yang-data support
152 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataArgumentNamespace.BEHAVIOUR)
153 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new YangDataStatementSupport(config))
155 // RFC8528 mount-point support
156 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new MountPointStatementSupport(config))
158 // RFC8639 subscription-state-notification support
159 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
160 new SubscriptionStateNotificationStatementSupport(config))
162 // OpenConfig extensions support
163 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new EncryptedValueStatementSupport(config))
164 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new HashedValueStatementSupport(config))
165 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, new OpenConfigVersionSupport(config));