Skip navigation links

oracle.oud.types
Enum ResultCode

java.lang.Object
java.lang.Enum<ResultCode>
oracle.oud.types.ResultCode

All Implemented Interfaces:

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

public enum ResultCode

extends java.lang.Enum<ResultCode>

This enumeration defines the set of possible result codes that may be used for providing clients with information about result of processing an operation.

Enum Constant Summary

ADMIN_LIMIT_EXCEEDED
The result code that indicates that processing on the requested operation could not continue because an administrative limit was exceeded.

AFFECTS_MULTIPLE_DSAS
The result code that indicates that the operation could not be processed because it would impact multiple DSAs or other repositories.

ALIAS_DEREFERENCING_PROBLEM
The result code that indicates that a problem was encountered while attempting to dereference an alias for a search operation.

ALIAS_PROBLEM
The result code that indicates that the requested operation failed because it attempted to perform an illegal operation on an alias.

ASSERTION_FAILED
The result code that indicates that the filter contained in an assertion control failed to match the target entry.

ATTRIBUTE_OR_VALUE_EXISTS
The result code that indicates that the requested operation failed because it would have resulted in a conflict with an existing attribute or attribute value in the target entry.

AUTH_METHOD_NOT_SUPPORTED
The result code that indicates that the requested authentication attempt failed because it referenced an invalid SASL mechanism.

AUTHORIZATION_DENIED
The result code that should be used if the server will not allow the client to use the requested authorization.

BUSY
The result code that indicates that the server is too busy to process the requested operation.

CANCELED
The result code that indicates that a cancel request was successful, or that the specified operation was canceled.

CANNOT_CANCEL
The result code that indicates that a cancel request was unsuccessful because the targeted operation was one that could not be canceled.

CLIENT_SIDE_AUTH_UNKNOWN
The client-side result code that should be used if an unknown or unsupported authentication mechanism is requested.

CLIENT_SIDE_CLIENT_LOOP
The client-side result code that should be used if a referral loop is detected.

CLIENT_SIDE_CONNECT_ERROR
The client-side result code that should be used if a connection cannot be established.

CLIENT_SIDE_CONTROL_NOT_FOUND
The client-side result code that should be used if an expected control is not found in a response.

CLIENT_SIDE_DECODING_ERROR
The client-side result code that should be used if an error occurs while decoding a response.

CLIENT_SIDE_ENCODING_ERROR
The client-side result code that should be used if an error occurs while encoding a request.

CLIENT_SIDE_FILTER_ERROR
The client-side result code that should be used if a malformed search filter is provided.

CLIENT_SIDE_LOCAL_ERROR
The client-side result code that should be used if a local (client-side) error occurs.

CLIENT_SIDE_MORE_RESULTS_TO_RETURN
The client-side result code that should be used if there are more results to be processed.

CLIENT_SIDE_NO_MEMORY
The client-side result code that should be used if the client cannot obtain enough memory to perform the requested operation.

CLIENT_SIDE_NO_RESULTS_RETURNED
The client-side result code that should be used if no results were returned for a search operation that expected them.

CLIENT_SIDE_NOT_SUPPORTED
The client-side result code that should be used if a user requests an unsupported operation.

CLIENT_SIDE_PARAM_ERROR
The client-side result code that should be used if there was an error in the parameter(s) provided.

CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED
The client-side result code that should be used if the referral hop limit was exceeded.

CLIENT_SIDE_SERVER_DOWN
The client-side result code that should be used if an established connection is lost.

CLIENT_SIDE_TIMEOUT
The client-side result code that should be used if a client-side timeout occurs.

CLIENT_SIDE_USER_CANCELLED
The client-side result code that should be used if a user cancelled a client-side operation.

COMPARE_FALSE
The result code that indicates that the attribute value assertion included in a compare request did not match the targeted entry.

COMPARE_TRUE
The result code that indicates that the attribute value assertion included in a compare request did match the targeted entry.

CONFIDENTIALITY_REQUIRED
The result code that indicates that the requested operation could not be processed because it requires confidentiality for the communication between the client and the server.

CONSTRAINT_VIOLATION
The result code that indicates that the requested operation failed because it would have violated some constraint defined in the server.

ENTRY_ALREADY_EXISTS
The result code that indicates that the requested operation failed because it would have resulted in an entry that conflicts with an entry that already exists.

