public interface LdapClientSocket extends Closeable
Flowable
has been subscribed to. As as result,
LdapClientSocket.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 |
---|---|
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 void |
close()
Releases any resources associated with this connection.
|
void |
close(UnbindRequest request,
String reason)
Releases any resources associated with this connection.
|
boolean |
isClosed()
Indicates whether this connection has been explicitly closed by calling
LdapClientSocket.close() . |
boolean |
isValid()
Returns
true if this connection has not been closed and no fatal errors have been detected. |
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 io.reactivex.Flowable<Response> |
send(Request request)
Sends a request asynchronously to the Directory Server.
|
io.reactivex.Flowable<Response> |
send(Request request,
RequestHandle handle)
Sends a request asynchronously to the Directory Server.
|
io.reactivex.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 this Flowable
will send an AbandonRequest
to the server.NullPointerException
- If request
or handle
was null
.Flowable
,
RequestHandle
default io.reactivex.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 this Flowable
will send an AbandonRequest
to the server.NullPointerException
- If request
was null
.Flowable
boolean 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 LdapClientSocket.close()
has been called.true
if this connection is valid, false
otherwise.boolean isClosed()
LdapClientSocket.close()
. This method will not
return true
if a fatal error has occurred on the connection unless LdapClientSocket.close()
has been called.true
if this connection has been explicitly closed by calling LdapClientSocket.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 LdapClientSocket.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 AutoCloseable
close
in interface Closeable
Copyright © 2010-2020, ForgeRock All Rights Reserved.