org.onosproject.yms.ydt

Enum YmsOperationType

java.lang.Object

java.lang.Enum<YmsOperationType>

org.onosproject.yms.ydt.YmsOperationType

All Implemented Interfaces:

Serializable, Comparable<YmsOperationType>

public enum YmsOperationType
extends Enum<YmsOperationType>

Represents type of root level operation for the request. This is used by protocols to specify the root level operation associated with the request. YMS data validation and data handling will vary based on the edit operation type, for an instance YANG specified "mandatory" leafs needn't be present for QUERY_CONFIG and QUERY, but they may be mandatory to be present in request for EDIT_CONFIG type. The validation and handling is further dependent on edit operation type. In SBI, driver/provider must provide this information to YMS which needs to encode this information in corresponding data format. YmsOperationType MUST be specified by protocol.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDIT_CONFIG_REPLY The YANG based response is for edit operation.
EDIT_CONFIG_REQUEST The YANG based request is to edit a config node / subtree in the data store.
NOTIFICATION The YANG based request is to execute an RPC defined in YANG.
QUERY_CONFIG_REPLY The YANG based response is for query config operation.
QUERY_CONFIG_REQUEST The YANG based request is to query a config node / subtree in the data store.
QUERY_REPLY The YANG based response is for query operation.
QUERY_REQUEST The YANG based request is to query a node / subtree in the data store.
RPC_REPLY The YANG based response is for a RPC operation.
RPC_REQUEST The YANG based request is to execute an RPC defined in YANG.

Method Summary

Modifier and Type	Method and Description
static YmsOperationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static YmsOperationType[]	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

EDIT_CONFIG_REQUEST

public static final YmsOperationType EDIT_CONFIG_REQUEST

The YANG based request is to edit a config node / subtree in the data store.

QUERY_CONFIG_REQUEST

public static final YmsOperationType QUERY_CONFIG_REQUEST

The YANG based request is to query a config node / subtree in the data store.

QUERY_REQUEST

public static final YmsOperationType QUERY_REQUEST

The YANG based request is to query a node / subtree in the data store.

RPC_REQUEST

public static final YmsOperationType RPC_REQUEST

The YANG based request is to execute an RPC defined in YANG.

EDIT_CONFIG_REPLY

public static final YmsOperationType EDIT_CONFIG_REPLY

The YANG based response is for edit operation.

QUERY_CONFIG_REPLY

public static final YmsOperationType QUERY_CONFIG_REPLY

The YANG based response is for query config operation.

QUERY_REPLY

public static final YmsOperationType QUERY_REPLY

The YANG based response is for query operation.

RPC_REPLY

public static final YmsOperationType RPC_REPLY

The YANG based response is for a RPC operation.

NOTIFICATION

public static final YmsOperationType NOTIFICATION

The YANG based request is to execute an RPC defined in YANG.

Method Detail

values

public static YmsOperationType[] 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 (YmsOperationType c : YmsOperationType.values())
    System.out.println(c);

Returns:

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

valueOf

public static YmsOperationType 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