INAPPROPRIATE_AUTHENTICATION
The result code that indicates that an authentication attempt failed because the requested type of authentication was not appropriate for the targeted entry.

INAPPROPRIATE_MATCHING
The result code that indicates that the requested operation failed because it attempted to perform an inappropriate type of matching against an attribute.

INSUFFICIENT_ACCESS_RIGHTS
The result code that indicates that the client does not have sufficient permission to perform the requested operation.

INVALID_ATTRIBUTE_SYNTAX
The result code that indicates that the requested operation failed because it violated the syntax for a specified attribute.

INVALID_CREDENTIALS
The result code that indicates that an authentication attempt failed because the user did not provide a valid set of credentials.

INVALID_DN_SYNTAX
The result code that indicates that the requested operation failed because it would have resulted in an entry with an invalid or malformed DN.

LOOP_DETECT
The result code that indicates that a referral or chaining loop was detected while processing the request.

NAMING_VIOLATION
The result code that indicates that the requested operation failed because it would have violated the server's naming configuration.

NO_OPERATION
The result code that should be used if the server did not actually complete processing on the associated operation because the request included the LDAP No-Op control.

NO_SUCH_ATTRIBUTE
The result code that indicates that the requested operation failed because it targeted an attribute or attribute value that did not exist in the specified entry.

NO_SUCH_OBJECT
The result code that indicates that the requested operation failed because it referenced an entry that does not exist.

NO_SUCH_OPERATION
The result code that indicates that a cancel request was unsuccessful because the targeted operation did not exist or had already completed.

NOT_ALLOWED_ON_NONLEAF
The result code that indicates that the requested operation is not allowed for non-leaf entries.

NOT_ALLOWED_ON_RDN
The result code that indicates that the requested operation is not allowed on an RDN attribute.

OBJECTCLASS_MODS_PROHIBITED
The result code that indicates that the operation could not be processed because it would have modified the objectclasses associated with an entry in an illegal manner.

OBJECTCLASS_VIOLATION
The result code that indicates that the requested operation failed because it would have resulted in an entry that violated the server schema.

OFFSET_RANGE_ERROR
The result code that indicates that a search request included a VLV request control with an invalid offset.

OPERATIONS_ERROR
The result code that indicates that an internal error prevented the operation from being processed properly.

OTHER
The result code that should be used if no other result code is appropriate.

PROTOCOL_ERROR
The result code that indicates that the client sent a malformed or illegal request to the server.

REFERRAL
The result code that indicates that a referral was encountered.

SASL_BIND_IN_PROGRESS
The result code that should be used for intermediate responses in multi-stage SASL bind operations.

SIZE_LIMIT_EXCEEDED
The result code that indicates that a size limit was exceeded while attempting to process the request.

SORT_CONTROL_MISSING
The result code that indicates that a search request included a VLV request control without a server-side sort control.

STRONG_AUTH_REQUIRED
The result code that indicates that the requested operation could not be processed because it requires that the client has completed a strong form of authentication.

SUCCESS
The result code that indicates that the operation completed successfully.

TIME_LIMIT_EXCEEDED
The result code that indicates that a time limit was exceeded while attempting to process the request.

TOO_LATE
The result code that indicates that a cancel request was unsuccessful because processing on the targeted operation had already reached a point at which it could not be canceled.

UNAVAILABLE
The result code that indicates that either the entire server or one or more required resources were not available for use in processing the request.

UNAVAILABLE_CRITICAL_EXTENSION
The result code that indicates that the requested operation failed because it included a critical extension that is unsupported or inappropriate for that request.

UNDEFINED
The result code that should only be used if the actual result code has not yet been determined.

UNDEFINED_ATTRIBUTE_TYPE
The result code that indicates that the requested operation failed because it referenced an attribute that is not defined in the server schema.

UNWILLING_TO_PERFORM
The result code that indicates that the server is unwilling to perform the requested operation.

VIRTUAL_LIST_VIEW_ERROR
The result code that indicates that the operation could not be processed because there was an error while processing the virtual list view control.

Method Summary

int	getIntValue() Retrieves the integer value for this result code.
boolean	isSuccess() Indicates whether or not this result code represents a success result.
java.lang.String	toString() Retrieves a string representation of this result code.
static ResultCode	valueOf(int intValue) Retrieves the result code with the provided int value.
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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNDEFINED

public static final ResultCode UNDEFINED

The result code that should only be used if the actual result code has not yet been determined.

SUCCESS

