org.ldaptive

Enum ResultCode

java.lang.Object

java.lang.Enum<ResultCode>

org.ldaptive.ResultCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ResultCode>

public enum ResultCode
extends java.lang.Enum<ResultCode>

Enum to define ldap result codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN_LIMIT_EXCEEDED admin limit exceeded.
AFFECTS_MULTIPLE_DSAS affected multiple dsas.
ALIAS_DEREFERENCING_PROBLEM alias dereferencing problem.
ALIAS_PROBLEM alias problem.
AMBIGUOUS_RESPONSE ambiguous response.
ASSERTION_FAILED assertion failed, See RFC 4528.
ATTRIBUTE_OR_VALUE_EXISTS attribute or value exists.
AUTH_METHOD_NOT_SUPPORTED authentication method not supported.
AUTH_UNKNOWN auth unknown.
AUTHORIZATION_DENIED authorization denied, See RFC 4370.
BUSY busy.
CANCELED operation canceled, See RFC 3909.
CANNOT_CANCEL cannot cancel, See RFC 3909.
CLIENT_LOOP client loop.
COMPARE_FALSE compare false.
COMPARE_TRUE compare true.
CONFIDENTIALITY_REQUIRED confidentiality required.
CONNECT_ERROR connect error.
CONSTRAINT_VIOLATION constraint violation.
CONTROL_NOT_FOUND control not found.
DECODING_ERROR decoding error.
E_SYNC_REFRESH_REQUIRED e-syncRefreshRequired, See RFC 4533.
ENCODING_ERROR encoding error.
ENTRY_ALREADY_EXISTS entry already exists.
FILTER_ERROR filter error.
INAPPROPRIATE_AUTHENTICATION inappropriate authentication.
INAPPROPRIATE_MATCHING inappropriate matching.
INSUFFICIENT_ACCESS_RIGHTS insufficient access rights.
INVALID_ATTRIBUTE_SYNTAX invalid attribute syntax.
INVALID_CREDENTIALS invalid credentials.
INVALID_DN_SYNTAX invalid dn syntax.
INVALID_RESPONSE invalid response.
IS_LEAF is leaf.
LDAP_NOT_SUPPORTED ldap not supported.
LDAP_TIMEOUT ldap timeout.
LOCAL_ERROR local error.
LOOP_DETECT loop detect.
MORE_RESULTS_TO_RETURN more results to return.
NAMING_VIOLATION naming violation.
NO_MEMORY no memory.
NO_RESULTS_RETURNED no results returned.
NO_SUCH_ATTRIBUTE no such attribute.
NO_SUCH_OBJECT no such object.
NO_SUCH_OPERATION no such operation, See RFC 3909.
NOT_ALLOWED_ON_NONLEAF not allowed on nonleaf.
NOT_ALLOWED_ON_RDN not allowed on rdn.
OBJECT_CLASS_MODS_PROHIBITED object class mods prohibited.
OBJECT_CLASS_VIOLATION object class violation.
OFFSET_RANGE_ERROR offset range error, See draft-ietf-ldapext-ldapv3-vlv.
OPERATIONS_ERROR operations error.
OTHER other.
PARAM_ERROR param error.
PARTIAL_RESULTS partial results.
PROTOCOL_ERROR protocol error.
REFERRAL referral.
REFERRAL_LIMIT_EXCEEDED referral limit exceeded.
SASL_BIND_IN_PROGRESS sasl bind in progress.
SERVER_DOWN server down.
SIZE_LIMIT_EXCEEDED size limit exceeded.
SORT_CONTROL_MISSING sort control missing, See draft-ietf-ldapext-ldapv3-vlv.
STRONG_AUTH_REQUIRED strong authentication required.
SUCCESS success.
TIME_LIMIT_EXCEEDED time limit exceeded.
TLS_NOT_SUPPORTED tls not supported.
TOO_LATE too late, See RFC 3909.
UNAVAILABLE unavailable.
UNAVAILABLE_CRITICAL_EXTENSION unavailable critical extension.
UNDEFINED_ATTRIBUTE_TYPE undefined attribute type.
UNWILLING_TO_PERFORM unwilling to perform.
USER_CANCELLED user cancelled.
VIRTUAL_LIST_VIEW_ERROR virtual list view error, See draft-ietf-ldapext-ldapv3-vlv.

Field Summary

Fields

Modifier and Type	Field and Description
private int	code underlying error code.

Method Summary

