org.ldaptive.provider.opendj

Class OpenDJConnection

java.lang.Object

org.ldaptive.provider.opendj.OpenDJConnection

All Implemented Interfaces:

ProviderConnection

public class OpenDJConnection
extends Object
implements ProviderConnection

OpenDJ provider implementation of ldap operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	OpenDJConnection.AbstractOpenDJSearch Common search functionality for opendj iterators and listeners.
protected class	OpenDJConnection.AggregateUnsolicitedNotificationListener Allows the use of multiple unsolicited notification listeners per connection.
protected class	OpenDJConnection.OpenDJAsyncRequest Async request to invoke abandons.
protected class	OpenDJConnection.OpenDJAsyncSearchListener Search listener for opendj id async search results.
protected class	OpenDJConnection.OpenDJSearchIterator Search iterator for opendj search results.

Field Summary

Fields

Modifier and Type	Field and Description
private OpenDJProviderConfig	config Provider configuration.
private org.forgerock.opendj.ldap.Connection	connection Ldap connection.
protected org.slf4j.Logger	logger Logger for this class.
private OpenDJConnection.AggregateUnsolicitedNotificationListener	notificationListener Connection event listener for unsolicited notifications.

Constructor Summary

Constructors

Constructor and Description
OpenDJConnection(org.forgerock.opendj.ldap.Connection c, OpenDJProviderConfig pc) Creates a new opendj 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.forgerock.opendj.ldap.responses.Result ldapResult) Creates an operation response with the supplied response data.
Response<Void>	delete(DeleteRequest request)
Response<?>	extendedOperation(ExtendedRequest request)
org.forgerock.opendj.ldap.Connection	getLdapConnection() Returns the underlying ldap connection.
protected static String	getQualityOfProtection(QualityOfProtection qop) Returns the SASL quality of protection string for the supplied enum.
Response<Void>	modify(ModifyRequest request)
Response<Void>	modifyDn(ModifyDnRequest request)
protected void	processErrorResultException(Request request, org.forgerock.opendj.ldap.ErrorResultException e) Determines if the supplied error result 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.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger for this class.

connection

private org.forgerock.opendj.ldap.Connection connection

Ldap connection.

config

private final OpenDJProviderConfig config

Provider configuration.

notificationListener

private final OpenDJConnection.AggregateUnsolicitedNotificationListener notificationListener

Connection event listener for unsolicited notifications.

Constructor Detail

OpenDJConnection

public OpenDJConnection(org.forgerock.opendj.ldap.Connection c,
                        OpenDJProviderConfig pc)

Creates a new opendj ldap connection.

Parameters:

c - ldap connection

pc - provider configuration

Method Detail

getLdapConnection

public org.forgerock.opendj.ldap.Connection 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

getQualityOfProtection

protected static String getQualityOfProtection(QualityOfProtection qop)

Returns the SASL quality of protection string for the supplied enum.

Parameters:

qop - quality of protection enum

Returns:

SASL quality of protection string

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

createResponse

protected <T> Response<T> createResponse(Request request,
                                         T result,
                                         org.forgerock.opendj.ldap.responses.Result ldapResult)

Creates an operation response with the supplied response data.

Type Parameters:

T - type of response

Parameters:

request - containing controls

result - of the operation

ldapResult - provider result

Returns:

operation response

processErrorResultException

protected void processErrorResultException(Request request,
                                           org.forgerock.opendj.ldap.ErrorResultException e)
                                    throws LdapException

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

Parameters:

request - that produced the exception

e - that was produced

Throws:

LdapException - wrapping the error result exception