org.ldaptive.provider

Interface ProviderConnection

All Known Implementing Classes:

ApacheLdapConnection, JLdapConnection, JLdapSSLConnection, JLdapStartTLSConnection, JndiConnection, JndiStartTLSConnection, OpenDJConnection, UnboundIDConnection

public interface ProviderConnection

Interface for a provider specific implementation of ldap operations.

Method Summary

Modifier and Type	Method and Description
void	abandon(int messageId, RequestControl[] controls) Abandon an operation.
Response<Void>	add(AddRequest request) Add an entry to an ldap.
void	addUnsolicitedNotificationListener(UnsolicitedNotificationListener listener) Adds a listener to receive unsolicited notifications.
Response<Void>	bind(BindRequest request) Bind to the ldap.
void	close(RequestControl[] controls) Tear down this connection to an LDAP.
Response<Boolean>	compare(CompareRequest request) Compare an entry in the ldap.
Response<Void>	delete(DeleteRequest request) Delete an entry in the ldap.
Response<?>	extendedOperation(ExtendedRequest request) Perform an extended operation in the ldap.
Response<Void>	modify(ModifyRequest request) Modify an entry in the ldap.
Response<Void>	modifyDn(ModifyDnRequest request) Modify the DN of an entry in the ldap.
void	removeUnsolicitedNotificationListener(UnsolicitedNotificationListener listener) Removes a listener from receiving unsolicited notifications.
SearchIterator	search(SearchRequest request) Search the ldap.
void	searchAsync(SearchRequest request, SearchListener listener) Search the ldap asynchronously.

Method Detail

bind

Response<Void> bind(BindRequest request)
             throws LdapException

Bind to the ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

response associated with the bind operation

Throws:

LdapException - if an error occurs

add

Response<Void> add(AddRequest request)
            throws LdapException

Add an entry to an ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

response associated with the add operation

Throws:

LdapException - if an error occurs

compare

Response<Boolean> compare(CompareRequest request)
                   throws LdapException

Compare an entry in the ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

response associated with the compare operation

Throws:

LdapException - if an error occurs

delete

Response<Void> delete(DeleteRequest request)
               throws LdapException

Delete an entry in the ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

response associated with the delete operation

Throws:

LdapException - if an error occurs

modify

Response<Void> modify(ModifyRequest request)
               throws LdapException

Modify an entry in the ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

response associated with the modify operation

Throws:

LdapException - if an error occurs

modifyDn

Response<Void> modifyDn(ModifyDnRequest request)
                 throws LdapException

Modify the DN of an entry in the ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

response associated with the modify dn operation

Throws:

LdapException - if an error occurs

search

SearchIterator search(SearchRequest request)
               throws LdapException

Search the ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

search iterator

Throws:

LdapException - if an error occurs

searchAsync

void searchAsync(SearchRequest request,
                 SearchListener listener)
          throws LdapException

Search the ldap asynchronously.

Parameters:

request - containing the data necessary to perform the operation

listener - to be notified as results arrive

Throws:

LdapException - if an error occurs

abandon

void abandon(int messageId,
             RequestControl[] controls)
      throws LdapException

Abandon an operation.

Parameters:

messageId - of the operation to abandon

controls - request controls

Throws:

LdapException - if an error occurs

extendedOperation

Response<?> extendedOperation(ExtendedRequest request)
                       throws LdapException

Perform an extended operation in the ldap.

Parameters:

request - containing the data necessary to perform the operation

Returns:

response associated with the extended operation

Throws:

LdapException - if an error occurs

addUnsolicitedNotificationListener

void addUnsolicitedNotificationListener(UnsolicitedNotificationListener listener)

Adds a listener to receive unsolicited notifications.

Parameters:

listener - to receive unsolicited notifications

removeUnsolicitedNotificationListener

void removeUnsolicitedNotificationListener(UnsolicitedNotificationListener listener)

Removes a listener from receiving unsolicited notifications.

Parameters:

listener - that was registered to receive unsolicited notifications

close

void close(RequestControl[] controls)
    throws LdapException

Tear down this connection to an LDAP.

Parameters:

controls - request controls

Throws:

LdapException - if an LDAP error occurs