org.ldaptive.provider.apache

Class ApacheLdapConnection

java.lang.Object

org.ldaptive.provider.apache.ApacheLdapConnection

All Implemented Interfaces:

ProviderConnection

public class ApacheLdapConnection
extends Object
implements ProviderConnection

Apache LDAP provider implementation of ldap operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ApacheLdapConnection.AbstractApacheLdapSearch Common search functionality for apache ldap iterators and listeners.
protected class	ApacheLdapConnection.ApacheLdapSearchIterator Search iterator for apache ldap search results.
protected class	ApacheLdapConnection.ApacheLdapSearchListener Search listener for apache ldap search results.

Field Summary

Fields

Modifier and Type	Field and Description
private ApacheLdapProviderConfig	config Provider configuration.
private org.apache.directory.ldap.client.api.LdapNetworkConnection	connection Ldap connection.
protected Logger	logger Logger for this class.

Constructor Summary

Constructors

Constructor and Description
ApacheLdapConnection(org.apache.directory.ldap.client.api.LdapNetworkConnection lc, ApacheLdapProviderConfig pc) Creates a new apache ldap connection.

Method Summary

Modifier and Type	Method and Description
void	abandon(int messageId, RequestControl[] controls)
Response<Void>	add(AddRequest request)
void	addUnsolicitedNotificationListener(UnsolicitedNotificationListener listener)
protected Response<Void>	anonymousBind(BindRequest request) Performs an anonymous bind.
Response<Void>	bind(BindRequest request)
void	close(RequestControl[] controls)
Response<Boolean>	compare(CompareRequest request)
protected <T> Response<T>	createResponse(Request request, T result, org.apache.directory.api.ldap.model.message.ResultResponse resultResponse) Creates an operation response with the supplied response data.
Response<Void>	delete(DeleteRequest request)
Response<?>	extendedOperation(ExtendedRequest request)
org.apache.directory.ldap.client.api.LdapNetworkConnection	getLdapConnection() Returns the underlying ldap connection.
org.apache.directory.api.ldap.model.message.Control[]	getResponseControls(org.apache.directory.api.ldap.model.message.Message response) Retrieves the response controls from the supplied response.
Response<Void>	modify(ModifyRequest request)
Response<Void>	modifyDn(ModifyDnRequest request)
protected void	processLdapException(org.apache.directory.api.ldap.model.exception.LdapException e) Determines if the supplied ldap exception should result in an operation exception.
protected void	processLdapOperationException(org.apache.directory.api.ldap.model.exception.LdapOperationException e) Determines if the supplied ldap exception should result in an operation exception.
ResponseControl[]	processResponseControls(ControlProcessor<org.apache.directory.api.ldap.model.message.Control> processor, RequestControl[] requestControls, org.apache.directory.api.ldap.model.message.Message response) Retrieves the response controls from the supplied response and processes them with the supplied control processor.
void	removeUnsolicitedNotificationListener(UnsolicitedNotificationListener listener)
protected Response<Void>	saslBind(BindRequest request) Performs a sasl bind.
SearchIterator	search(SearchRequest request)
void	searchAsync(SearchRequest request, SearchListener listener)
protected Response<Void>	simpleBind(BindRequest request) Performs a simple bind.
protected void	throwOperationException(Request request, org.apache.directory.api.ldap.model.message.ResultResponse resultResponse) Determines if the supplied response should result in an operation retry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final Logger logger

Logger for this class.

connection

private org.apache.directory.ldap.client.api.LdapNetworkConnection connection

Ldap connection.

config

private final ApacheLdapProviderConfig config

Provider configuration.

Constructor Detail

ApacheLdapConnection

public ApacheLdapConnection(org.apache.directory.ldap.client.api.LdapNetworkConnection lc,
                            ApacheLdapProviderConfig pc)

Creates a new apache ldap connection.

Parameters:

lc - ldap connection

pc - provider configuration

Method Detail

getLdapConnection

public org.apache.directory.ldap.client.api.LdapNetworkConnection getLdapConnection()

Returns the underlying ldap connection.

Returns:

ldap connection

close

public void close(RequestControl[] controls)
           throws LdapException

Specified by:

close in interface ProviderConnection

Throws:

LdapException

bind

public Response<Void> bind(BindRequest request)
                    throws LdapException

Specified by:

bind in interface ProviderConnection

Throws:

LdapException