public static final ResultCode SUCCESS

The result code that indicates that the operation completed successfully.

OPERATIONS_ERROR

public static final ResultCode OPERATIONS_ERROR

The result code that indicates that an internal error prevented the operation from being processed properly.

PROTOCOL_ERROR

public static final ResultCode PROTOCOL_ERROR

The result code that indicates that the client sent a malformed or illegal request to the server.

TIME_LIMIT_EXCEEDED

public static final ResultCode TIME_LIMIT_EXCEEDED

The result code that indicates that a time limit was exceeded while attempting to process the request.

SIZE_LIMIT_EXCEEDED

public static final ResultCode SIZE_LIMIT_EXCEEDED

The result code that indicates that a size limit was exceeded while attempting to process the request.

COMPARE_FALSE

public static final ResultCode COMPARE_FALSE

The result code that indicates that the attribute value assertion included in a compare request did not match the targeted entry.

COMPARE_TRUE

public static final ResultCode COMPARE_TRUE

The result code that indicates that the attribute value assertion included in a compare request did match the targeted entry.

AUTH_METHOD_NOT_SUPPORTED

public static final ResultCode AUTH_METHOD_NOT_SUPPORTED

The result code that indicates that the requested authentication attempt failed because it referenced an invalid SASL mechanism.

STRONG_AUTH_REQUIRED

public static final ResultCode STRONG_AUTH_REQUIRED

The result code that indicates that the requested operation could not be processed because it requires that the client has completed a strong form of authentication.

REFERRAL

public static final ResultCode REFERRAL

The result code that indicates that a referral was encountered.

ADMIN_LIMIT_EXCEEDED

public static final ResultCode ADMIN_LIMIT_EXCEEDED

The result code that indicates that processing on the requested operation could not continue because an administrative limit was exceeded.

UNAVAILABLE_CRITICAL_EXTENSION

public static final ResultCode UNAVAILABLE_CRITICAL_EXTENSION

The result code that indicates that the requested operation failed because it included a critical extension that is unsupported or inappropriate for that request.

CONFIDENTIALITY_REQUIRED

public static final ResultCode CONFIDENTIALITY_REQUIRED

The result code that indicates that the requested operation could not be processed because it requires confidentiality for the communication between the client and the server.

SASL_BIND_IN_PROGRESS

public static final ResultCode SASL_BIND_IN_PROGRESS

The result code that should be used for intermediate responses in multi-stage SASL bind operations.

NO_SUCH_ATTRIBUTE

public static final ResultCode NO_SUCH_ATTRIBUTE

The result code that indicates that the requested operation failed because it targeted an attribute or attribute value that did not exist in the specified entry.

UNDEFINED_ATTRIBUTE_TYPE

public static final ResultCode UNDEFINED_ATTRIBUTE_TYPE

The result code that indicates that the requested operation failed because it referenced an attribute that is not defined in the server schema.

INAPPROPRIATE_MATCHING

public static final ResultCode INAPPROPRIATE_MATCHING

The result code that indicates that the requested operation failed because it attempted to perform an inappropriate type of matching against an attribute.

CONSTRAINT_VIOLATION

public static final ResultCode CONSTRAINT_VIOLATION

The result code that indicates that the requested operation failed because it would have violated some constraint defined in the server.

ATTRIBUTE_OR_VALUE_EXISTS

public static final ResultCode ATTRIBUTE_OR_VALUE_EXISTS

The result code that indicates that the requested operation failed because it would have resulted in a conflict with an existing attribute or attribute value in the target entry.

INVALID_ATTRIBUTE_SYNTAX

public static final ResultCode INVALID_ATTRIBUTE_SYNTAX

The result code that indicates that the requested operation failed because it violated the syntax for a specified attribute.

NO_SUCH_OBJECT

public static final ResultCode NO_SUCH_OBJECT

The result code that indicates that the requested operation failed because it referenced an entry that does not exist.

ALIAS_PROBLEM

public static final ResultCode ALIAS_PROBLEM

The result code that indicates that the requested operation failed because it attempted to perform an illegal operation on an alias.

INVALID_DN_SYNTAX

public static final ResultCode INVALID_DN_SYNTAX

The result code that indicates that the requested operation failed because it would have resulted in an entry with an invalid or malformed DN.

ALIAS_DEREFERENCING_PROBLEM

public static final ResultCode ALIAS_DEREFERENCING_PROBLEM

