Uses of Class
org.forgerock.opendj.ldap.ResultCode

Packages that use ResultCode

Package	Description
org.forgerock.opendj.config.server	Server-side administration interface.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.controls	Classes and interfaces for common LDAP controls.
org.forgerock.opendj.ldap.messages	Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.server.core	Classes implementing core server APIs.
org.opends.server.api.plugin	Defines the Directory Server plugin API.
org.opends.server.types	Contains implementations for a number of Directory Server data types.
org.opends.server.types.operation	Contains a number of interfaces that are implemented by the various types of Directory Server operations.

Uses of ResultCode in org.forgerock.opendj.config.server

Methods in org.forgerock.opendj.config.server that return ResultCode

Modifier and Type	Method	Description
ResultCode	ConfigChangeResult.getResultCode()	Retrieves the result code for this config change result.

Methods in org.forgerock.opendj.config.server with parameters of type ResultCode

Modifier and Type	Method	Description
void	ConfigChangeResult.setResultCode(ResultCode resultCode)	Specifies the result code for this config change result.
void	ConfigChangeResult.setResultCodeIfSuccess(ResultCode newResultCode)	Sets the provided result code for this config change result if the current result code is success.

Uses of ResultCode in org.forgerock.opendj.ldap

Fields in org.forgerock.opendj.ldap declared as ResultCode