Modifier and Type	Method and Description
int	value() Returns the result code value.
static ResultCode	valueOf(int code) Returns the result code for the supplied integer constant.
static ResultCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ResultCode[]	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

SUCCESS

public static final ResultCode SUCCESS

success.

OPERATIONS_ERROR

public static final ResultCode OPERATIONS_ERROR

operations error.

PROTOCOL_ERROR

public static final ResultCode PROTOCOL_ERROR

protocol error.

TIME_LIMIT_EXCEEDED

public static final ResultCode TIME_LIMIT_EXCEEDED

time limit exceeded.

SIZE_LIMIT_EXCEEDED

public static final ResultCode SIZE_LIMIT_EXCEEDED

size limit exceeded.

COMPARE_FALSE

public static final ResultCode COMPARE_FALSE

compare false.

COMPARE_TRUE

public static final ResultCode COMPARE_TRUE

compare true.

AUTH_METHOD_NOT_SUPPORTED

public static final ResultCode AUTH_METHOD_NOT_SUPPORTED

authentication method not supported.

STRONG_AUTH_REQUIRED

public static final ResultCode STRONG_AUTH_REQUIRED

strong authentication required.

PARTIAL_RESULTS

public static final ResultCode PARTIAL_RESULTS

partial results.

REFERRAL

public static final ResultCode REFERRAL

referral.

ADMIN_LIMIT_EXCEEDED

public static final ResultCode ADMIN_LIMIT_EXCEEDED

admin limit exceeded.

UNAVAILABLE_CRITICAL_EXTENSION

public static final ResultCode UNAVAILABLE_CRITICAL_EXTENSION

unavailable critical extension.

CONFIDENTIALITY_REQUIRED

public static final ResultCode CONFIDENTIALITY_REQUIRED

confidentiality required.

SASL_BIND_IN_PROGRESS

public static final ResultCode SASL_BIND_IN_PROGRESS

sasl bind in progress.

NO_SUCH_ATTRIBUTE

public static final ResultCode NO_SUCH_ATTRIBUTE

no such attribute.

UNDEFINED_ATTRIBUTE_TYPE

public static final ResultCode UNDEFINED_ATTRIBUTE_TYPE

undefined attribute type.

INAPPROPRIATE_MATCHING

public static final ResultCode INAPPROPRIATE_MATCHING

inappropriate matching.

CONSTRAINT_VIOLATION

public static final ResultCode CONSTRAINT_VIOLATION

constraint violation.

ATTRIBUTE_OR_VALUE_EXISTS

public static final ResultCode ATTRIBUTE_OR_VALUE_EXISTS

attribute or value exists.

INVALID_ATTRIBUTE_SYNTAX

public static final ResultCode INVALID_ATTRIBUTE_SYNTAX

invalid attribute syntax.

NO_SUCH_OBJECT

public static final ResultCode NO_SUCH_OBJECT

no such object.

ALIAS_PROBLEM

public static final ResultCode ALIAS_PROBLEM

alias problem.

INVALID_DN_SYNTAX

public static final ResultCode INVALID_DN_SYNTAX

invalid dn syntax.

IS_LEAF

public static final ResultCode IS_LEAF

is leaf.

ALIAS_DEREFERENCING_PROBLEM

public static final ResultCode ALIAS_DEREFERENCING_PROBLEM

alias dereferencing problem.

INAPPROPRIATE_AUTHENTICATION

public static final ResultCode INAPPROPRIATE_AUTHENTICATION

inappropriate authentication.

INVALID_CREDENTIALS

public static final ResultCode INVALID_CREDENTIALS

invalid credentials.

INSUFFICIENT_ACCESS_RIGHTS

public static final ResultCode INSUFFICIENT_ACCESS_RIGHTS

insufficient access rights.

BUSY

public static final ResultCode BUSY

busy.

UNAVAILABLE

public static final ResultCode UNAVAILABLE

unavailable.

UNWILLING_TO_PERFORM

public static final ResultCode UNWILLING_TO_PERFORM

unwilling to perform.

LOOP_DETECT

public static final ResultCode LOOP_DETECT

loop detect.

SORT_CONTROL_MISSING

public static final ResultCode SORT_CONTROL_MISSING

sort control missing, See draft-ietf-ldapext-ldapv3-vlv.

OFFSET_RANGE_ERROR

public static final ResultCode OFFSET_RANGE_ERROR

offset range error, See draft-ietf-ldapext-ldapv3-vlv.

