Add netconf.api.NamespaceURN
[netconf.git] / protocol / netconf-api / src / main / java / org / opendaylight / netconf / api / NamespaceURN.java
1 /*
2  * Copyright (c) 2023 PANTHEON.tech, 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.netconf.api;
9
10 import com.google.common.annotations.Beta;
11 import org.eclipse.jdt.annotation.NonNullByDefault;
12
13 /**
14  * The contents of
15  * <a href="https://www.iana.org/assignments/xml-registry/xml-registry.xhtml#ns">IETF XML ns Registry</a>relevant to
16  * NETCONF.
17  */
18 @NonNullByDefault
19 public final class NamespaceURN {
20     /**
21      * The NETCONF protocol XML namespace, as defined by <a href="https://www.rfc-editor.org/rfc/rfc6241">RFC6241</a>.
22      */
23     public static final String BASE = "urn:ietf:params:xml:ns:netconf:base:1.0";
24     /**
25      * The namespace used by the
26      * <a href="https://www.rfc-editor.org/rfc/rfc6243">With-defaults Capability for NETCONF</a> extension.
27      */
28     public static final String DEFAULT = "urn:ietf:params:xml:ns:netconf:default:1.0";
29     /**
30      * The namespace used by the
31      * <a href="https://datatracker.ietf.org/doc/html/draft-varga-netconf-exi-capability-01">
32      * Efficient XML Interchange Capability for NETCONF</a> extension. Note this is an expired IETF draft capability and
33      * subject to change.
34      */
35     @Beta
36     public static final String EXI = "urn:ietf:params:xml:ns:netconf:exi:1.0";
37     /**
38      * The namespace used by the <a href="https://www.rfc-editor.org/rfc/rfc5277">NETCONF Event Notifications</a>
39      * extension.
40      */
41     public static final String NOTIFICATION = "urn:ietf:params:xml:ns:netconf:notification:1.0";
42     /**
43      * The namespace used by the <a href="https://www.rfc-editor.org/rfc/rfc5717">
44      * Partial Lock Remote Procedure Call (RPC) for NETCONF</a> extension.
45      */
46     public static final String PARTIAL_LOCK = "urn:ietf:params:xml:ns:netconf:partial-lock:1.0";
47
48     private NamespaceURN() {
49         // Hidden on purpose
50     }
51 }