Modifier and Type	Field	Description
static ResultCode	ResultCode.ADMIN_LIMIT_EXCEEDED	The result code that indicates that processing on the requested operation could not continue because an administrative limit was exceeded.
static ResultCode	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.
static ResultCode	ResultCode.ALIAS_DEREFERENCING_PROBLEM	The result code that indicates that a problem was encountered while attempting to dereference an alias for a search operation.
static ResultCode	ResultCode.ALIAS_PROBLEM	The result code that indicates that the requested operation failed because it attempted to perform an illegal operation on an alias.
static ResultCode	ResultCode.ASSERTION_FAILED	The result code that indicates that the filter contained in an assertion control failed to match the target entry.
static ResultCode	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.
static ResultCode	ResultCode.AUTH_METHOD_NOT_SUPPORTED	The result code that indicates that the requested authentication attempt failed because it referenced an invalid SASL mechanism.
static ResultCode	ResultCode.AUTHORIZATION_DENIED	The result code that should be used if the server will not allow the client to use the requested authorization.
static ResultCode	ResultCode.BUSY	The result code that indicates that the server is too busy to process the requested operation.
static ResultCode	ResultCode.CANCELLED	The result code that indicates that a request has been cancelled by a cancel request.
static ResultCode	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.
static ResultCode	ResultCode.CLIENT_SIDE_AUTH_UNKNOWN	The client-side result code that indicates that the user requested an unknown or unsupported authentication mechanism.
static ResultCode	ResultCode.CLIENT_SIDE_CLIENT_LOOP	The client-side result code that indicates that the client detected a referral loop caused by servers referencing each other in a circular manner.
static ResultCode	ResultCode.CLIENT_SIDE_CONNECT_ERROR	The client-side result code that indicates that the client was not able to establish a connection to the server.
static ResultCode	ResultCode.CLIENT_SIDE_CONTROL_NOT_FOUND	The client-side result code that indicates that the client expected a control to be present in the response from the server but it was not included.
static ResultCode	ResultCode.CLIENT_SIDE_DECODING_ERROR	The client-side result code that indicates that an error occurred while decoding a response from the server.
static ResultCode	ResultCode.CLIENT_SIDE_ENCODING_ERROR	The client-side result code that indicates that an error occurred while encoding a request to send to the server.
static ResultCode	ResultCode.CLIENT_SIDE_FILTER_ERROR	The client-side result code that indicates that the filter provided by the user was malformed and could not be parsed.
static ResultCode	ResultCode.CLIENT_SIDE_LOCAL_ERROR	The client-side result code that indicates that a local error occurred that had nothing to do with interaction with the server.
static ResultCode	ResultCode.CLIENT_SIDE_NO_MEMORY	The client-side result code that indicates that the client application was not able to allocate enough memory for the requested operation.
static ResultCode	ResultCode.CLIENT_SIDE_NO_RESULTS_RETURNED	The client-side result code that indicates that the requested single entry search operation or read operation failed because the Directory Server did not return any matching entries.
static ResultCode	ResultCode.CLIENT_SIDE_NOT_SUPPORTED	The client-side result code that indicates that the user requested an operation that is not supported.
static ResultCode	ResultCode.CLIENT_SIDE_PARAM_ERROR	The client-side result code that indicates that there was a problem with one or more of the parameters provided by the user.
static ResultCode	ResultCode.CLIENT_SIDE_REFERRAL_LIMIT_EXCEEDED	The client-side result code that indicates that the client reached the maximum number of hops allowed when attempting to follow a referral (i.e., following one referral resulted in another referral which resulted in another referral and so on).
static ResultCode	ResultCode.CLIENT_SIDE_SERVER_DOWN	The client-side result code that indicates that the server is down.
static ResultCode	ResultCode.CLIENT_SIDE_TIMEOUT	The client-side result code that indicates that the client did not receive an expected response in a timely manner.
static ResultCode	ResultCode.CLIENT_SIDE_UNEXPECTED_RESULTS_RETURNED	The client-side result code that the requested single entry search operation or read operation failed because the Directory Server returned multiple matching entries (or search references) when only a single matching entry was expected.
static ResultCode	ResultCode.CLIENT_SIDE_USER_CANCELLED	The client-side result code that indicates that the user cancelled an operation.
static ResultCode	ResultCode.COMPARE_FALSE	The result code that indicates that the attribute value assertion included in a compare request did not match the targeted entry.
static ResultCode	ResultCode.COMPARE_TRUE	The result code that indicates that the attribute value assertion included in a compare request did match the targeted entry.
static ResultCode	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.
static ResultCode	ResultCode.CONSTRAINT_VIOLATION	The result code that indicates that the requested operation failed because it would have violated some constraint defined in the server.
static ResultCode	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.
static ResultCode	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.
static ResultCode	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.
static ResultCode	ResultCode.INSUFFICIENT_ACCESS_RIGHTS	The result code that indicates that the client does not have sufficient permission to perform the requested operation.
static ResultCode	ResultCode.INVALID_ATTRIBUTE_SYNTAX	The result code that indicates that the requested operation failed because it violated the syntax for a specified attribute.
static ResultCode	ResultCode.INVALID_CREDENTIALS	The result code that indicates that an authentication attempt failed because the user did not provide a valid set of credentials.
static ResultCode	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.
static ResultCode	ResultCode.LOOP_DETECT	The result code that indicates that a referral or chaining loop was detected while processing the request.
static ResultCode	ResultCode.NAMING_VIOLATION	The result code that indicates that the requested operation failed because it would have violated the server's naming configuration.
static ResultCode	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.
static ResultCode	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.
static ResultCode	ResultCode.NO_SUCH_OBJECT	The result code that indicates that the requested operation failed because it referenced an entry that does not exist.
static ResultCode	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.
static ResultCode	ResultCode.NOT_ALLOWED_ON_NONLEAF	The result code that indicates that the requested operation is not allowed for non-leaf entries.
static ResultCode	ResultCode.NOT_ALLOWED_ON_RDN	The result code that indicates that the requested operation is not allowed on an RDN attribute.
static ResultCode	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.
static ResultCode	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.
static ResultCode	ResultCode.OFFSET_RANGE_ERROR	The result code that indicates that a search request included a VLV request control with an invalid offset.
static ResultCode	ResultCode.OPERATIONS_ERROR	The result code that indicates that the operation is not properly sequenced with relation to other operations (of same or different type).
static ResultCode	ResultCode.OTHER	The result code that should be used if no other result code is appropriate.
static ResultCode	ResultCode.PROTOCOL_ERROR	The result code that indicates that the client sent a malformed or illegal request to the server.
static ResultCode	ResultCode.REFERRAL	The result code that indicates that a referral was encountered.
static ResultCode	ResultCode.SASL_BIND_IN_PROGRESS	The result code that should be used for intermediate responses in multi-stage SASL bind operations.
static ResultCode	ResultCode.SIZE_LIMIT_EXCEEDED	The result code that indicates that a size limit was exceeded while attempting to process the request.
static ResultCode	ResultCode.SORT_CONTROL_MISSING	The result code that indicates that a search request included a VLV request control without a server-side sort control.
static ResultCode	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.
static ResultCode	ResultCode.SUCCESS	The result code that indicates that the operation completed successfully.
static ResultCode	ResultCode.TIME_LIMIT_EXCEEDED	The result code that indicates that a time limit was exceeded while attempting to process the request.
static ResultCode	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.
static ResultCode	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.
static ResultCode	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.
static ResultCode	ResultCode.UNDEFINED	The result code that should only be used if the actual result code has not yet been determined.
static ResultCode	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.
static ResultCode	ResultCode.UNWILLING_TO_PERFORM	The result code that indicates that the server is unwilling to perform the requested operation.
static ResultCode	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.