NAMING_VIOLATION

public static final ResultCode NAMING_VIOLATION

naming violation.

OBJECT_CLASS_VIOLATION

public static final ResultCode OBJECT_CLASS_VIOLATION

object class violation.

NOT_ALLOWED_ON_NONLEAF

public static final ResultCode NOT_ALLOWED_ON_NONLEAF

not allowed on nonleaf.

NOT_ALLOWED_ON_RDN

public static final ResultCode NOT_ALLOWED_ON_RDN

not allowed on rdn.

ENTRY_ALREADY_EXISTS

public static final ResultCode ENTRY_ALREADY_EXISTS

entry already exists.

OBJECT_CLASS_MODS_PROHIBITED

public static final ResultCode OBJECT_CLASS_MODS_PROHIBITED

object class mods prohibited.

AFFECTS_MULTIPLE_DSAS

public static final ResultCode AFFECTS_MULTIPLE_DSAS

affected multiple dsas.

VIRTUAL_LIST_VIEW_ERROR

public static final ResultCode VIRTUAL_LIST_VIEW_ERROR

virtual list view error, See draft-ietf-ldapext-ldapv3-vlv.

OTHER

public static final ResultCode OTHER

other.

SERVER_DOWN

public static final ResultCode SERVER_DOWN

server down.

LOCAL_ERROR

public static final ResultCode LOCAL_ERROR

local error.

ENCODING_ERROR

public static final ResultCode ENCODING_ERROR

encoding error.

DECODING_ERROR

public static final ResultCode DECODING_ERROR

decoding error.

LDAP_TIMEOUT

public static final ResultCode LDAP_TIMEOUT

ldap timeout.

AUTH_UNKNOWN

public static final ResultCode AUTH_UNKNOWN

auth unknown.

FILTER_ERROR

public static final ResultCode FILTER_ERROR

filter error.

USER_CANCELLED

public static final ResultCode USER_CANCELLED

user cancelled.

PARAM_ERROR

public static final ResultCode PARAM_ERROR

param error.

NO_MEMORY

public static final ResultCode NO_MEMORY

no memory.

CONNECT_ERROR

public static final ResultCode CONNECT_ERROR

connect error.

LDAP_NOT_SUPPORTED

public static final ResultCode LDAP_NOT_SUPPORTED

ldap not supported.

CONTROL_NOT_FOUND

public static final ResultCode CONTROL_NOT_FOUND

control not found.

NO_RESULTS_RETURNED

public static final ResultCode NO_RESULTS_RETURNED

no results returned.

MORE_RESULTS_TO_RETURN

public static final ResultCode MORE_RESULTS_TO_RETURN

more results to return.

CLIENT_LOOP

public static final ResultCode CLIENT_LOOP

client loop.

REFERRAL_LIMIT_EXCEEDED

public static final ResultCode REFERRAL_LIMIT_EXCEEDED

referral limit exceeded.

INVALID_RESPONSE

public static final ResultCode INVALID_RESPONSE

invalid response.

AMBIGUOUS_RESPONSE

public static final ResultCode AMBIGUOUS_RESPONSE

ambiguous response.

TLS_NOT_SUPPORTED

public static final ResultCode TLS_NOT_SUPPORTED

tls not supported.

CANCELED

public static final ResultCode CANCELED

operation canceled, See RFC 3909.

NO_SUCH_OPERATION

public static final ResultCode NO_SUCH_OPERATION

no such operation, See RFC 3909.

TOO_LATE

public static final ResultCode TOO_LATE

too late, See RFC 3909.

CANNOT_CANCEL

public static final ResultCode CANNOT_CANCEL

cannot cancel, See RFC 3909.

ASSERTION_FAILED

public static final ResultCode ASSERTION_FAILED

assertion failed, See RFC 4528.

AUTHORIZATION_DENIED

public static final ResultCode AUTHORIZATION_DENIED

authorization denied, See RFC 4370.

E_SYNC_REFRESH_REQUIRED

public static final ResultCode E_SYNC_REFRESH_REQUIRED

e-syncRefreshRequired, See RFC 4533.

Field Detail

code

private final int code

underlying error code.

Method Detail

values

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

Returns:

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

valueOf

public static ResultCode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public int value()

Returns the result code value.

Returns:

ldap result code

valueOf

public static ResultCode valueOf(int code)

Returns the result code for the supplied integer constant.

Parameters:

code - to find result code for

Returns:

result code