| Package | Description |
|---|---|
| org.forgerock.opendj.io |
Classes and interfaces providing I/O functionality.
|
| org.forgerock.opendj.ldap |
Classes and interfaces for core types including connections, entries, and
attributes.
|
| org.forgerock.opendj.ldap.messages |
Classes and interfaces for core LDAP requests/responses.
|
| org.forgerock.opendj.ldif |
Classes and interfaces for reading and writing LDIF.
|
| Modifier and Type | Method and Description |
|---|---|
void |
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.
|
| Modifier and Type | Method and Description |
|---|---|
Result |
Connection.add(AddRequest request)
Adds an entry to the Directory Server using the provided add request.
|
Result |
AbstractConnectionWrapper.add(AddRequest request)
Adds an entry to the Directory Server using the provided add request.
|
Result |
AbstractAsynchronousConnection.add(AddRequest request) |
Result |
Connection.add(Entry entry)
Adds the provided entry to the Directory Server.
|
Result |
AbstractConnectionWrapper.add(Entry entry)
Adds the provided entry to the Directory Server.
|
Result |
AbstractConnection.add(Entry entry) |
Result |
Connection.add(String... ldifLines)
Adds an entry to the Directory Server using the provided lines of LDIF.
|
Result |
AbstractConnectionWrapper.add(String... ldifLines)
Adds an entry to the Directory Server using the provided lines of LDIF.
|
Result |
AbstractConnection.add(String... ldifLines) |
Result |
Connection.applyChange(ChangeRecord request)
Applies the provided change request to the Directory Server.
|
Result |
AbstractConnectionWrapper.applyChange(ChangeRecord request)
Applies the provided change request to the Directory Server.
|
Result |
AbstractConnection.applyChange(ChangeRecord request) |
Result |
Connection.delete(DeleteRequest request)
Deletes an entry from the Directory Server using the provided delete
request.
|
Result |
AbstractConnectionWrapper.delete(DeleteRequest request)
Deletes an entry from the Directory Server using the provided delete
request.
|
Result |
AbstractAsynchronousConnection.delete(DeleteRequest request) |
default Result |
Connection.delete(Dn name)
Deletes the named entry from the Directory Server.
|
Result |
Connection.delete(String name)
Deletes the named entry from the Directory Server.
|
Result |
AbstractConnectionWrapper.delete(String name)
Deletes the named entry from the Directory Server.
|
Result |
AbstractConnection.delete(String name) |
Result |
Connection.deleteSubtree(String name)
Deletes the named entry and all of its subordinates from the Directory
Server.
|
Result |
AbstractConnectionWrapper.deleteSubtree(String name)
Deletes the named entry and all of its subordinates from the Directory
Server.
|
Result |
AbstractConnection.deleteSubtree(String name) |
Result |
LdapException.getResult()
Returns the error result which caused this exception to be thrown.
|
Result |
Connection.modify(ModifyRequest request)
Modifies an entry in the Directory Server using the provided modify
request.
|
Result |
AbstractConnectionWrapper.modify(ModifyRequest request)
Modifies an entry in the Directory Server using the provided modify
request.
|
Result |
AbstractAsynchronousConnection.modify(ModifyRequest request) |
Result |
Connection.modify(String... ldifLines)
Modifies an entry in the Directory Server using the provided lines of
LDIF.
|
Result |
AbstractConnectionWrapper.modify(String... ldifLines)
Modifies an entry in the Directory Server using the provided lines of
LDIF.
|
Result |
AbstractConnection.modify(String... ldifLines) |
Result |
Connection.modifyDn(ModifyDnRequest request)
Renames an entry in the Directory Server using the provided modify DN
request.
|
Result |
AbstractConnectionWrapper.modifyDn(ModifyDnRequest request)
Renames an entry in the Directory Server using the provided modify DN
request.
|
Result |
AbstractAsynchronousConnection.modifyDn(ModifyDnRequest request) |
Result |
Connection.modifyDn(String name,
String newRDN)
Renames the named entry in the Directory Server using the provided new
RDN.
|
Result |
AbstractConnectionWrapper.modifyDn(String name,
String newRDN)
Renames the named entry in the Directory Server using the provided new
RDN.
|
Result |
AbstractConnection.modifyDn(String name,
String newRDN) |
Result |
Connection.search(SearchRequest request,
Collection<? super SearchResultEntry> entries)
Searches the Directory Server using the provided search request.
|
Result |
AbstractConnectionWrapper.search(SearchRequest request,
Collection<? super SearchResultEntry> entries)
Searches the Directory Server using the provided search request.
|
Result |
AbstractConnection.search(SearchRequest request,
Collection<? super SearchResultEntry> entries) |
Result |
Connection.search(SearchRequest request,
Collection<? super SearchResultEntry> entries,
Collection<? super SearchResultReference> references)
Searches the Directory Server using the provided search request.
|
Result |
AbstractConnectionWrapper.search(SearchRequest request,
Collection<? super SearchResultEntry> entries,
Collection<? super SearchResultReference> references)
Searches the Directory Server using the provided search request.
|
Result |
AbstractConnection.search(SearchRequest request,
Collection<? super SearchResultEntry> entries,
Collection<? super SearchResultReference> references) |
Result |
Connection.search(SearchRequest request,
SearchResultHandler handler)
Searches the Directory Server using the provided search request.
|
Result |
AbstractConnectionWrapper.search(SearchRequest request,
SearchResultHandler handler)
Searches the Directory Server using the provided search request.
|
Result |
AbstractAsynchronousConnection.search(SearchRequest request,
SearchResultHandler handler) |
| Modifier and Type | Method and Description |
|---|---|
default io.reactivex.Single<Result> |
LdapClientSocket.add(AddRequest request)
Adds an entry to the Directory Server using the provided add request.
|
LdapPromise<Result> |
Connection.addAsync(AddRequest request)
Asynchronously adds an entry to the Directory Server using the provided
add request.
|
LdapPromise<Result> |
AbstractConnectionWrapper.addAsync(AddRequest request)
Asynchronously adds an entry to the Directory Server using the provided
add request.
|
LdapPromise<Result> |
AbstractConnection.addAsync(AddRequest request) |
LdapPromise<Result> |
Connection.addAsync(AddRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously adds an entry to the Directory Server using the provided
add request.
|
LdapPromise<Result> |
AbstractSynchronousConnection.addAsync(AddRequest request,
IntermediateResponseHandler intermediateResponseHandler) |
LdapPromise<Result> |
AbstractConnectionWrapper.addAsync(AddRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously adds an entry to the Directory Server using the provided
add request.
|
default io.reactivex.Single<Result> |
LdapClientSocket.applyChange(ChangeRecord request)
Applies the provided change request to the Directory Server.
|
LdapPromise<Result> |
Connection.applyChangeAsync(ChangeRecord request)
Asynchronously applies the provided change request to the Directory
Server.
|
LdapPromise<Result> |
AbstractConnectionWrapper.applyChangeAsync(ChangeRecord request)
Asynchronously applies the provided change request to the Directory
Server.
|
LdapPromise<Result> |
AbstractConnection.applyChangeAsync(ChangeRecord request) |
LdapPromise<Result> |
Connection.applyChangeAsync(ChangeRecord request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously applies the provided change request to the Directory
Server.
|
LdapPromise<Result> |
AbstractConnectionWrapper.applyChangeAsync(ChangeRecord request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously applies the provided change request to the Directory
Server.
|
LdapPromise<Result> |
AbstractConnection.applyChangeAsync(ChangeRecord request,
IntermediateResponseHandler intermediateResponseHandler) |
io.reactivex.Single<Result> |
RequestHandle.cancel()
Returns a
Single<Result> which, once subscribed, will attempt to cancel the operation. |
default io.reactivex.Single<Result> |
LdapClientSocket.delete(DeleteRequest request)
Deletes an entry from the Directory Server using the provided delete request.
|
LdapPromise<Result> |
Connection.deleteAsync(DeleteRequest request)
Asynchronously deletes an entry from the Directory Server using the
provided delete request.
|
LdapPromise<Result> |
AbstractConnectionWrapper.deleteAsync(DeleteRequest request)
Asynchronously deletes an entry from the Directory Server using the
provided delete request.
|
LdapPromise<Result> |
AbstractConnection.deleteAsync(DeleteRequest request) |
LdapPromise<Result> |
Connection.deleteAsync(DeleteRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously deletes an entry from the Directory Server using the
provided delete request.
|
LdapPromise<Result> |
AbstractSynchronousConnection.deleteAsync(DeleteRequest request,
IntermediateResponseHandler intermediateResponseHandler) |
LdapPromise<Result> |
AbstractConnectionWrapper.deleteAsync(DeleteRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously deletes an entry from the Directory Server using the
provided delete request.
|
default io.reactivex.Single<Result> |
LdapClientSocket.modify(ModifyRequest request)
Modifies an entry in the Directory Server using the provided modify request.
|
LdapPromise<Result> |
Connection.modifyAsync(ModifyRequest request)
Asynchronously modifies an entry in the Directory Server using the
provided modify request.
|
LdapPromise<Result> |
AbstractConnectionWrapper.modifyAsync(ModifyRequest request)
Asynchronously modifies an entry in the Directory Server using the
provided modify request.
|
LdapPromise<Result> |
AbstractConnection.modifyAsync(ModifyRequest request) |
LdapPromise<Result> |
Connection.modifyAsync(ModifyRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously modifies an entry in the Directory Server using the
provided modify request.
|
LdapPromise<Result> |
AbstractSynchronousConnection.modifyAsync(ModifyRequest request,
IntermediateResponseHandler intermediateResponseHandler) |
LdapPromise<Result> |
AbstractConnectionWrapper.modifyAsync(ModifyRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously modifies an entry in the Directory Server using the
provided modify request.
|
default io.reactivex.Single<Result> |
LdapClientSocket.modifyDn(ModifyDnRequest request)
Renames an entry in the Directory Server using the provided modify DN request.
|
LdapPromise<Result> |
Connection.modifyDnAsync(ModifyDnRequest request)
Asynchronously renames an entry in the Directory Server using the
provided modify DN request.
|
LdapPromise<Result> |
AbstractConnectionWrapper.modifyDnAsync(ModifyDnRequest request)
Asynchronously renames an entry in the Directory Server using the
provided modify DN request.
|
LdapPromise<Result> |
AbstractConnection.modifyDnAsync(ModifyDnRequest request) |
LdapPromise<Result> |
Connection.modifyDnAsync(ModifyDnRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously renames an entry in the Directory Server using the
provided modify DN request.
|
LdapPromise<Result> |
AbstractSynchronousConnection.modifyDnAsync(ModifyDnRequest request,
IntermediateResponseHandler intermediateResponseHandler) |
LdapPromise<Result> |
AbstractConnectionWrapper.modifyDnAsync(ModifyDnRequest request,
IntermediateResponseHandler intermediateResponseHandler)
Asynchronously renames an entry in the Directory Server using the
provided modify DN request.
|
LdapPromise<Result> |
Connection.searchAsync(SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler)
Asynchronously searches the Directory Server using the provided search
request.
|
LdapPromise<Result> |
AbstractSynchronousConnection.searchAsync(SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler) |
LdapPromise<Result> |
AbstractConnectionWrapper.searchAsync(SearchRequest request,
IntermediateResponseHandler intermediateResponseHandler,
SearchResultHandler entryHandler)
Asynchronously searches the Directory Server using the provided search
request.
|
LdapPromise<Result> |
Connection.searchAsync(SearchRequest request,
SearchResultHandler entryHandler)
Asynchronously searches the Directory Server using the provided search
request.
|
LdapPromise<Result> |
AbstractConnectionWrapper.searchAsync(SearchRequest request,
SearchResultHandler resultHandler)
Asynchronously searches the Directory Server using the provided search
request.
|
LdapPromise<Result> |
AbstractConnection.searchAsync(SearchRequest request,
SearchResultHandler resultHandler) |
| Modifier and Type | Method and Description |
|---|---|
static LdapException |
LdapException.newLdapException(Result result)
Creates a new LDAP exception using the provided result.
|
| Constructor and Description |
|---|
LdapException(Result result)
Creates a new LDAP exception using the provided result.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
BindResult
A Bind result indicates the status of the client's request for
authentication.
|
interface |
CompareResult
An Compare result indicates the final status of an Compare operation.
|
interface |
ExtendedResult
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 |
GenericExtendedResult
A Generic Extended result indicates the final status of an Generic Extended
operation.
|
interface |
PasswordModifyExtendedResult
The password modify extended result as defined in RFC 3062.
|
interface |
StartTlsExtendedResult
The start tls extended result as defined in RFC 4511.
|
interface |
WhoAmIExtendedResult
The who am I extended result as defined in RFC 4532.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractExtendedResult<S extends ExtendedResult>
An abstract Extended result which can be used as the basis for implementing
new Extended operations.
|
| Modifier and Type | Method and Description |
|---|---|
Result |
Result.addControl(Control control) |
Result |
Result.addControls(Iterable<? extends Control> controls) |
Result |
Result.addReferralUri(String uri)
Adds the provided referral URI to this result.
|
default Result |
Result.copyFrom(Result 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 |
Result.setCause(Throwable cause)
Sets the throwable cause associated with this result if available.
|
Result |
Result.setDiagnosticMessage(CharSequence message)
Sets the diagnostic message associated with this result.
|
Result |
Result.setMatchedDn(Dn dn)
Sets the matched DN associated with this result.
|
Result |
Result.setMatchedDn(String dn)
Sets the matched DN associated with this result.
|
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 Type | Method and Description |
|---|---|
default Result |
Result.copyFrom(Result 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 an
LdapMessage for a search result done operation type. |
static Result |
Responses.unmodifiableResult(Result result)
Creates an unmodifiable result using the provided response.
|
| Modifier and Type | Method and Description |
|---|---|
Result |
ConnectionEntryReader.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.
|
Copyright © 2010-2018, ForgeRock All Rights Reserved.