Methods in org.forgerock.opendj.ldap that return ResultCode

Modifier and Type	Method	Description
ResultCode	LdapException.getResultCode()	Returns the result code associated with this result.
static ResultCode	ResultCode.internalServerErrorResultCode()	Returns the result code that should be used when the Directory Server encounters an internal server error.
static ResultCode	ResultCode.valueOf(int intValue)	Returns the result code having the specified integer value as defined in RFC 4511 section 4.1.9.

Methods in org.forgerock.opendj.ldap that return types with arguments of type ResultCode

Modifier and Type	Method	Description
static List<ResultCode>	ResultCode.values()	Returns an unmodifiable list containing the set of available result codes indexed on their integer value as defined in RFC 4511 section 4.1.9.

Methods in org.forgerock.opendj.ldap with parameters of type ResultCode

Modifier and Type	Method	Description
void	LdapSession.disconnect(ResultCode resultCode, CharSequence diagnosticMessage)	Disconnects the client and sends a disconnect notification, containing the provided result code and diagnostic message.
static LdapException	LdapException.newLdapException(ResultCode resultCode)	Creates a new LDAP exception with the provided result code and an empty diagnostic message.
static LdapException	LdapException.newLdapException(ResultCode resultCode, CharSequence diagnosticMessage)	Creates a new LDAP exception with the provided result code and diagnostic message.
static LdapException	LdapException.newLdapException(ResultCode resultCode, CharSequence diagnosticMessage, Throwable cause)	Creates a new LDAP exception with the provided result code, diagnostic message, and cause.
static LdapException	LdapException.newLdapException(ResultCode resultCode, CharSequence diagnosticMessage, Dn matchedDn, Throwable cause)	Creates a new LDAP exception with the provided resultCode, diagnosticMessage, matched DN and cause.
static LdapException	LdapException.newLdapException(ResultCode resultCode, Throwable cause)	Creates a new LDAP exception with the provided result code and cause.

Uses of ResultCode in org.forgerock.opendj.ldap.controls

Methods in org.forgerock.opendj.ldap.controls that return ResultCode

Modifier and Type	Method	Description
ResultCode	ServerSideSortResponseControl.getResult()	Returns a result code indicating the outcome of the server-side sort request.
ResultCode	VirtualListViewResponseControl.getResult()	Returns result code indicating the outcome of the virtual list view request.

Methods in org.forgerock.opendj.ldap.controls with parameters of type ResultCode

