org.forgerock.opendj.io

Interface LdapSocket

public interface LdapSocket

A socket implementation representing a stream of LDAP messages. LDAP sockets are role agnostic and may be used for implementing LDAP clients and servers..

Support for StartTLS is provided through the usage of StartTlsExtendedRequest. Support for SASL quality of protection is provided through the usage of BindRequest.

Method Summary

Modifier and Type	Method and Description
void	abort() Disconnects this socket.
void	abortWithReason(IOException reason) Disconnects the socket.
InetSocketAddress	getLocalAddress() Returns the InetSocketAddress associated with the local system.
InetSocketAddress	getRemoteAddress() Returns the InetSocketAddress associated with the remote system.
SaslClient	getSaslClient() Returns the SaslClient currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.
SaslServer	getSaslServer() Returns the SaslServer currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.
SSLSession	getSslSession() Returns the SSL session currently in use by the underlying connection, or null if SSL/TLS is not enabled.
io.reactivex.Flowable<LdapMessage>	reader() Returns a Flowable of LDAP messages read from the network.
org.reactivestreams.Processor<LdapMessage,LdapMessage>	writer() Returns a Processor which will write all LdapMessage it receives to the network.

Method Detail

reader

io.reactivex.Flowable<LdapMessage> reader()

Returns a Flowable of LDAP messages read from the network. Message reception is suspended until a subscriber subscribes to it. Note that no message will be dropped in the mean time.

Any Subscribers of this Flowable will be notified of incoming message, while respecting back-pressure constraints through the Subscriber.onNext(Object).

When this socket is disconnected locally using LdapSocket.abort() or LdapSocket.writer(). onError/onComplete, the subscriber will be notified through Subscriber.onError(Throwable) with a LdapSocketClosedException providing the information about the cause of the disconnection. If the socket has been disconnected by the peer, then the subscriber will be notified through Subscriber.onComplete().

Note that invoking this method multiple times returns the same Flowable instance until Subscription.cancel(). This invocation will not close this socket but suspend message reception until this method is invoked again and the new returned Flowable instance is subscribed.

Returns:

The stream of LdapMessages read from the network.

Throws:

IllegalStateException - If the returned stream has already been subscribed. The exception will be propagated through the Subscriber.onError(Throwable)

writer

org.reactivestreams.Processor<LdapMessage,LdapMessage> writer()

Returns a Processor which will write all LdapMessage it receives to the network. The publisher must respect back-pressure constraints implied by the returned subscriber. The back-pressure constraints reflect the capacity of the remote peer to read the flow of messages.

When this socket is disconnected, the Subscriber of this writer will be signaled with an error and the Subscription.request(long) will no longer be invoked.

It is not possible to subscribe to multiple publishers with the returned subscriber instance.

Returns:

A Processor transmitting all messages to the network. This processor does not signal anything, it only propagates the received completion or error signals.

getLocalAddress

InetSocketAddress getLocalAddress()

Returns the InetSocketAddress associated with the local system.

Returns:

The InetSocketAddress associated with the local system.

getRemoteAddress

InetSocketAddress getRemoteAddress()

Returns the InetSocketAddress associated with the remote system.

Returns:

The InetSocketAddress associated with the remote system.

getSslSession

SSLSession getSslSession()

Returns the SSL session currently in use by the underlying connection, or null if SSL/TLS is not enabled.

Returns:

The SSL session currently in use by the underlying connection, or null if SSL/TLS is not enabled.

getSaslServer

SaslServer getSaslServer()

Returns the SaslServer currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.

Returns:

The SaslServer currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.

getSaslClient

SaslClient getSaslClient()

Returns the SaslClient currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.

Returns:

The SaslClient currently in use by the underlying connection, or null if SASL integrity and/or privacy protection is not enabled.

abort

void abort()

Disconnects this socket. Disconnecting the socket will invoke LdapSocket.reader()'s Subscriber.onError(Throwable) with a LdapSocketClosedException and will cancel the LdapSocket.writer()'s publisher. All messages which have not yet been sent will be dropped.

abortWithReason

void abortWithReason(IOException reason)

Disconnects the socket. Disconnecting the socket will invoke LdapSocket.reader()'s Subscriber.onError(Throwable) with a LdapSocketClosedException and will cancel the LdapSocket.writer()'s publisher. All messages which have not yet been sent will be dropped.

Parameters:

reason - The reason which will be embedded into the LdapSocketClosedException