org.ldaptive.provider.netscape
Class NetscapeConnection

java.lang.Object
  org.ldaptive.provider.netscape.NetscapeConnection

All Implemented Interfaces:

org.ldaptive.provider.ProviderConnection

public class NetscapeConnection
extends Object
implements org.ldaptive.provider.ProviderConnection

Netscape provider implementation of ldap operations.

Version:

$Revision: 2613 $ $Date: 2013-02-11 16:32:17 -0500 (Mon, 11 Feb 2013) $

Author:

Middleware Services

Nested Class Summary

protected class	NetscapeConnection.AbstractNetscapeSearch Common search functionality for netscape iterators and listeners.
protected class	NetscapeConnection.NetscapeAsyncRequest Async request to invoke abandons.
protected class	NetscapeConnection.NetscapeAsyncSearchListener Async search listener for Netscape search results.
protected class	NetscapeConnection.NetscapeSearchIterator Search iterator for netscape search results.
protected static class	NetscapeConnection.SearchResultIterator Iterates over an ldap search listener.

Field Summary

protected org.slf4j.Logger

logger Logger for this class.

Constructor Summary

NetscapeConnection(netscape.ldap.LDAPConnection lc, NetscapeProviderConfig pc)
Creates a new netscape ldap connection.

Method Summary