The result code that indicates that a problem was encountered while attempting to dereference an alias for a search operation.

INAPPROPRIATE_AUTHENTICATION

public static final ResultCode INAPPROPRIATE_AUTHENTICATION

The result code that indicates that an authentication attempt failed because the requested type of authentication was not appropriate for the targeted entry.

INVALID_CREDENTIALS

public static final ResultCode INVALID_CREDENTIALS

The result code that indicates that an authentication attempt failed because the user did not provide a valid set of credentials.

INSUFFICIENT_ACCESS_RIGHTS

public static final ResultCode INSUFFICIENT_ACCESS_RIGHTS

The result code that indicates that the client does not have sufficient permission to perform the requested operation.

BUSY

public static final ResultCode BUSY

The result code that indicates that the server is too busy to process the requested operation.

UNAVAILABLE

public static final ResultCode UNAVAILABLE

The result code that indicates that either the entire server or one or more required resources were not available for use in processing the request.

UNWILLING_TO_PERFORM

public static final ResultCode UNWILLING_TO_PERFORM

The result code that indicates that the server is unwilling to perform the requested operation.

LOOP_DETECT

public static final ResultCode LOOP_DETECT

The result code that indicates that a referral or chaining loop was detected while processing the request.

SORT_CONTROL_MISSING

public static final ResultCode SORT_CONTROL_MISSING

The result code that indicates that a search request included a VLV request control without a server-side sort control.

OFFSET_RANGE_ERROR

public static final ResultCode OFFSET_RANGE_ERROR

The result code that indicates that a search request included a VLV request control with an invalid offset.

NAMING_VIOLATION

public static final ResultCode NAMING_VIOLATION

The result code that indicates that the requested operation failed because it would have violated the server's naming configuration.

OBJECTCLASS_VIOLATION

public static final ResultCode OBJECTCLASS_VIOLATION

The result code that indicates that the requested operation failed because it would have resulted in an entry that violated the server schema.

NOT_ALLOWED_ON_NONLEAF

public static final ResultCode NOT_ALLOWED_ON_NONLEAF

The result code that indicates that the requested operation is not allowed for non-leaf entries.

NOT_ALLOWED_ON_RDN

public static final ResultCode NOT_ALLOWED_ON_RDN

The result code that indicates that the requested operation is not allowed on an RDN attribute.

ENTRY_ALREADY_EXISTS

public static final ResultCode ENTRY_ALREADY_EXISTS

The result code that indicates that the requested operation failed because it would have resulted in an entry that conflicts with an entry that already exists.

OBJECTCLASS_MODS_PROHIBITED

public static final ResultCode OBJECTCLASS_MODS_PROHIBITED

The result code that indicates that the operation could not be processed because it would have modified the objectclasses associated with an entry in an illegal manner.

AFFECTS_MULTIPLE_DSAS

public static final ResultCode AFFECTS_MULTIPLE_DSAS

The result code that indicates that the operation could not be processed because it would impact multiple DSAs or other repositories.

VIRTUAL_LIST_VIEW_ERROR

public static final ResultCode VIRTUAL_LIST_VIEW_ERROR

The result code that indicates that the operation could not be processed because there was an error while processing the virtual list view control.

OTHER

public static final ResultCode OTHER

The result code that should be used if no other result code is appropriate.

CLIENT_SIDE_SERVER_DOWN

public static final ResultCode CLIENT_SIDE_SERVER_DOWN

The client-side result code that should be used if an established connection is lost. This should not be used over protocol.

CLIENT_SIDE_LOCAL_ERROR

public static final ResultCode CLIENT_SIDE_LOCAL_ERROR

The client-side result code that should be used if a local (client-side) error occurs. This should not be used over protocol.

CLIENT_SIDE_ENCODING_ERROR

public static final ResultCode CLIENT_SIDE_ENCODING_ERROR

The client-side result code that should be used if an error occurs while encoding a request. This should not be used over protocol.

CLIENT_SIDE_DECODING_ERROR

public static final ResultCode CLIENT_SIDE_DECODING_ERROR

The client-side result code that should be used if an error occurs while decoding a response. This should not be used over protocol.

CLIENT_SIDE_TIMEOUT

public static final ResultCode CLIENT_SIDE_TIMEOUT

The client-side result code that should be used if a client-side timeout occurs. This should not be used over protocol.

CLIENT_SIDE_AUTH_UNKNOWN

