Package org.ldaptive
Interface Connection
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
NettyConnection
,TransportConnection
Interface for connection implementations.
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
close()
void
close
(RequestControl... controls) Closes the connection.Returns the URL that was selected for this connection.boolean
isOpen()
Returns whether this connection is open.void
open()
Opens the connection.void
operation
(AbandonRequest request) Executes an abandon operation.operation
(AddRequest request) Creates a handle for an add operation.operation
(BindRequest request) Creates a handle for a bind operation.operation
(CompareRequest request) Creates a handle for a compare operation.operation
(DeleteRequest request) Creates a handle for an delete operation.operation
(ExtendedRequest request) Creates a handle for an extended operation.operation
(ModifyDnRequest request) Creates a handle for a modify dn operation.operation
(ModifyRequest request) Creates a handle for a modify operation.operation
(DefaultSaslClientRequest request) Returns the result of a SASL request that requires use of the default SASL client.operation
(SaslClientRequest request) Returns the result of a SASL request that requires use of a generic SASL client.operation
(SearchRequest request) Creates a handle for a search operation.
-
Method Details
-
operation
Executes an abandon operation. Clients should execute abandons usingOperationHandle.abandon()
.- Parameters:
request
- abandon request
-
operation
Creates a handle for an add operation.- Parameters:
request
- add request- Returns:
- operation handle
-
operation
Creates a handle for a bind operation. Since clients must not send requests while a bind is in progress, some methods may not be supported on the the operation handle.- Parameters:
request
- bind request- Returns:
- operation handle
-
operation
Creates a handle for a compare operation.- Parameters:
request
- compare request- Returns:
- compare operation handle
-
operation
Creates a handle for an delete operation.- Parameters:
request
- delete request- Returns:
- operation handle
-
operation
Creates a handle for an extended operation.- Parameters:
request
- extended request- Returns:
- extended operation handle
-
operation
Creates a handle for a modify operation.- Parameters:
request
- modify request- Returns:
- operation handle
-
operation
Creates a handle for a modify dn operation.- Parameters:
request
- modify dn request- Returns:
- operation handle
-
operation
Creates a handle for a search operation.- Parameters:
request
- search request- Returns:
- search operation handle
-
operation
Returns the result of a SASL request that requires use of a generic SASL client.- Parameters:
request
- SASL client request- Returns:
- operation result
- Throws:
LdapException
- if the operation fails or another bind is in progress
-
operation
Returns the result of a SASL request that requires use of the default SASL client. This includes CRAM-MD5, DIGEST-MD5, and GSS-API.- Parameters:
request
- default SASL client request- Returns:
- operation result
- Throws:
LdapException
- if the operation fails or another bind is in progress
-
getLdapURL
LdapURL getLdapURL()Returns the URL that was selected for this connection. The existence of this value does not indicate a current established connection.- Returns:
- LDAP URL
-
isOpen
boolean isOpen()Returns whether this connection is open.- Returns:
- whether this connection is open
-
open
Opens the connection.- Throws:
LdapException
- if an error occurs opening the connection
-
close
default void close()- Specified by:
close
in interfaceAutoCloseable
-
close
Closes the connection.- Parameters:
controls
- to send when closing the connection
-