Package com.unboundid.ldap.listener
Class InMemorySASLBindHandler
- java.lang.Object
-
- com.unboundid.ldap.listener.InMemorySASLBindHandler
-
- Direct Known Subclasses:
PLAINBindHandler
@Extensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public abstract class InMemorySASLBindHandler extends java.lang.Object
This class defines an API that may be used to provide support for a specified SASL mechanism in the in-memory directory server.
-
-
Constructor Summary
Constructors Constructor Description InMemorySASLBindHandler()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract java.lang.String
getSASLMechanismName()
Retrieves the name of the SASL mechanism supported by this bind handler.abstract BindResult
processSASLBind(InMemoryRequestHandler handler, int messageID, DN bindDN, ASN1OctetString credentials, java.util.List<Control> controls)
Performs the appropriate processing for a SASL bind request with the provided information.java.lang.String
toString()
Retrieves a string representation of this SASL bind handler.
-
-
-
Constructor Detail
-
InMemorySASLBindHandler
public InMemorySASLBindHandler()
-
-
Method Detail
-
getSASLMechanismName
@NotNull public abstract java.lang.String getSASLMechanismName()
Retrieves the name of the SASL mechanism supported by this bind handler.- Returns:
- The name of the SASL mechanism supported by this bind handler.
-
processSASLBind
@NotNull public abstract BindResult processSASLBind(@NotNull InMemoryRequestHandler handler, int messageID, @NotNull DN bindDN, @Nullable ASN1OctetString credentials, @NotNull java.util.List<Control> controls)
Performs the appropriate processing for a SASL bind request with the provided information.
If the bind processing is successful, then this method should also callInMemoryRequestHandler.setAuthenticatedDN(DN)
on the provided request handler instance to set the identity of the authenticated user.
If the associated SASL mechanism requires multiple stages of processing and it is necessary to store and retrieve state information to use in other stages of the bind processing, then the map returned by theInMemoryRequestHandler.getConnectionState()
method should be used for this purpose.- Parameters:
handler
- The in-memory request handler that accepted the bind request.messageID
- The message ID for the LDAP message that the client used to send the request.bindDN
- The bind DN provided by the client.credentials
- The SASL credentials provided by the client, ornull
if there were none.controls
- The request controls provided by the client.- Returns:
- The result that should be returned to the client in response to the provided request.
-
-