Modifier and Type	Method	Description
static ServerSideSortResponseControl	ServerSideSortResponseControl.newControl(ResultCode result)	Creates a new server-side response control with the provided sort result and no attribute description.
static ServerSideSortResponseControl	ServerSideSortResponseControl.newControl(ResultCode result, String attributeDescription)	Creates a new server-side response control with the provided sort result and attribute description.
static ServerSideSortResponseControl	ServerSideSortResponseControl.newControl(ResultCode result, AttributeDescription attributeDescription)	Creates a new server-side response control with the provided sort result and attribute description.
static VirtualListViewResponseControl	VirtualListViewResponseControl.newControl(int targetPosition, int contentCount, ResultCode result, ByteString contextId)	Creates a new virtual list view response control.

Uses of ResultCode in org.forgerock.opendj.ldap.messages

Methods in org.forgerock.opendj.ldap.messages that return ResultCode

Modifier and Type	Method	Description
ResultCode	BindResult.getResultCode()
ResultCode	CompareResult.getResultCode()
ResultCode	ExtendedResult.getResultCode()
ResultCode	GenericExtendedResult.getResultCode()
ResultCode	PasswordModifyExtendedResult.getResultCode()
ResultCode	Result.getResultCode()	Returns the result code associated with this result.
ResultCode	WhoAmIExtendedResult.getResultCode()

Methods in org.forgerock.opendj.ldap.messages with parameters of type ResultCode

Modifier and Type	Method	Description
static BindResult	Responses.newBindResult(ResultCode resultCode)	Creates a new bind result using the provided result code.
static CompareResult	Responses.newCompareResult(ResultCode resultCode)	Creates a new compare result using the provided result code.
abstract S	AbstractExtendedResultDecoder.newExtendedErrorResult(ResultCode resultCode, String matchedDN, CharSequence diagnosticMessage)
S	ExtendedResultDecoder.newExtendedErrorResult(ResultCode resultCode, String matchedDN, CharSequence diagnosticMessage)	Creates a new extended error result using the provided result code, matched DN, and diagnostic message.
static GenericExtendedResult	Responses.newGenericExtendedResult(ResultCode resultCode)	Creates a new generic extended result using the provided result code.
static PasswordModifyExtendedResult	Responses.newPasswordModifyExtendedResult(ResultCode resultCode)	Creates a new password modify extended result using the provided result code, and no generated password.
static Result	Responses.newResult(ResultCode resultCode)	Creates a new result using the provided result code.
static StartTlsExtendedResult	Responses.newStartTlsExtendedResult(ResultCode resultCode)	Creates a new start TLS extended result which will use the provided SSL context.
static WhoAmIExtendedResult	Responses.newWhoAmIExtendedResult(ResultCode resultCode)	Creates a new who am I extended result with the provided result code and no authorization ID.
BindResult	BindResult.setResultCode(ResultCode resultCode)
CompareResult	CompareResult.setResultCode(ResultCode resultCode)
ExtendedResult	ExtendedResult.setResultCode(ResultCode resultCode)
GenericExtendedResult	GenericExtendedResult.setResultCode(ResultCode resultCode)
PasswordModifyExtendedResult	PasswordModifyExtendedResult.setResultCode(ResultCode resultCode)
Result	Result.setResultCode(ResultCode resultCode)	Sets the result code associated with this result.
WhoAmIExtendedResult	WhoAmIExtendedResult.setResultCode(ResultCode resultCode)

Constructors in org.forgerock.opendj.ldap.messages with parameters of type ResultCode

Constructor	Description
AbstractExtendedResult(ResultCode resultCode)	Creates a new extended result using the provided result code.

Uses of ResultCode in org.forgerock.opendj.server.core

Methods in org.forgerock.opendj.server.core that return ResultCode

Modifier and Type	Method	Description
ResultCode	RequestContext.getMaskedResultCode()	Retrieves the real, masked result code for this operation.

Methods in org.forgerock.opendj.server.core with parameters of type ResultCode

Modifier and Type	Method	Description
void	RequestContext.setMaskedResultCode(ResultCode maskedResultCode)	Specifies the real, masked result code for this operation.