anonymousBind

protected Response<Void> anonymousBind(BindRequest request)
                                throws LdapException

Performs an anonymous bind.

Parameters:

request - to bind with

Returns:

bind response

Throws:

LdapException - if an error occurs

simpleBind

protected Response<Void> simpleBind(BindRequest request)
                             throws LdapException

Performs a simple bind.

Parameters:

request - to bind with

Returns:

bind response

Throws:

LdapException - if an error occurs

saslBind

protected Response<Void> saslBind(BindRequest request)
                           throws LdapException

Performs a sasl bind.

Parameters:

request - to bind with

Returns:

bind response

Throws:

LdapException - if an error occurs

add

public Response<Void> add(AddRequest request)
                   throws LdapException

Specified by:

add in interface ProviderConnection

Throws:

LdapException

compare

public Response<Boolean> compare(CompareRequest request)
                          throws LdapException

Specified by:

compare in interface ProviderConnection

Throws:

LdapException

delete

public Response<Void> delete(DeleteRequest request)
                      throws LdapException

Specified by:

delete in interface ProviderConnection

Throws:

LdapException

modify

public Response<Void> modify(ModifyRequest request)
                      throws LdapException

Specified by:

modify in interface ProviderConnection

Throws:

LdapException

modifyDn

public Response<Void> modifyDn(ModifyDnRequest request)
                        throws LdapException

Specified by:

modifyDn in interface ProviderConnection

Throws:

LdapException

search

public SearchIterator search(SearchRequest request)
                      throws LdapException

Specified by:

search in interface ProviderConnection

Throws:

LdapException

searchAsync

public void searchAsync(SearchRequest request,
                        SearchListener listener)
                 throws LdapException

Specified by:

searchAsync in interface ProviderConnection

Throws:

LdapException

abandon

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

Specified by:

abandon in interface ProviderConnection

Throws:

LdapException

extendedOperation

public Response<?> extendedOperation(ExtendedRequest request)
                              throws LdapException

Specified by:

extendedOperation in interface ProviderConnection

Throws:

LdapException

addUnsolicitedNotificationListener

public void addUnsolicitedNotificationListener(UnsolicitedNotificationListener listener)

Specified by:

addUnsolicitedNotificationListener in interface ProviderConnection

removeUnsolicitedNotificationListener

public void removeUnsolicitedNotificationListener(UnsolicitedNotificationListener listener)

Specified by:

removeUnsolicitedNotificationListener in interface ProviderConnection

throwOperationException

protected void throwOperationException(Request request,
                                       org.apache.directory.api.ldap.model.message.ResultResponse resultResponse)
                                throws LdapException

Determines if the supplied response should result in an operation retry.

Parameters:

request - that produced the exception

resultResponse - provider response

Throws:

LdapException - wrapping the ldap exception

createResponse

protected <T> Response<T> createResponse(Request request,
                                         T result,
                                         org.apache.directory.api.ldap.model.message.ResultResponse resultResponse)

Creates an operation response with the supplied response data.

Type Parameters:

T - type of response

Parameters:

request - containing controls

result - of the operation

resultResponse - provider response

Returns:

operation response

processLdapOperationException

protected void processLdapOperationException(org.apache.directory.api.ldap.model.exception.LdapOperationException e)
                                      throws LdapException

Determines if the supplied ldap exception should result in an operation exception.

Parameters:

e - that was produced

Throws:

LdapException - wrapping the ldap exception

processLdapException

protected void processLdapException(org.apache.directory.api.ldap.model.exception.LdapException e)
                             throws LdapException

Determines if the supplied ldap exception should result in an operation exception.

Parameters:

e - that was produced

Throws:

LdapException - wrapping the ldap exception

processResponseControls

public ResponseControl[] processResponseControls(ControlProcessor<org.apache.directory.api.ldap.model.message.Control> processor,
                                                 RequestControl[] requestControls,
                                                 org.apache.directory.api.ldap.model.message.Message response)

Retrieves the response controls from the supplied response and processes them with the supplied control processor.

Parameters:

processor - control processor

requestControls - that produced this response

response - to get controls from

Returns:

response controls

getResponseControls

public org.apache.directory.api.ldap.model.message.Control[] getResponseControls(org.apache.directory.api.ldap.model.message.Message response)

Retrieves the response controls from the supplied response.

Parameters:

response - to get controls from

Returns:

response controls