Package org.opendaylight.yangtools.yang.common

Enum NetconfLayer

java.lang.Object

java.lang.Enum<NetconfLayer>

org.opendaylight.yangtools.yang.common.NetconfLayer

All Implemented Interfaces:

Serializable, Comparable<NetconfLayer>

public enum NetconfLayer
extends Enum<NetconfLayer>

Enumeration of NETCONF layers, as established in NETCONF. This enumeration exists because its semantics are implied by RFC6020 references to error-tag and its XML encoding.

This enumeration corresponds to the Layer in:

   NETCONF can be conceptually partitioned into four layers:

              Layer                      Example
         +-------------+      +-----------------------------+
     (4) |   Content   |      |     Configuration data      |
         +-------------+      +-----------------------------+
                |                           |
         +-------------+      +-----------------------------+
     (3) | Operations  |      | <get-config>, <edit-config> |
         +-------------+      +-----------------------------+
                |                           |
         +-------------+      +-----------------------------+
     (2) |     RPC     |      |    <rpc>, <rpc-reply>       |
         +-------------+      +-----------------------------+
                |                           |
         +-------------+      +-----------------------------+
     (1) |  Transport  |      |   BEEP, SSH, SSL, console   |
         |   Protocol  |      |                             |
         +-------------+      +-----------------------------+
 

as acknowledged in RFC6241:

   The YANG data modeling language [RFC6020] has been developed for
   specifying NETCONF data models and protocol operations, covering the
   Operations and the Content layers of Figure 1.
 

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTENT	Content layer, for example configuration data.
OPERATIONS	Operations layer, for example <get-config>, <edit-config> configuration data.
RPC	RPC layer, for example <rpc>, <rpc-reply>.
TRANSPORT	Transport protocol layer, for example BEEP, SSH, TLS, console.

Method Summary

Modifier and Type	Method	Description
static NetconfLayer	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NetconfLayer[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTENT

public static final NetconfLayer CONTENT

Content layer, for example configuration data. This layer is implied indirectly in constructs defined in YangError and corresponds to ErrorType.APPLICATION

OPERATIONS

public static final NetconfLayer OPERATIONS

Operations layer, for example <get-config>, <edit-config> configuration data. This corresponds to ErrorType.PROTOCOL.

RPC

public static final NetconfLayer RPC

RPC layer, for example <rpc>, <rpc-reply>. This corresponds to ErrorType.RPC.

TRANSPORT

public static final NetconfLayer TRANSPORT

Transport protocol layer, for example BEEP, SSH, TLS, console. This corresponds to ErrorType.TRANSPORT.

Method Detail

values

public static NetconfLayer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NetconfLayer c : NetconfLayer.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NetconfLayer valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null