ErrorCode (NCS Java API Version 5.6)

Object
- Enum<ErrorCode>
- - com.tailf.conf.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ErrorCode>
```
public enum ErrorCode
extends Enum<ErrorCode>
```
Error codes for all errors delivered over the protocol.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ERR_ABORTED` An operation was aborted
`ERR_ACCESS_DENIED` Access to an object was denied due to AAA authorization rules
`ERR_ALREADY_EXISTS` We tried to create something which already exists
`ERR_APPLICATION_INTERNAL` A data provider callback returned CONFD_ERRCODE_APPLICATION_INTERNAL
`ERR_BAD_CONFIG` An error in a configuration
`ERR_BAD_KEYREF` Dangling pointer
`ERR_BADPATH` We provided a bad path
`ERR_BADSTATE` Some function, such as the MAAPI commit functions that require several functions to be called in a specific order, was called out of order
`ERR_BADTYPE` We tried to create or write an object which is specified to have another type than the one we provided
`ERR_CLI_CMD` Execution of a CLI command failed
`ERR_CONNECTION_CLOSED` Connection closed
`ERR_CONNECTION_REFUSED` Connection was refused
`ERR_CONNECTION_TIMEOUT` Connection timed out
`ERR_DATA_MISSING` A data provider callback returned ERRCODE_DATA_MISSING
`ERR_DEVICE` An error occurred on the device
`ERR_EOF` This value is used when a function returns EOF.
`ERR_EXTERNAL` All errors that originate in user code
`ERR_HA_BADFXS` A remote HA node had a different set of fxs files compared to us.
`ERR_HA_BADNAME` A remote ha node has a different name than the name we think it has
`ERR_HA_BADTOKEN` A remote HA node has a different token than us
`ERR_HA_BADVSN` A remote HA node had an incompatible protocol version
`ERR_HA_BIND` Failed to bind the ha socket for incoming HA connects
`ERR_HA_CLOSED` A remote HA node closed its connection to us, or there was a timeout waiting for a sync response from the master during a call of HA.beSlave()
`ERR_HA_CONNECT` Failed to connect to a remote HA node
`ERR_HA_NOTICK` A remote HA node failed to produce the interval live ticks
`ERR_HA_WITH_UPGRADE` We tried to perform an in-service data model upgrade on a HA node that was either a master with slaves or a slave, or we tried to make the node a HA slave while an in-service data model upgrade was in progress
`ERR_INCONSISTENT_VALUE` A data provider callback returned ERRCODE_INCONSISTENT_VALUE
`ERR_INTERNAL` An internal error.
`ERR_INUSE` We tried to commit while someone else holds a lock
`ERR_INVALID_INSTANCE` The value of an instance-identifier leaf does not conform to the specified path filters
`ERR_LIB_NOT_INITIALIZED` The confd has not been properly initialized
`ERR_LOCKED` We tried to lock something which is already locked
`ERR_MALLOC` Failed to allocate memory
`ERR_MISSING_INSTANCE` The value of an instance-identifier leaf with require-instance true does not specify an existing instance
`ERR_MUST_FAILED` A must constraint is not satisfied
`ERR_NOEXISTS` Typically we tried to read a value through CDB or MAAPI which does not exist
`ERR_NON_UNIQUE` A group of leafs specified with the unique statement are not unique
`ERR_NOSESSION` A session must be established prior to executing the function
`ERR_NOSTACK` We tried to pop without a preceding push
`ERR_NOT_IMPLEMENTED` A request was made for an operation that was not implemented.
`ERR_NOT_WRITABLE` We tried to write an object which is not writable
`ERR_NOTCREATABLE` We tried to create an object which is not possible to create
`ERR_NOTDELETABLE` We tried to delete an object which is not possible to delete
`ERR_NOTMOVABLE` We tried to move an object which is not possible to move
`ERR_NOTRANS` An invalid transaction handle (tid) was passed to a Maapi method
`ERR_NOTSET` A mandatory leaf does not have a value, either because it has been deleted, or not set after a create
`ERR_OS` An error occurred in a call to some operating system function, such as write().
`ERR_POLICY_COMPILATION_FAILED` A user-defined policy XPath expression could not be compiled
`ERR_POLICY_EVALUATION_FAILED` A user-defined policy expression failed XPath evaluation
`ERR_POLICY_FAILED` A user-defined policy expression evaluated to false
`ERR_PROTOUSAGE` Usage of API functions or callbacks was wrong.
`ERR_RESOURCE_DENIED` A data provider callback returned ERRCODE_RESOURCE_DENIED
`ERR_SERVICE_CONFLICT` Conflict between NCS services
`ERR_STALE_INSTANCE` An instance-identifier has stale data after upgrading
`ERR_START_FAILED` Daemon failed to proceed to next start-phase
`ERR_SUBAGENT_DOWN` An operation towards a mounted NETCONF subagent failed due to the subagent not being up
`ERR_TEMPLATE` A template operation failed
`ERR_TIMEOUT` An operation did not complete within the specified timeout
`ERR_TOO_FEW_ELEMS` A min-elements violation.
`ERR_TOO_MANY_ELEMS` A max-elements violation.
`ERR_TOO_MANY_SESSIONS` Maximum number of sessions reached
`ERR_TOOMANYTRANS` A new MAAPI transaction was rejected since the transaction limit threshold was reached
`ERR_UNAVAILABLE` We tried to use some unavailable functionality, e.g.
`ERR_UNSET_CHOICE` No case has been selected for a mandatory choice statement
`ERR_UPGRADE_IN_PROGRESS` A request was made for an operation that is not allowed when in-service data model upgrade is in progress
`ERR_VALIDATION_WARNING` Maapi.validateTrans() returned warnings
`ERR_XPATH` Compilation or evaluation of an XPath expression failed
`UNDEFINED` Error with undefined error code

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equalsTo(int i)`
`int`	`getValue()`
`String`	`stringValue()`
`static ErrorCode`	`valueOf(int i)`
`static ErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ErrorCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - UNDEFINED
```
public static final ErrorCode UNDEFINED
```
    Error with undefined error code
  - ERR_NOEXISTS
```
public static final ErrorCode ERR_NOEXISTS
```
    Typically we tried to read a value through CDB or MAAPI which does not exist
  - ERR_ALREADY_EXISTS
```
public static final ErrorCode ERR_ALREADY_EXISTS
```
    We tried to create something which already exists
  - ERR_ACCESS_DENIED
```
public static final ErrorCode ERR_ACCESS_DENIED
```
    Access to an object was denied due to AAA authorization rules
  - ERR_NOT_WRITABLE
```
public static final ErrorCode ERR_NOT_WRITABLE
```
    We tried to write an object which is not writable
  - ERR_BADTYPE
```
public static final ErrorCode ERR_BADTYPE
```
    We tried to create or write an object which is specified to have another type than the one we provided
  - ERR_NOTCREATABLE
```
public static final ErrorCode ERR_NOTCREATABLE
```
    We tried to create an object which is not possible to create
  - ERR_NOTDELETABLE
```
public static final ErrorCode ERR_NOTDELETABLE
```
    We tried to delete an object which is not possible to delete
  - ERR_BADPATH
```
public static final ErrorCode ERR_BADPATH
```
    We provided a bad path
  - ERR_NOSTACK
```
public static final ErrorCode ERR_NOSTACK
```
    We tried to pop without a preceding push
  - ERR_LOCKED
```
public static final ErrorCode ERR_LOCKED
```
    We tried to lock something which is already locked
  - ERR_INUSE
```
public static final ErrorCode ERR_INUSE
```
    We tried to commit while someone else holds a lock
  - ERR_NOTSET
```
public static final ErrorCode ERR_NOTSET
```
    A mandatory leaf does not have a value, either because it has been deleted, or not set after a create
  - ERR_NON_UNIQUE
```
public static final ErrorCode ERR_NON_UNIQUE
```
    A group of leafs specified with the unique statement are not unique
  - ERR_BAD_KEYREF
```
public static final ErrorCode ERR_BAD_KEYREF
```
    Dangling pointer
  - ERR_TOO_FEW_ELEMS
```
public static final ErrorCode ERR_TOO_FEW_ELEMS
```
    A min-elements violation. A node has fewer elements or entries than specified with min-elements
  - ERR_TOO_MANY_ELEMS
```
public static final ErrorCode ERR_TOO_MANY_ELEMS
```
    A max-elements violation. A node has fewer elements or entries than specified with max-elements
  - ERR_BADSTATE
```
public static final ErrorCode ERR_BADSTATE
```
    Some function, such as the MAAPI commit functions that require several functions to be called in a specific order, was called out of order
  - ERR_INTERNAL
```
public static final ErrorCode ERR_INTERNAL
```
    An internal error. This normally indicates a bug in ConfD/NCS or libconfd (if nothing else the lack of a better error code), please report it to Tail-f support
  - ERR_EXTERNAL
```
public static final ErrorCode ERR_EXTERNAL
```
    All errors that originate in user code
  - ERR_MALLOC
```
public static final ErrorCode ERR_MALLOC
```
    Failed to allocate memory
  - ERR_PROTOUSAGE
```
public static final ErrorCode ERR_PROTOUSAGE
```
    Usage of API functions or callbacks was wrong. It typically means that we invoke a function when we should not
  - ERR_NOSESSION
```
public static final ErrorCode ERR_NOSESSION
```
    A session must be established prior to executing the function
  - ERR_TOOMANYTRANS
```
public static final ErrorCode ERR_TOOMANYTRANS
```
    A new MAAPI transaction was rejected since the transaction limit threshold was reached
  - ERR_OS
```
public static final ErrorCode ERR_OS
```
    An error occurred in a call to some operating system function, such as write(). The proper errno from libc should then be read and used as failure indicator
  - ERR_HA_CONNECT
```
public static final ErrorCode ERR_HA_CONNECT
```
    Failed to connect to a remote HA node
  - ERR_HA_CLOSED
```
public static final ErrorCode ERR_HA_CLOSED
```
    A remote HA node closed its connection to us, or there was a timeout waiting for a sync response from the master during a call of HA.beSlave()
  - ERR_HA_BADFXS
```
public static final ErrorCode ERR_HA_BADFXS
```
    A remote HA node had a different set of fxs files compared to us. It could also be that the set is the same, but the version of some fxs file is different
  - ERR_HA_BADTOKEN
```
public static final ErrorCode ERR_HA_BADTOKEN
```
    A remote HA node has a different token than us
  - ERR_HA_BADNAME
```
public static final ErrorCode ERR_HA_BADNAME
```
    A remote ha node has a different name than the name we think it has
  - ERR_HA_BIND
```
public static final ErrorCode ERR_HA_BIND
```
    Failed to bind the ha socket for incoming HA connects
  - ERR_HA_NOTICK
```
public static final ErrorCode ERR_HA_NOTICK
```
    A remote HA node failed to produce the interval live ticks
  - ERR_VALIDATION_WARNING
```
public static final ErrorCode ERR_VALIDATION_WARNING
```
    Maapi.validateTrans() returned warnings
  - ERR_SUBAGENT_DOWN
```
public static final ErrorCode ERR_SUBAGENT_DOWN
```
    An operation towards a mounted NETCONF subagent failed due to the subagent not being up
  - ERR_LIB_NOT_INITIALIZED
```
public static final ErrorCode ERR_LIB_NOT_INITIALIZED
```
    The confd has not been properly initialized
  - ERR_TOO_MANY_SESSIONS
```
public static final ErrorCode ERR_TOO_MANY_SESSIONS
```
    Maximum number of sessions reached
  - ERR_BAD_CONFIG
```
public static final ErrorCode ERR_BAD_CONFIG
```
    An error in a configuration
  - ERR_RESOURCE_DENIED
```
public static final ErrorCode ERR_RESOURCE_DENIED
```
    A data provider callback returned ERRCODE_RESOURCE_DENIED
  - ERR_INCONSISTENT_VALUE
```
public static final ErrorCode ERR_INCONSISTENT_VALUE
```
    A data provider callback returned ERRCODE_INCONSISTENT_VALUE
  - ERR_APPLICATION_INTERNAL
```
public static final ErrorCode ERR_APPLICATION_INTERNAL
```
    A data provider callback returned CONFD_ERRCODE_APPLICATION_INTERNAL
  - ERR_UNSET_CHOICE
```
public static final ErrorCode ERR_UNSET_CHOICE
```
    No case has been selected for a mandatory choice statement
  - ERR_MUST_FAILED
```
public static final ErrorCode ERR_MUST_FAILED
```
    A must constraint is not satisfied
  - ERR_MISSING_INSTANCE
```
public static final ErrorCode ERR_MISSING_INSTANCE
```
    The value of an instance-identifier leaf with require-instance true does not specify an existing instance
  - ERR_INVALID_INSTANCE
```
public static final ErrorCode ERR_INVALID_INSTANCE
```
    The value of an instance-identifier leaf does not conform to the specified path filters
  - ERR_UNAVAILABLE
```
public static final ErrorCode ERR_UNAVAILABLE
```
    We tried to use some unavailable functionality, e.g. get/set attributes on an operational data element
  - ERR_EOF
```
public static final ErrorCode ERR_EOF
```
    This value is used when a function returns EOF. Thus it is not strictly necessary to check whether the return value is an error or eof - if the function should return OK on success, but the return value is something else, the reason can always be found via errno
  - ERR_NOTMOVABLE
```
public static final ErrorCode ERR_NOTMOVABLE
```
    We tried to move an object which is not possible to move
  - ERR_HA_WITH_UPGRADE
```
public static final ErrorCode ERR_HA_WITH_UPGRADE
```
    We tried to perform an in-service data model upgrade on a HA node that was either a master with slaves or a slave, or we tried to make the node a HA slave while an in-service data model upgrade was in progress
  - ERR_TIMEOUT
```
public static final ErrorCode ERR_TIMEOUT
```
    An operation did not complete within the specified timeout
  - ERR_ABORTED
```
public static final ErrorCode ERR_ABORTED
```
    An operation was aborted
  - ERR_XPATH
```
public static final ErrorCode ERR_XPATH
```
    Compilation or evaluation of an XPath expression failed
  - ERR_NOT_IMPLEMENTED
```
public static final ErrorCode ERR_NOT_IMPLEMENTED
```
    A request was made for an operation that was not implemented. This will typically occur if an application uses a version of ConfD/NCS that is more recent than the version of the Java daemon, and a CDB or MAAPI function is used that is only implemented in the library version
  - ERR_HA_BADVSN
```
public static final ErrorCode ERR_HA_BADVSN
```
    A remote HA node had an incompatible protocol version
  - ERR_POLICY_FAILED
```
public static final ErrorCode ERR_POLICY_FAILED
```
    A user-defined policy expression evaluated to false
  - ERR_POLICY_COMPILATION_FAILED
```
public static final ErrorCode ERR_POLICY_COMPILATION_FAILED
```
    A user-defined policy XPath expression could not be compiled
  - ERR_POLICY_EVALUATION_FAILED
```
public static final ErrorCode ERR_POLICY_EVALUATION_FAILED
```
    A user-defined policy expression failed XPath evaluation
  - ERR_CONNECTION_REFUSED
```
public static final ErrorCode ERR_CONNECTION_REFUSED
```
    Connection was refused
  - ERR_START_FAILED
```
public static final ErrorCode ERR_START_FAILED
```
    Daemon failed to proceed to next start-phase
  - ERR_DATA_MISSING
```
public static final ErrorCode ERR_DATA_MISSING
```
    A data provider callback returned ERRCODE_DATA_MISSING
  - ERR_CLI_CMD
```
public static final ErrorCode ERR_CLI_CMD
```
    Execution of a CLI command failed
  - ERR_UPGRADE_IN_PROGRESS
```
public static final ErrorCode ERR_UPGRADE_IN_PROGRESS
```
    A request was made for an operation that is not allowed when in-service data model upgrade is in progress
  - ERR_NOTRANS
```
public static final ErrorCode ERR_NOTRANS
```
    An invalid transaction handle (tid) was passed to a Maapi method
  - ERR_SERVICE_CONFLICT
```
public static final ErrorCode ERR_SERVICE_CONFLICT
```
    Conflict between NCS services
  - ERR_CONNECTION_TIMEOUT
```
public static final ErrorCode ERR_CONNECTION_TIMEOUT
```
    Connection timed out
  - ERR_CONNECTION_CLOSED
```
public static final ErrorCode ERR_CONNECTION_CLOSED
```
    Connection closed
  - ERR_DEVICE
```
public static final ErrorCode ERR_DEVICE
```
    An error occurred on the device
  - ERR_TEMPLATE
```
public static final ErrorCode ERR_TEMPLATE
```
    A template operation failed
  - ERR_STALE_INSTANCE
```
public static final ErrorCode ERR_STALE_INSTANCE
```
    An instance-identifier has stale data after upgrading
- Method Detail
  - values
```
public static ErrorCode[] 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 (ErrorCode c : ErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ErrorCode 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
  - getValue
```
public int getValue()
```
  - valueOf
```
public static ErrorCode valueOf(int i)
```
  - equalsTo
```
public boolean equalsTo(int i)
```
  - stringValue
```
public String stringValue()
```

Enum ErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

UNDEFINED

ERR_NOEXISTS

ERR_ALREADY_EXISTS

ERR_ACCESS_DENIED

ERR_NOT_WRITABLE

ERR_BADTYPE

ERR_NOTCREATABLE

ERR_NOTDELETABLE

ERR_BADPATH

ERR_NOSTACK

ERR_LOCKED

ERR_INUSE

ERR_NOTSET

ERR_NON_UNIQUE

ERR_BAD_KEYREF

ERR_TOO_FEW_ELEMS

ERR_TOO_MANY_ELEMS

ERR_BADSTATE

ERR_INTERNAL

ERR_EXTERNAL

ERR_MALLOC

ERR_PROTOUSAGE

ERR_NOSESSION

ERR_TOOMANYTRANS

ERR_OS

ERR_HA_CONNECT

ERR_HA_CLOSED

ERR_HA_BADFXS

ERR_HA_BADTOKEN

ERR_HA_BADNAME

ERR_HA_BIND

ERR_HA_NOTICK

ERR_VALIDATION_WARNING

ERR_SUBAGENT_DOWN

ERR_LIB_NOT_INITIALIZED

ERR_TOO_MANY_SESSIONS

ERR_BAD_CONFIG

ERR_RESOURCE_DENIED

ERR_INCONSISTENT_VALUE

ERR_APPLICATION_INTERNAL

ERR_UNSET_CHOICE

ERR_MUST_FAILED

ERR_MISSING_INSTANCE

ERR_INVALID_INSTANCE

ERR_UNAVAILABLE

ERR_EOF

ERR_NOTMOVABLE

ERR_HA_WITH_UPGRADE

ERR_TIMEOUT

ERR_ABORTED

ERR_XPATH

ERR_NOT_IMPLEMENTED

ERR_HA_BADVSN

ERR_POLICY_FAILED

ERR_POLICY_COMPILATION_FAILED

ERR_POLICY_EVALUATION_FAILED

ERR_CONNECTION_REFUSED

ERR_START_FAILED

ERR_DATA_MISSING

ERR_CLI_CMD

ERR_UPGRADE_IN_PROGRESS

ERR_NOTRANS

ERR_SERVICE_CONFLICT

ERR_CONNECTION_TIMEOUT

ERR_CONNECTION_CLOSED

ERR_DEVICE

ERR_TEMPLATE

ERR_STALE_INSTANCE

Method Detail

values

valueOf

getValue

valueOf

equalsTo