Package org.ldaptive.provider.jldap

Class JLdapConnection

java.lang.Object

org.ldaptive.provider.jldap.JLdapConnection

All Implemented Interfaces:

ProviderConnection

Direct Known Subclasses:

JLdapSSLConnection, JLdapStartTLSConnection

public class JLdapConnection
extends Object
implements ProviderConnection

JLDAP provider implementation of ldap operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JLdapConnection.AbstractJLdapSearch	Common search functionality for jldap iterators and listeners.
protected class	JLdapConnection.AggregateUnsolicitedNotificationListener	Allows the use of multiple unsolicited notification handlers per connection.
protected class	JLdapConnection.JLdapAsyncRequest	Async request to invoke abandons.
protected class	JLdapConnection.JLdapAsyncSearchListener	Async search listener for JLdap search results.
protected class	JLdapConnection.JLdapSearchIterator	Search iterator for JLdap search results.
private static class	JLdapConnection.SaslCallbackHandler	Callback handler used by SASL mechanisms.
protected static class	JLdapConnection.SearchResultIterator	Iterates over an ldap search queue.

Field Summary

Fields

Modifier and Type	Field	Description
private JLdapProviderConfig	config	Provider configuration.
private com.novell.ldap.LDAPConnection	connection	Ldap connection.
protected Logger	logger	Logger for this class.
private JLdapConnection.AggregateUnsolicitedNotificationListener	notificationListener	Receives unsolicited notifications.

Constructor Summary

Constructors

Constructor	Description
JLdapConnection(com.novell.ldap.LDAPConnection conn, JLdapProviderConfig pc)	Creates a new jldap connection.

Method Summary

Modifier and Type	Method	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, com.novell.ldap.LDAPResponse ldapResponse)	Creates an operation response with the supplied response data.
Response<Void>	delete(DeleteRequest request)
Response<?>	extendedOperation(ExtendedRequest request)
com.novell.ldap.LDAPConnection	getLDAPConnection()	Returns the underlying ldap connection.
protected com.novell.ldap.LDAPConstraints	getLDAPConstraints(RequestControl[] controls)	Returns an ldap constraints object configured with the supplied controls.
protected com.novell.ldap.LDAPConstraints	getLDAPConstraints(Request request)	Returns an ldap constraints object configured with the supplied request.
Response<Void>	modify(ModifyRequest request)
Response<Void>	modifyDn(ModifyDnRequest request)
protected void	processLDAPException(com.novell.ldap.LDAPException e)	Determines if the supplied ldap exception should result in an operation retry.
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, com.novell.ldap.LDAPResponse ldapResponse)	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 com.novell.ldap.LDAPConnection connection

Ldap connection.

config

private final JLdapProviderConfig config

Provider configuration.

notificationListener

private final JLdapConnection.AggregateUnsolicitedNotificationListener notificationListener

Receives unsolicited notifications.

Constructor Detail

JLdapConnection

public JLdapConnection(com.novell.ldap.LDAPConnection conn,
                       JLdapProviderConfig pc)

Creates a new jldap connection.

Parameters:

conn - ldap connection

pc - provider configuration

Method Detail

getLDAPConnection

public com.novell.ldap.LDAPConnection 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

getLDAPConstraints

protected com.novell.ldap.LDAPConstraints getLDAPConstraints(Request request)

Returns an ldap constraints object configured with the supplied request.

Parameters:

request - request containing configuration to create constraints

Returns:

ldap constraints

getLDAPConstraints

protected com.novell.ldap.LDAPConstraints getLDAPConstraints(RequestControl[] controls)

Returns an ldap constraints object configured with the supplied controls.

Parameters:

controls - to sets in the constraints

Returns:

ldap constraints

throwOperationException

protected void throwOperationException(Request request,
                                       com.novell.ldap.LDAPResponse ldapResponse)
                                throws LdapException

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

Parameters:

request - that produced the exception

ldapResponse - provider response

Throws:

LdapException - wrapping the ldap exception

createResponse

protected <T> Response<T> createResponse(Request request,
                                         T result,
                                         com.novell.ldap.LDAPResponse ldapResponse)

Creates an operation response with the supplied response data.

Type Parameters:

T - type of response

Parameters:

request - containing controls

result - of the operation

ldapResponse - provider response

Returns:

operation response

processLDAPException

protected void processLDAPException(com.novell.ldap.LDAPException e)
                             throws LdapException

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

Parameters:

e - that was produced

Throws:

LdapException - wrapping the ldap exception