void	abandon(int messageId, org.ldaptive.control.RequestControl[] controls)
org.ldaptive.Response<Void>	add(org.ldaptive.AddRequest request)
void	addUnsolicitedNotificationListener(org.ldaptive.extended.UnsolicitedNotificationListener listener)
protected org.ldaptive.Response<Void>	anonymousBind(org.ldaptive.BindRequest request) Performs an anonymous bind.
org.ldaptive.Response<Void>	bind(org.ldaptive.BindRequest request)
void	close(org.ldaptive.control.RequestControl[] controls)
org.ldaptive.Response<Boolean>	compare(org.ldaptive.CompareRequest request)
protected <T> org.ldaptive.Response<T>	createResponse(org.ldaptive.Request request, T result, netscape.ldap.LDAPResponse ldapResponse) Creates an operation response with the supplied response data.
org.ldaptive.Response<Void>	delete(org.ldaptive.DeleteRequest request)
org.ldaptive.Response<?>	extendedOperation(org.ldaptive.extended.ExtendedRequest request)
netscape.ldap.LDAPConnection	getLdapConnection() Returns the underlying ldap connection.
protected netscape.ldap.LDAPConstraints	getLDAPConstraints(org.ldaptive.Request request) Creates a LDAP constraints from the supplied request.
int	getTimeLimit() Returns the operation time limit in milliseconds.
protected void	initializeLDAPConstraints(org.ldaptive.Request request, netscape.ldap.LDAPConstraints cons) Configures the supplied ldap constraints using the supplied request and provider configuration.
org.ldaptive.Response<Void>	modify(org.ldaptive.ModifyRequest request)
org.ldaptive.Response<Void>	modifyDn(org.ldaptive.ModifyDnRequest request)
protected void	processLDAPException(netscape.ldap.LDAPException e) Determines if the supplied ldap exception should result in an operation retry.
void	removeUnsolicitedNotificationListener(org.ldaptive.extended.UnsolicitedNotificationListener listener)
protected org.ldaptive.Response<Void>	saslBind(org.ldaptive.BindRequest request) Performs a sasl bind.
org.ldaptive.provider.SearchIterator	search(org.ldaptive.SearchRequest request)
void	searchAsync(org.ldaptive.SearchRequest request, org.ldaptive.provider.SearchListener listener)
void	setTimeLimit(int limit) Sets the time limit.
protected org.ldaptive.Response<Void>	simpleBind(org.ldaptive.BindRequest request) Performs a simple bind.
protected void	throwOperationException(org.ldaptive.Request request, netscape.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 org.slf4j.Logger logger

Logger for this class.

Constructor Detail

NetscapeConnection

public NetscapeConnection(netscape.ldap.LDAPConnection lc,
                          NetscapeProviderConfig pc)

Creates a new netscape ldap connection.

Parameters:

lc - ldap connection

pc - provider configuration

Method Detail

getTimeLimit

public int getTimeLimit()

Returns the operation time limit in milliseconds.

Returns:

operation time limit

setTimeLimit

public void setTimeLimit(int limit)

Sets the time limit.

Parameters:

limit - time in milliseconds

getLdapConnection

public netscape.ldap.LDAPConnection getLdapConnection()

Returns the underlying ldap connection.

Returns:

ldap connection

close

public void close(org.ldaptive.control.RequestControl[] controls)
           throws org.ldaptive.LdapException

Specified by:

close in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

bind

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

Specified by:

bind in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

anonymousBind

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

Performs an anonymous bind.

Parameters:

request - to bind with

Returns:

bind response

Throws:

org.ldaptive.LdapException - if an error occurs

simpleBind

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

Performs a simple bind.

Parameters:

request - to bind with

Returns:

bind response

Throws:

org.ldaptive.LdapException - if an error occurs

saslBind

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

Performs a sasl bind.

Parameters:

request - to bind with

Returns:

bind response

Throws:

org.ldaptive.LdapException - if an error occurs

add

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

Specified by:

add in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

compare

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

Specified by:

compare in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

delete

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

Specified by:

delete in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

modify

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

Specified by:

modify in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

modifyDn

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

Specified by:

modifyDn in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

search

public org.ldaptive.provider.SearchIterator search(org.ldaptive.SearchRequest request)
                                            throws org.ldaptive.LdapException

Specified by:

search in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

searchAsync

public void searchAsync(org.ldaptive.SearchRequest request,
                        org.ldaptive.provider.SearchListener listener)
                 throws org.ldaptive.LdapException

Specified by:

searchAsync in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

abandon

public void abandon(int messageId,
                    org.ldaptive.control.RequestControl[] controls)
             throws org.ldaptive.LdapException

Specified by:

abandon in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

extendedOperation

public org.ldaptive.Response<?> extendedOperation(org.ldaptive.extended.ExtendedRequest request)
                                           throws org.ldaptive.LdapException

Specified by:

extendedOperation in interface org.ldaptive.provider.ProviderConnection

Throws:

org.ldaptive.LdapException

addUnsolicitedNotificationListener

public void addUnsolicitedNotificationListener(org.ldaptive.extended.UnsolicitedNotificationListener listener)

Specified by:

addUnsolicitedNotificationListener in interface org.ldaptive.provider.ProviderConnection

removeUnsolicitedNotificationListener

public void removeUnsolicitedNotificationListener(org.ldaptive.extended.UnsolicitedNotificationListener listener)

Specified by:

removeUnsolicitedNotificationListener in interface org.ldaptive.provider.ProviderConnection

getLDAPConstraints

protected netscape.ldap.LDAPConstraints getLDAPConstraints(org.ldaptive.Request request)

Creates a LDAP constraints from the supplied request.

Parameters:

request - to read properties from

Returns:

ldap constraints

initializeLDAPConstraints

protected void initializeLDAPConstraints(org.ldaptive.Request request,
                                         netscape.ldap.LDAPConstraints cons)

Configures the supplied ldap constraints using the supplied request and provider configuration.

Parameters:

request - to read properties froim

cons - to configure

throwOperationException

protected void throwOperationException(org.ldaptive.Request request,
                                       netscape.ldap.LDAPResponse ldapResponse)
                                throws org.ldaptive.LdapException

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

Parameters:

request - that produced the exception

ldapResponse - provider response

Throws:

org.ldaptive.LdapException - wrapping the ldap exception

createResponse

protected <T> org.ldaptive.Response<T> createResponse(org.ldaptive.Request request,
                                                      T result,
                                                      netscape.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(netscape.ldap.LDAPException e)
                             throws org.ldaptive.LdapException

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

Parameters:

e - that was produced

Throws:

org.ldaptive.LdapException - wrapping the ldap exception