public static final ResultCode CLIENT_SIDE_AUTH_UNKNOWN

The client-side result code that should be used if an unknown or unsupported authentication mechanism is requested. This should not be used over protocol.

CLIENT_SIDE_FILTER_ERROR

public static final ResultCode CLIENT_SIDE_FILTER_ERROR

The client-side result code that should be used if a malformed search filter is provided. This should not be used over protocol.

CLIENT_SIDE_USER_CANCELLED

public static final ResultCode CLIENT_SIDE_USER_CANCELLED

The client-side result code that should be used if a user cancelled a client-side operation. This should not be used over protocol.

CLIENT_SIDE_PARAM_ERROR

public static final ResultCode CLIENT_SIDE_PARAM_ERROR

The client-side result code that should be used if there was an error in the parameter(s) provided. This should not be used over protocol.

CLIENT_SIDE_NO_MEMORY

public static final ResultCode CLIENT_SIDE_NO_MEMORY

The client-side result code that should be used if the client cannot obtain enough memory to perform the requested operation. This should not be used over protocol.

CLIENT_SIDE_CONNECT_ERROR

public static final ResultCode CLIENT_SIDE_CONNECT_ERROR

The client-side result code that should be used if a connection cannot be established. This should not be used over protocol.

CLIENT_SIDE_NOT_SUPPORTED

public static final ResultCode CLIENT_SIDE_NOT_SUPPORTED

The client-side result code that should be used if a user requests an unsupported operation. This should not be used over protocol.

CLIENT_SIDE_CONTROL_NOT_FOUND

public static final ResultCode CLIENT_SIDE_CONTROL_NOT_FOUND

The client-side result code that should be used if an expected control is not found in a response. This should not be used over protocol.

CLIENT_SIDE_NO_RESULTS_RETURNED

public static final ResultCode CLIENT_SIDE_NO_RESULTS_RETURNED

The client-side result code that should be used if no results were returned for a search operation that expected them. This should not be used over protocol.

CLIENT_SIDE_MORE_RESULTS_TO_RETURN

public static final ResultCode CLIENT_SIDE_MORE_RESULTS_TO_RETURN

The client-side result code that should be used if there are more results to be processed. This should not be used over protocol.

CLIENT_SIDE_CLIENT_LOOP

public static final ResultCode CLIENT_SIDE_CLIENT_LOOP

The client-side result code that should be used if a referral loop is detected. This should not be used over protocol.

CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED

public static final ResultCode CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED

The client-side result code that should be used if the referral hop limit was exceeded. This should not be used over protocol.

CANCELED

public static final ResultCode CANCELED

The result code that indicates that a cancel request was successful, or that the specified operation was canceled.

NO_SUCH_OPERATION

public static final ResultCode NO_SUCH_OPERATION

The result code that indicates that a cancel request was unsuccessful because the targeted operation did not exist or had already completed.

TOO_LATE

public static final ResultCode TOO_LATE

The result code that indicates that a cancel request was unsuccessful because processing on the targeted operation had already reached a point at which it could not be canceled.

CANNOT_CANCEL

public static final ResultCode CANNOT_CANCEL

The result code that indicates that a cancel request was unsuccessful because the targeted operation was one that could not be canceled.

ASSERTION_FAILED

public static final ResultCode ASSERTION_FAILED

The result code that indicates that the filter contained in an assertion control failed to match the target entry.

AUTHORIZATION_DENIED

public static final ResultCode AUTHORIZATION_DENIED

The result code that should be used if the server will not allow the client to use the requested authorization.

NO_OPERATION

public static final ResultCode NO_OPERATION

The result code that should be used if the server did not actually complete processing on the associated operation because the request included the LDAP No-Op control.

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

getIntValue

public int getIntValue()

Retrieves the integer value for this result code.

Returns:

The integer value for this result code.

valueOf

public static ResultCode valueOf(int intValue)

Retrieves the result code with the provided int value.

Parameters:

intValue - The value for which to retrieve the corresponding result code.

Returns:

The result code with the provided int value, or ResultCode.OTHER if there is no recognized result code with the provided int value.

toString

public java.lang.String toString()

Retrieves a string representation of this result code.

Overrides:

toString in class java.lang.Enum<ResultCode>

Returns:

A string representation of this result code.

isSuccess

public boolean isSuccess()

Indicates whether or not this result code represents a success result.

Returns:

true if this result code represents a success result; false otherwise.

Skip navigation links