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.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.rfc7952.parser.AnnotationStatementSupport;
21 import org.opendaylight.yangtools.rfc8040.parser.YangDataStatementSupport;
22 import org.opendaylight.yangtools.rfc8528.parser.MountPointStatementSupport;
23 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.CustomCrossSourceStatementReactorBuilder;
24 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
25 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
26 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
27 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.Builder;
28 import org.opendaylight.yangtools.yang.xpath.api.YangXPathParserFactory;
31 * Utility class for instantiating default-configured {@link CrossSourceStatementReactor}s.
33 * @author Robert Varga
36 public final class DefaultReactors {
37 private static final class DefaultReactor {
38 // Thread-safe lazy init
39 static final @NonNull CrossSourceStatementReactor INSTANCE = defaultReactorBuilder().build();
42 private DefaultReactors() {
47 * Get a shared default-configured reactor instance. This instance is configured to handle both RFC6020 and RFC7950,
50 * <li>RFC6536's default-deny-{all,write} extensions</li>
51 * <li>RFC7952's annotation extension</li>
52 * <li>RFC8040's yang-data extension</li>
53 * <li>OpenConfig extensions</li>
54 * <li>OpenDaylight extensions</li>
57 * @return a shared default-configured reactor instance.
59 public static @NonNull CrossSourceStatementReactor defaultReactor() {
60 return DefaultReactor.INSTANCE;
64 * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
65 * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
67 * @return A populated CrossSourceStatementReactor builder.
69 public static @NonNull CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
70 return addExtensions(RFC7950Reactors.defaultReactorBuilder());
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 final YangXPathParserFactory xpathFactory) {
81 return addExtensions(RFC7950Reactors.defaultReactorBuilder(xpathFactory));
84 private static @NonNull CustomCrossSourceStatementReactorBuilder addExtensions(
85 final @NonNull CustomCrossSourceStatementReactorBuilder builder) {
87 // AnyxmlSchemaLocation support
88 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
89 AnyxmlSchemaLocationStatementSupport.getInstance())
90 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION, AnyxmlSchemaLocationNamespace.BEHAVIOUR)
91 .overrideStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
92 AnyxmlStatementSupportOverride.getInstance())
94 // RFC6241 get-filter-element-attributes support
95 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
96 GetFilterElementAttributesStatementSupport.getInstance())
98 // RFC6536 default-deny-{all,write} support
99 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
100 DefaultDenyAllStatementSupport.getInstance())
101 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
102 DefaultDenyWriteStatementSupport.getInstance())
104 // RFC7952 annotation support
105 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AnnotationStatementSupport.getInstance())
107 // RFC8040 yang-data support
108 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataStatementSupport.getInstance())
110 // RFC8528 yang-data support
111 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, MountPointStatementSupport.getInstance())
113 // OpenConfig extensions support (except openconfig-version)
114 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
115 EncryptedValueStatementSupport.getInstance())
116 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION,
117 HashedValueStatementSupport.getInstance());