public interface LdapClientSocket extends Closeable
Flowable has been subscribed to. As as result,
send(Request, RequestHandle) will send the request only once the returned Flowable has been
subscribed.
Subscription the Subscriber received upon its
subscription to the response, it's possible to invoke Subscription.cancel(). This will send an
AbandonRequest to the server.RequestHandle.abandon() or RequestHandle.cancel() to respectively send
an AbandonRequest or a CancelExtendedRequest.LdapClient.connect()| Modifier and Type | Method and Description |
|---|---|
default Single<Result> |
add(AddRequest request)
Adds an entry to the Directory Server using the provided add request.
|
void |
addConnectionEventListener(ConnectionEventListener listener)
Registers the provided connection event listener so that it will be notified when this connection is closed by
the application, receives an unsolicited notification, or experiences a fatal error.
|
default Single<Result> |
applyChange(ChangeRecord request)
Applies the provided change request to the Directory Server.
|
default Single<BindResult> |
bind(BindRequest request)
Authenticates to the Directory Server using the provided bind request.
|
default void |
close()
Releases any resources associated with this connection.
|
void |
close(UnbindRequest request,
String reason)
Releases any resources associated with this connection.
|
default Single<CompareResult> |
compare(CompareRequest request)
Asynchronously compares an entry in the Directory Server using the provided compare request.
|
default Single<Result> |
delete(DeleteRequest request)
Deletes an entry from the Directory Server using the provided delete request.
|
default <R extends ExtendedResult> |
extendedRequest(ExtendedRequest<R> request)
Requests that the Directory Server performs the provided extended request.
|
boolean |
isClosed()
Indicates whether this connection has been explicitly closed by calling
close(). |
boolean |
isValid()
Returns
true if this connection has not been closed and no fatal errors have been detected. |
default Single<Result> |
modify(ModifyRequest request)
Modifies an entry in the Directory Server using the provided modify request.
|
default Single<Result> |
modifyDn(ModifyDnRequest request)
Renames an entry in the Directory Server using the provided modify DN request.
|
default Single<SearchResultEntry> |
readEntry(Dn name,
String... attributeDescriptions)
Reads the named entry from the Directory Server.
|
void |
removeConnectionEventListener(ConnectionEventListener listener)
Removes the provided connection event listener from this connection so that it will no longer be notified when
this connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
|
default Flowable<SearchResultEntry> |
search(SearchRequest request)
Searches the Directory Server using the provided search request.
|
default Single<SearchResultEntry> |
searchSingleEntry(SearchRequest request)
Searches the Directory Server for a single entry using the provided search request.
|
default Flowable<Response> |
send(Request request)
Sends a request to the Directory Server.
|
Flowable<Response> |
send(Request request,
RequestHandle handle)
Sends a request to the Directory Server.
|
Flowable<Response> send(Request request, RequestHandle handle)
Note that the request will only be sent when the returned Flowable has been subscribed.
request - The request to send.handle - The RequestHandle to track the request cancellation.Flowable can be subscribed only once.
Canceling the subscription of this Flowable will send an AbandonRequest to the server.NullPointerException - If request or handle was null.Flowable,
RequestHandledefault Flowable<Response> send(Request request)
Note that the request will only be sent when the returned Flowable has been subscribed.
request - The request to send.Flowable can be subscribed only once.
Canceling the subscription of this Flowable will send an AbandonRequest to the server.NullPointerException - If request was null.Flowableboolean isValid()
true if this connection has not been closed and no fatal errors have been detected. This method
is guaranteed to return false only when it is called after the method close() has been called.true if this connection is valid, false otherwise.boolean isClosed()
close(). This method will not
return true if a fatal error has occurred on the connection unless close() has been called.true if this connection has been explicitly closed by calling close(), or false
otherwise.void addConnectionEventListener(ConnectionEventListener listener)
listener - The listener which wants to be notified when events occur on this connection.IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.NullPointerException - If the listener was null.void removeConnectionEventListener(ConnectionEventListener listener)
listener - The listener which no longer wants to be notified when events occur on this connection.NullPointerException - If the listener was null.void close(UnbindRequest request, String reason)
Other connection implementations may behave differently, and may choose to ignore the provided unbind request if its use is inappropriate (for example a pooled connection will be released and returned to its connection pool without ever issuing an unbind request).
Calling close() on a connection that is already closed has no effect.
This method is not blocking and as such, does not guarantee that the socket is being effectively closed when this method returns.
request - The unbind request to use in the case where a physical connection is closed.reason - A reason describing why the connection was closed.NullPointerException - If request was null.default void close()
Other connection implementations may behave differently, and may choose not to send an unbind request if its use is inappropriate (for example a pooled connection will be released and returned to its connection pool without ever issuing an unbind request).
This method is equivalent to the following code:
UnbindRequest request = new UnbindRequest(); connection.close(request, null);Calling this method on a connection that is already closed has no effect.
close in interface AutoCloseableclose in interface Closeabledefault Single<BindResult> bind(BindRequest request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
request - The bind request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this socket does not support bind operations.IllegalStateException - If this socket has already been closed, i.e. if
isClosed() == true.NullPointerException - If request was null.Singledefault Single<SearchResultEntry> searchSingleEntry(SearchRequest request)
If the requested entry is not returned by the Directory Server then the request will fail with an
EntryNotFoundException. If multiple matching entries are returned by the Directory Server then the
request will fail with an MultipleEntriesFoundException.
Note that the request will only be sent when the returned Single has been subscribed.
request - The request to send.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this connection does not support search operations.IllegalStateException - If this socket has already been closed, i.e. if
isClosed() == true.NullPointerException - If the request was null.Singledefault Flowable<SearchResultEntry> search(SearchRequest request)
SearchResultEntry will be returned throughout the Flowable.
If you need to handle the search Result (e.g. for processing paged results),
SearchResultReference, or SearchResultReference or IntermediateResponses, please use
send(Request) instead.
Note that the request will only be sent when the returned Flowable has been subscribed.
request - The request to send.Flowable can be subscribed only once.
Canceling the subscription of this Flowable will send an AbandonRequest to the server.UnsupportedOperationException - If this connection does not support search operations.IllegalStateException - If this socket has already been closed, i.e. if
isClosed() == true.NullPointerException - If the request was null.Flowabledefault Single<SearchResultEntry> readEntry(Dn name, String... attributeDescriptions)
If the requested entry is not returned by the Directory Server then the
request will fail with an EntryNotFoundException.
This method is equivalent to the following code:
SearchRequest request =
new SearchRequest(name, SearchScope.BASE_OBJECT, "(objectClass=*)", attributeDescriptions);
socket.searchSingleEntry(request);
Note that the request will only be sent when the returned Single has been subscribed.
name - The distinguished name of the entry to be read.attributeDescriptions - The names of the attributes to be included with the entry,
which may be null or empty indicating that all user
attributes should be returned.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this socket does not support search operations.IllegalStateException - If this socket has already been closed, i.e. if
isClosed() == true.NullPointerException - If the name was null.default Single<Result> modify(ModifyRequest request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
request - The modify request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this connection does not support modify operations.IllegalStateException - If this socket has already been closed, i.e. if isClosed() == true.NullPointerException - If request was null.Singledefault Single<Result> add(AddRequest request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
request - The add request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this connection does not support add operations.IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.NullPointerException - If request was null.Singledefault Single<Result> modifyDn(ModifyDnRequest request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
request - The modify DN request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.LdapException - If the result code indicates that the request failed for some
reason.UnsupportedOperationException - If this connection does not support modify DN operations.IllegalStateException - If this connection has already been closed, i.e. if
isClosed() == true.NullPointerException - If request was null.Singledefault Single<Result> delete(DeleteRequest request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
request - The delete request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this connection does not support delete operations.IllegalStateException - If this socket has already been closed, i.e. if
isClosed() == true.NullPointerException - If request was null.Singledefault Single<CompareResult> compare(CompareRequest request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
request - The compare request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this connection does not support compare operations.IllegalStateException - If this connection has already been closed, i.e. if isClosed() == true.NullPointerException - If request was null.Singledefault <R extends ExtendedResult> Single<R> extendedRequest(ExtendedRequest<R> request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
R - The type of result returned by the extended request.request - The extended request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.LdapException - If the result code indicates that the request failed for some reason.UnsupportedOperationException - If this socket does not support extended operations.IllegalStateException - If this socket has already been closed, i.e. if isClosed() == true.NullPointerException - If request was null.Singledefault Single<Result> applyChange(ChangeRecord request)
If you need to handle IntermediateResponses, please use send(Request) instead.
Note that the request will only be sent when the returned Single has been subscribed.
request - The change request.Single can be subscribed only once.
Canceling the subscription of this Single will send an AbandonRequest to the server.UnsupportedOperationException - If this socket does not support the provided change request.IllegalStateException - If this socket has already been closed, i.e. if isClosed() == true.NullPointerException - If request was null.SingleCopyright 2010-2022 ForgeRock AS.