Uses of Interface
org.forgerock.opendj.ldap.messages.Result
Package
Description
Classes and interfaces providing I/O functionality.
Classes and interfaces for core types including connections, entries, and
attributes.
Classes and interfaces for core LDAP requests/responses.
Classes and interfaces for reading and writing LDIF.
Classes implementing core server APIs.
Contains a number of API declarations for use throughout the Directory Server.
Defines the Directory Server plugin API.
Contains various classes that comprise the core of the Directory Server codebase.
Contains implementations of Directory Server access, error, and debug loggers.
Contains various Directory Server connection handler implementations which will be used to accept connections from
and perform communication with clients over various protocols.
Contains implementations for a number of Directory Server data types.
-
Uses of Result in org.forgerock.opendj.io
Modifier and TypeMethodDescriptionvoid
LdapWriter.writeAddResult
(int messageID, Result result) Writes the provided add result.void
LdapWriter.writeBindResult
(int messageID, Result result) Writes the provided bind result.void
LdapWriter.writeCompareResult
(int messageID, Result result) Writes the provided compare result.void
LdapWriter.writeDeleteResult
(int messageID, Result result) Writes the provided delete result.void
LdapWriter.writeExtendedResult
(int messageID, Result result) Writes the provided extended result.void
LdapWriter.writeModifyDnResult
(int messageID, Result result) Writes the provided modify DN result.void
LdapWriter.writeModifyResult
(int messageID, Result result) Writes the provided extended result.void
LdapWriter.writeSearchResult
(int messageID, Result result) Writes the provided search result. -
Uses of Result in org.forgerock.opendj.ldap
Modifier and TypeMethodDescriptionAbstractAsynchronousConnection.add
(AddRequest request) Adds an entry to the Directory Server using the provided lines of LDIF.Adds the provided entry to the Directory Server.AbstractConnectionWrapper.add
(AddRequest request) Adds an entry to the Directory Server using the provided add request.Adds an entry to the Directory Server using the provided lines of LDIF.Adds the provided entry to the Directory Server.Connection.add
(AddRequest request) Adds an entry to the Directory Server using the provided add request.AbstractConnection.applyChange
(ChangeRecord request) AbstractConnectionWrapper.applyChange
(ChangeRecord request) Applies the provided change request to the Directory Server.Connection.applyChange
(ChangeRecord request) Applies the provided change request to the Directory Server.AbstractAsynchronousConnection.delete
(DeleteRequest request) Deletes the named entry from the Directory Server.AbstractConnectionWrapper.delete
(DeleteRequest request) Deletes an entry from the Directory Server using the provided delete request.Deletes the named entry from the Directory Server.default Result
Deletes the named entry from the Directory Server.Connection.delete
(DeleteRequest request) Deletes an entry from the Directory Server using the provided delete request.AbstractConnection.deleteSubtree
(String name) AbstractConnectionWrapper.deleteSubtree
(String name) Deletes the named entry and all of its subordinates from the Directory Server.Connection.deleteSubtree
(String name) Deletes the named entry and all of its subordinates from the Directory Server.final Result
LdapException.getResult()
Returns the error result which caused this exception to be thrown.AbstractAsynchronousConnection.modify
(ModifyRequest request) Modifies an entry in the Directory Server using the provided lines of LDIF.AbstractConnectionWrapper.modify
(ModifyRequest request) Modifies an entry in the Directory Server using the provided modify request.Modifies an entry in the Directory Server using the provided lines of LDIF.Connection.modify
(ModifyRequest request) Modifies an entry in the Directory Server using the provided modify request.AbstractAsynchronousConnection.modifyDn
(ModifyDnRequest request) Renames the named entry in the Directory Server using the provided new RDN.AbstractConnectionWrapper.modifyDn
(ModifyDnRequest request) Renames an entry in the Directory Server using the provided modify DN request.Renames the named entry in the Directory Server using the provided new RDN.Connection.modifyDn
(ModifyDnRequest request) Renames an entry in the Directory Server using the provided modify DN request.AbstractAsynchronousConnection.search
(SearchRequest request, SearchResultHandler handler) AbstractConnection.search
(SearchRequest request, Collection<? super SearchResultEntry> entries) AbstractConnection.search
(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references) AbstractConnectionWrapper.search
(SearchRequest request, Collection<? super SearchResultEntry> entries) Searches the Directory Server using the provided search request.AbstractConnectionWrapper.search
(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references) Searches the Directory Server using the provided search request.AbstractConnectionWrapper.search
(SearchRequest request, SearchResultHandler handler) Searches the Directory Server using the provided search request.Connection.search
(SearchRequest request, Collection<? super SearchResultEntry> entries) Searches the Directory Server using the provided search request.Connection.search
(SearchRequest request, Collection<? super SearchResultEntry> entries, Collection<? super SearchResultReference> references) Searches the Directory Server using the provided search request.Connection.search
(SearchRequest request, SearchResultHandler handler) Searches the Directory Server using the provided search request.Modifier and TypeMethodDescriptionLdapClientSocket.add
(AddRequest request) Adds an entry to the Directory Server using the provided add request.AbstractConnection.addAsync
(AddRequest request) AbstractConnectionWrapper.addAsync
(AddRequest request) Asynchronously adds an entry to the Directory Server using the provided add request.AbstractConnectionWrapper.addAsync
(AddRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously adds an entry to the Directory Server using the provided add request.AbstractSynchronousConnection.addAsync
(AddRequest request, IntermediateResponseHandler intermediateResponseHandler) Connection.addAsync
(AddRequest request) Asynchronously adds an entry to the Directory Server using the provided add request.Connection.addAsync
(AddRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously adds an entry to the Directory Server using the provided add request.LdapClientSocket.applyChange
(ChangeRecord request) Applies the provided change request to the Directory Server.AbstractConnection.applyChangeAsync
(ChangeRecord request) AbstractConnection.applyChangeAsync
(ChangeRecord request, IntermediateResponseHandler intermediateResponseHandler) AbstractConnectionWrapper.applyChangeAsync
(ChangeRecord request) Asynchronously applies the provided change request to the Directory Server.AbstractConnectionWrapper.applyChangeAsync
(ChangeRecord request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously applies the provided change request to the Directory Server.Connection.applyChangeAsync
(ChangeRecord request) Asynchronously applies the provided change request to the Directory Server.Connection.applyChangeAsync
(ChangeRecord request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously applies the provided change request to the Directory Server.RequestHandle.cancel()
Returns aSingle<Result>
which, once subscribed, will attempt to cancel the operation.LdapClientSocket.delete
(DeleteRequest request) Deletes an entry from the Directory Server using the provided delete request.AbstractConnection.deleteAsync
(DeleteRequest request) AbstractConnectionWrapper.deleteAsync
(DeleteRequest request) Asynchronously deletes an entry from the Directory Server using the provided delete request.AbstractConnectionWrapper.deleteAsync
(DeleteRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously deletes an entry from the Directory Server using the provided delete request.AbstractSynchronousConnection.deleteAsync
(DeleteRequest request, IntermediateResponseHandler intermediateResponseHandler) Connection.deleteAsync
(DeleteRequest request) Asynchronously deletes an entry from the Directory Server using the provided delete request.Connection.deleteAsync
(DeleteRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously deletes an entry from the Directory Server using the provided delete request.LdapClientSocket.modify
(ModifyRequest request) Modifies an entry in the Directory Server using the provided modify request.AbstractConnection.modifyAsync
(ModifyRequest request) AbstractConnectionWrapper.modifyAsync
(ModifyRequest request) Asynchronously modifies an entry in the Directory Server using the provided modify request.AbstractConnectionWrapper.modifyAsync
(ModifyRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously modifies an entry in the Directory Server using the provided modify request.AbstractSynchronousConnection.modifyAsync
(ModifyRequest request, IntermediateResponseHandler intermediateResponseHandler) Connection.modifyAsync
(ModifyRequest request) Asynchronously modifies an entry in the Directory Server using the provided modify request.Connection.modifyAsync
(ModifyRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously modifies an entry in the Directory Server using the provided modify request.LdapClientSocket.modifyDn
(ModifyDnRequest request) Renames an entry in the Directory Server using the provided modify DN request.AbstractConnection.modifyDnAsync
(ModifyDnRequest request) AbstractConnectionWrapper.modifyDnAsync
(ModifyDnRequest request) Asynchronously renames an entry in the Directory Server using the provided modify DN request.AbstractConnectionWrapper.modifyDnAsync
(ModifyDnRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously renames an entry in the Directory Server using the provided modify DN request.AbstractSynchronousConnection.modifyDnAsync
(ModifyDnRequest request, IntermediateResponseHandler intermediateResponseHandler) Connection.modifyDnAsync
(ModifyDnRequest request) Asynchronously renames an entry in the Directory Server using the provided modify DN request.Connection.modifyDnAsync
(ModifyDnRequest request, IntermediateResponseHandler intermediateResponseHandler) Asynchronously renames an entry in the Directory Server using the provided modify DN request.AbstractConnection.searchAsync
(SearchRequest request, SearchResultHandler resultHandler) AbstractConnectionWrapper.searchAsync
(SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler) Asynchronously searches the Directory Server using the provided search request.AbstractConnectionWrapper.searchAsync
(SearchRequest request, SearchResultHandler resultHandler) Asynchronously searches the Directory Server using the provided search request.AbstractSynchronousConnection.searchAsync
(SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler) Connection.searchAsync
(SearchRequest request, IntermediateResponseHandler intermediateResponseHandler, SearchResultHandler entryHandler) Asynchronously searches the Directory Server using the provided search request.Connection.searchAsync
(SearchRequest request, SearchResultHandler entryHandler) Asynchronously searches the Directory Server using the provided search request.Modifier and TypeMethodDescriptionstatic LdapException
LdapException.newLdapException
(Result result) Creates a new LDAP exception using the provided result.ModifierConstructorDescriptionprotected
LdapException
(Result result) Creates a new LDAP exception using the provided result. -
Uses of Result in org.forgerock.opendj.ldap.messages
Modifier and TypeInterfaceDescriptioninterface
A Bind result indicates the status of the client's request for authentication.interface
An Compare result indicates the final status of an Compare operation.interface
A Extended result indicates the status of an Extended operation and any additional information associated with the Extended operation, including the optional response name and value.interface
A Generic Extended result indicates the final status of an Generic Extended operation.interface
The password modify extended result as defined in RFC 3062.interface
The start tls extended result as defined in RFC 4511.interface
The who am I extended result as defined in RFC 4532.Modifier and TypeClassDescriptionclass
AbstractExtendedResult<S extends ExtendedResult>
An abstract Extended result which can be used as the basis for implementing new Extended operations.Modifier and TypeMethodDescriptionResult.addControl
(Control control) Result.addControls
(Iterable<? extends Control> controls) Result.addReferralUri
(String uri) Adds the provided referral URI to this result.default Result
Copies the result code, cause, diagnostic message, matched DN and referral URIs from the provided result to this result.static Result
Responses.copyOfResult
(Result result) Creates a new result that is an exact copy of the provided result.static Result
Responses.newResult
(ResultCode resultCode) Creates a new result using the provided result code.Result.removeControls
(String oid) Sets the throwable cause associated with this result if available.Result.setDiagnosticMessage
(CharSequence message) Sets the diagnostic message associated with this result.Result.setMatchedDn
(String dn) Sets the matched DN associated with this result.Result.setMatchedDn
(Dn dn) Sets the matched DN associated with this result.Result.setResultCode
(ResultCode resultCode) Sets the result code associated with this result.static Result
Responses.unmodifiableResult
(Result result) Creates an unmodifiable result using the provided response.Modifier and TypeMethodDescriptiondefault Result
Copies the result code, cause, diagnostic message, matched DN and referral URIs from the provided result to this result.static Result
Responses.copyOfResult
(Result result) Creates a new result that is an exact copy of the provided result.static LdapMessage
LdapMessage.newSearchResultDoneMessage
(int messageId, Result result) Builds and returns anLdapMessage
for a search result done operation type.static Result
Responses.unmodifiableResult
(Result result) Creates an unmodifiable result using the provided response. -
Uses of Result in org.forgerock.opendj.ldif
Modifier and TypeMethodDescriptionConnectionEntryReader.readResult()
Waits for the next search response to become available and returns it if it is a search result indicating that the search completed successfully. -
Uses of Result in org.forgerock.opendj.server.core
Modifier and TypeMethodDescriptionRequestCancellationState.cancel
(boolean notifyClient, LocalizableMessage reason) Notifies backend processing that the request should be aborted if possible, and whether or not responses should be sent. -
Uses of Result in org.opends.server.api
Modifier and TypeMethodDescriptionClientConnection.cancelRequest
(int msgId, boolean notifyClient, LocalizableMessage reason) Attempts to cancel the request having the specified message ID, blocking until either the targeted request is cancelled or completed.protected static Result
ClientConnection.convertResult
(Request request, Result result) -
Uses of Result in org.opends.server.api.plugin
Modifier and TypeMethodDescriptionPluginResult.IntermediateResponse.result()
Returns the value of theresult
record component.PluginResult.OperationResult.result()
The result for this plugin result.PluginResult.PostOperation.result()
Returns the value of theresult
record component.PluginResult.PreOperation.result()
Returns the value of theresult
record component.PluginResult.PreParse.result()
Returns the value of theresult
record component.PluginResult.SubordinateDelete.result()
Returns the value of theresult
record component.PluginResult.SubordinateModifyDN.result()
Returns the value of theresult
record component.ModifierConstructorDescriptionIntermediateResponse
(boolean continueProcessing, boolean continuePluginProcessing, boolean sendResponse, Result result) Creates an instance of aIntermediateResponse
record class.PostOperation
(boolean continueProcessing, Result result) Creates an instance of aPostOperation
record class.PreOperation
(boolean continueProcessing, boolean continuePluginProcessing, Result result) Creates an instance of aPreOperation
record class.Creates an instance of aPreParse
record class.SubordinateDelete
(boolean continueProcessing, boolean continuePluginProcessing, Result result) Creates an instance of aSubordinateDelete
record class.SubordinateModifyDN
(boolean continueProcessing, boolean continuePluginProcessing, Result result) Creates an instance of aSubordinateModifyDN
record class. -
Uses of Result in org.opends.server.core
Modifier and TypeMethodDescriptionprotected Result
BindOperation.operationToResult()
protected Result
ExtendedOperation.operationToResult()
-
Uses of Result in org.opends.server.loggers
Modifier and TypeMethodDescriptionvoid
AccessLogPublisher.logAbandonResult
(RequestContext context, AbandonRequest request, Result result) Writes a message to the access logger with information about the provided result.void
TextAccessLogPublisher.logAbandonResult
(RequestContext context, AbandonRequest request, Result result) void
AccessLogPublisher.logAddResult
(RequestContext context, AddRequest request, Result result) Writes a message to the access logger with information about the add result.void
TextAccessLogPublisher.logAddResult
(RequestContext context, AddRequest request, Result result) void
TextAuditLogPublisher.logAddResult
(RequestContext context, AddRequest request, Result result) void
AccessLogPublisher.logBindResult
(RequestContext context, BindRequest request, Result result) Writes a message to the access logger with information about the bind result.void
TextAccessLogPublisher.logBindResult
(RequestContext context, BindRequest request, Result result) void
AccessLogPublisher.logCompareResult
(RequestContext context, CompareRequest request, Result result) Writes a message to the access logger with information about the compare result.void
TextAccessLogPublisher.logCompareResult
(RequestContext context, CompareRequest request, Result result) void
AccessLogPublisher.logDeleteResult
(RequestContext context, DeleteRequest request, Result result) Writes a message to the access logger with information about the delete result.void
TextAccessLogPublisher.logDeleteResult
(RequestContext context, DeleteRequest request, Result result) void
TextAuditLogPublisher.logDeleteResult
(RequestContext context, DeleteRequest request, Result result) void
AccessLogPublisher.logExtendedResult
(RequestContext context, ExtendedRequest<?> request, Result result) Writes a message to the access logger with information about the extended result.void
TextAccessLogPublisher.logExtendedResult
(RequestContext context, ExtendedRequest<?> request, Result result) void
AccessLogPublisher.logInvalidResult
(RequestContext context, InvalidRequest request, Result result) Writes a message to the access logger with information about the result.void
TextAccessLogPublisher.logInvalidResult
(RequestContext context, InvalidRequest request, Result result) void
AccessLogPublisher.logModifyDnResult
(RequestContext context, ModifyDnRequest request, Result result) Writes a message to the access logger with information about the modifyDN result.void
TextAccessLogPublisher.logModifyDnResult
(RequestContext context, ModifyDnRequest request, Result result) void
TextAuditLogPublisher.logModifyDnResult
(RequestContext context, ModifyDnRequest request, Result result) void
AccessLogPublisher.logModifyResult
(RequestContext context, ModifyRequest request, Result result) Writes a message to the access logger with information about the modify result.void
TextAccessLogPublisher.logModifyResult
(RequestContext context, ModifyRequest request, Result result) void
TextAuditLogPublisher.logModifyResult
(RequestContext context, ModifyRequest request, Result result) static void
AccessLogger.logResult
(RequestContext context, Request request, Result result) Writes a message to the access logger with information about the provided request and result.void
AccessLogPublisher.logSearchResult
(RequestContext context, SearchRequest request, Result result) Writes a message to the access logger with information about the search result.void
TextAccessLogPublisher.logSearchResult
(RequestContext context, SearchRequest request, Result result) -
Uses of Result in org.opends.server.protocols
Modifier and TypeMethodDescriptionstatic void
ReactiveHandlersUtils.emitResult
(Result result, FlowableEmitter<Response> out) Emits a result to the provided reactive emitter, to signal completion of a request. -
Uses of Result in org.opends.server.types
Modifier and TypeMethodDescriptionprotected Result
Operation.operationToResult()
Generates a result for this operation.SynchronizationProviderResult.ContinueProcessing.result()
SynchronizationProviderResult.StopProcessing.result()
Returns the value of theresult
record component.protected final Result
Operation.sendResult()
Sends the result for this operation.Modifier and TypeMethodDescriptionprotected static LdapException
Operation.createLdapException
(Operation operation, Entry entry, Dn entryDN, Result result, Result altResult) Returns a newLdapException
built from the provided resultCodes and messages.final void
Specifies the result for this operation.protected static void
Operation.setResultCodeAndMessageNoInfoDisclosure
(Operation operation, Entry entry, Dn entryDN, Result realResult, Result altResult) Sets the provided resultCodes and messages on the provided operation.ModifierConstructorDescriptionStopProcessing
(Result result) Creates an instance of aStopProcessing
record class.