Uses of ResultCode in org.opends.server.api.plugin

Methods in org.opends.server.api.plugin with parameters of type ResultCode

Modifier and Type	Method	Description
static PluginResult.IntermediateResponse	PluginResult.IntermediateResponse.stopProcessing(boolean sendResponse, ResultCode resultCode, LocalizableMessage errorMessage)	Constructs a new stop processing intermediate response plugin result.
static PluginResult.IntermediateResponse	PluginResult.IntermediateResponse.stopProcessing(boolean sendResponse, ResultCode resultCode, LocalizableMessage errorMessage, Dn matchedDN, List<String> referralURLs)	Defines a new stop processing intermediate response plugin result.
static PluginResult.PostOperation	PluginResult.PostOperation.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage)	Constructs a new stop processing post operation plugin result.
static PluginResult.PostOperation	PluginResult.PostOperation.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage, Dn matchedDN, List<String> referralURLs)	Defines a new stop processing post operation plugin result.
static PluginResult.PreOperation	PluginResult.PreOperation.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage)	Constructs a new stop processing pre operation plugin result.
static PluginResult.PreOperation	PluginResult.PreOperation.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage, Dn matchedDN, List<String> referralURLs)	Defines a new stop processing pre operation plugin result.
static PluginResult.PreParse	PluginResult.PreParse.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage)	Constructs a new stop processing pre parse plugin result.
static PluginResult.PreParse	PluginResult.PreParse.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage, Dn matchedDN, List<String> referralURLs)	Defines a new stop processing pre parse plugin result.
static PluginResult.SubordinateDelete	PluginResult.SubordinateDelete.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage)	Constructs a new stop processing subordinate delete plugin result.
static PluginResult.SubordinateDelete	PluginResult.SubordinateDelete.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage, Dn matchedDN, List<String> referralURLs)	Defines a new stop processing subordinate delete plugin result.
static PluginResult.SubordinateModifyDN	PluginResult.SubordinateModifyDN.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage)	Constructs a new stop processing subordinate modify DN plugin result.
static PluginResult.SubordinateModifyDN	PluginResult.SubordinateModifyDN.stopProcessing(ResultCode resultCode, LocalizableMessage errorMessage, Dn matchedDN, List<String> referralURLs)	Defines a new stop processing subordinate modify DN plugin result.

Uses of ResultCode in org.opends.server.types

Methods in org.opends.server.types that return ResultCode

Modifier and Type	Method	Description
ResultCode	CancelResult.getResultCode()	Deprecated. Retrieves the result code associated with this cancel result.
ResultCode	DisconnectReason.getResultCode()	Returns the LDAP result code associated with this disconnect reason.
ResultCode	Operation.getResultCode()

Methods in org.opends.server.types with parameters of type ResultCode

Modifier and Type	Method	Description
void	Operation.setResultCode(ResultCode resultCode)	Specifies the result code for this operation.

Constructors in org.opends.server.types with parameters of type ResultCode

Constructor	Description
CancelResult(ResultCode resultCode, LocalizableMessage responseMessage)	Deprecated. Creates a new cancel result with the provided result code.

Uses of ResultCode in org.opends.server.types.operation

Methods in org.opends.server.types.operation that return ResultCode

Modifier and Type	Method	Description
ResultCode	InProgressOperation.getResultCode()	Retrieves the result code for this operation.
ResultCode	PostOperationOperation.getResultCode()	Retrieves the result code for this operation.
ResultCode	PostResponseOperation.getResultCode()	Retrieves the result code for this operation.
ResultCode	PostSynchronizationOperation.getResultCode()	Retrieves the result code for this operation.

Methods in org.opends.server.types.operation with parameters of type ResultCode

Modifier and Type	Method	Description
void	InProgressOperation.setResultCode(ResultCode resultCode)	Specifies the result code for this operation.
void	PostOperationOperation.setResultCode(ResultCode resultCode)	Specifies the result code for this operation.