edu.internet2.middleware.grouper.pspng

Class LdapSystem

java.lang.Object

edu.internet2.middleware.grouper.pspng.LdapSystem

public class LdapSystem
extends Object

This class encapsulates an LDAP system configured by a collection of properties defined withing grouper-loader.properties

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	_ldaptiveProperties
static String[]	ENCRYPTABLE_LDAPTIVE_PROPERTIES
String	ldapSystemName
protected boolean	searchResultPagingEnabled_defaultValue
protected int	searchResultPagingSize_default_value

Constructor Summary

Constructors

Constructor and Description
LdapSystem(String ldapSystemName, boolean isActiveDirectory)

Method Summary

Modifier and Type	Method and Description
static boolean	attributeHasNoValues(org.ldaptive.LdapAttribute attribute)
protected org.ldaptive.Connection	getLdapConnection()
org.ldaptive.pool.BlockingConnectionPool	getLdapPool()
Properties	getLdaptiveProperties()
org.ldaptive.SearchExecutor	getSearchExecutor() Returns ldaptive search executor configured according to properties
int	getSearchResultPagingSize()
boolean	isActiveDirectory()
boolean	isSearchResultPagingEnabled()
void	log(org.ldaptive.LdapEntry ldapEntry, String ldapEntryDescriptionFormat, Object... ldapEntryDescriptionArgs)
void	log(org.ldaptive.ModifyRequest modifyRequest, String descriptionFormat, Object... descriptionArgs)
static void	main(String[] args)
protected boolean	makeLdapDataCorrect(org.ldaptive.LdapEntry correctEntry, org.ldaptive.LdapEntry existingEntry, boolean valuesAreCaseSensitive)
protected boolean	makeLdapDnCorrect(org.ldaptive.LdapEntry correctEntry, org.ldaptive.LdapEntry existingEntry) Moves the ldap object if necessary.
boolean	makeLdapObjectCorrect(org.ldaptive.LdapEntry correctEntry, org.ldaptive.LdapEntry existingEntry, boolean valuesAreCaseSensitive)
protected void	performLdapAdd(org.ldaptive.LdapEntry entryToAdd)
protected void	performLdapDelete(String dnToDelete)
void	performLdapModify(org.ldaptive.ModifyRequest mod, boolean valuesAreCaseSensitive)
void	performLdapModify(org.ldaptive.ModifyRequest mod, boolean valuesAreCaseSensitive, boolean retryIfFails) This performs a modification and optionally retries it by comparing attributeValues being added/removed to those already on the ldap server
protected LdapObject	performLdapRead(com.unboundid.ldap.sdk.DN dn, String... attributes)
protected LdapObject	performLdapRead(String dn, Collection<String> attributes)
protected LdapObject	performLdapRead(String dn, String... attributes)
Set<String>	performLdapSearchRequest_returningValuesOfAnAttribute(int approximateNumResultsExpected, String searchBaseDn, org.ldaptive.SearchScope scope, String attributeToReturn, String filterTemplate, Object... filterParams)
protected void	performLdapSearchRequest(int approximateNumResultsExpected, org.ldaptive.SearchRequest request, org.ldaptive.handler.SearchEntryHandler callback)
List<LdapObject>	performLdapSearchRequest(int approximateNumResultsExpected, String searchBaseDn, org.ldaptive.SearchScope scope, Collection<String> attributesToReturn, org.ldaptive.SearchFilter filter)
List<LdapObject>	performLdapSearchRequest(int approximateNumResultsExpected, String searchBaseDn, org.ldaptive.SearchScope scope, Collection<String> attributesToReturn, String filterTemplate, Object... filterParams)
protected void	performTestLdapRead(org.ldaptive.Connection conn)
org.ldaptive.LdapEntry	rereadEntry(org.ldaptive.LdapEntry ldapEntry) Read a fresh copy of an ldapEntry, using the dn and attribute list from the provided entry.
boolean	test()

Methods inherited from class java.lang.Object

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

Field Detail

ENCRYPTABLE_LDAPTIVE_PROPERTIES

public static final String[] ENCRYPTABLE_LDAPTIVE_PROPERTIES

ldapSystemName

public final String ldapSystemName

_ldaptiveProperties

protected Properties _ldaptiveProperties

searchResultPagingEnabled_defaultValue

protected boolean searchResultPagingEnabled_defaultValue

searchResultPagingSize_default_value

protected int searchResultPagingSize_default_value

Constructor Detail

LdapSystem

public LdapSystem(String ldapSystemName,
                  boolean isActiveDirectory)

Method Detail

attributeHasNoValues

public static boolean attributeHasNoValues(org.ldaptive.LdapAttribute attribute)

log

public void log(org.ldaptive.LdapEntry ldapEntry,
                String ldapEntryDescriptionFormat,
                Object... ldapEntryDescriptionArgs)

log

public void log(org.ldaptive.ModifyRequest modifyRequest,
                String descriptionFormat,
                Object... descriptionArgs)

performTestLdapRead

protected void performTestLdapRead(org.ldaptive.Connection conn)
                            throws PspException

Throws:

PspException

getLdapPool

public org.ldaptive.pool.BlockingConnectionPool getLdapPool()
                                                     throws PspException

Throws:

PspException

isActiveDirectory

public boolean isActiveDirectory()

getLdaptiveProperties

public Properties getLdaptiveProperties()

getSearchResultPagingSize

public int getSearchResultPagingSize()

isSearchResultPagingEnabled

public boolean isSearchResultPagingEnabled()

getLdapConnection

protected org.ldaptive.Connection getLdapConnection()
                                             throws PspException

Throws:

PspException

getSearchExecutor

public org.ldaptive.SearchExecutor getSearchExecutor()

Returns ldaptive search executor configured according to properties

Returns:

performLdapAdd

protected void performLdapAdd(org.ldaptive.LdapEntry entryToAdd)
                       throws PspException

Throws:

PspException

performLdapDelete

protected void performLdapDelete(String dnToDelete)
                          throws PspException

Throws:

PspException

performLdapModify

public void performLdapModify(org.ldaptive.ModifyRequest mod,
                              boolean valuesAreCaseSensitive)
                       throws PspException

Throws:

PspException

performLdapModify

public void performLdapModify(org.ldaptive.ModifyRequest mod,
                              boolean valuesAreCaseSensitive,
                              boolean retryIfFails)
                       throws PspException

This performs a modification and optionally retries it by comparing attributeValues being added/removed to those already on the ldap server

Parameters:

mod -

retryIfFails - Should the Modify be retried if something goes wrong. This retry will do attributeValue-by-attributeValue comparison to make the retry as safe as possible

Throws:

PspException

performLdapRead

protected LdapObject performLdapRead(com.unboundid.ldap.sdk.DN dn,
                                     String... attributes)
                              throws PspException

Throws:

PspException

performLdapRead

protected LdapObject performLdapRead(String dn,
                                     Collection<String> attributes)
                              throws PspException

Throws:

PspException

performLdapRead

protected LdapObject performLdapRead(String dn,
                                     String... attributes)
                              throws PspException

Throws:

PspException

performLdapSearchRequest

protected void performLdapSearchRequest(int approximateNumResultsExpected,
                                        org.ldaptive.SearchRequest request,
                                        org.ldaptive.handler.SearchEntryHandler callback)
                                 throws PspException

Parameters:

request -

Throws:

org.ldaptive.LdapException

PspException

performLdapSearchRequest

public List<LdapObject> performLdapSearchRequest(int approximateNumResultsExpected,
                                                 String searchBaseDn,
                                                 org.ldaptive.SearchScope scope,
                                                 Collection<String> attributesToReturn,
                                                 String filterTemplate,
                                                 Object... filterParams)
                                          throws PspException

Throws:

PspException

performLdapSearchRequest

public List<LdapObject> performLdapSearchRequest(int approximateNumResultsExpected,
                                                 String searchBaseDn,
                                                 org.ldaptive.SearchScope scope,
                                                 Collection<String> attributesToReturn,
                                                 org.ldaptive.SearchFilter filter)
                                          throws PspException

Throws:

PspException

performLdapSearchRequest_returningValuesOfAnAttribute

public Set<String> performLdapSearchRequest_returningValuesOfAnAttribute(int approximateNumResultsExpected,
                                                                         String searchBaseDn,
                                                                         org.ldaptive.SearchScope scope,
                                                                         String attributeToReturn,
                                                                         String filterTemplate,
                                                                         Object... filterParams)
                                                                  throws PspException

Throws:

PspException

makeLdapObjectCorrect

public boolean makeLdapObjectCorrect(org.ldaptive.LdapEntry correctEntry,
                                     org.ldaptive.LdapEntry existingEntry,
                                     boolean valuesAreCaseSensitive)
                              throws PspException

Throws:

PspException

rereadEntry

public org.ldaptive.LdapEntry rereadEntry(org.ldaptive.LdapEntry ldapEntry)
                                   throws PspException

Read a fresh copy of an ldapEntry, using the dn and attribute list from the provided entry.

Parameters:

ldapEntry - Source of DN and attributes that should be read.

Returns:

Throws:

PspException

makeLdapDataCorrect

protected boolean makeLdapDataCorrect(org.ldaptive.LdapEntry correctEntry,
                                      org.ldaptive.LdapEntry existingEntry,
                                      boolean valuesAreCaseSensitive)
                               throws PspException

Throws:

PspException

makeLdapDnCorrect

protected boolean makeLdapDnCorrect(org.ldaptive.LdapEntry correctEntry,
                                    org.ldaptive.LdapEntry existingEntry)
                             throws PspException

Moves the ldap object if necessary. It does require the OU to already exist because OU templates and OU caching would make OU-creation here too intertwined with the provisioning objects

Parameters:

correctEntry -

existingEntry -

Returns:

Throws:

PspException

test

public boolean test()

main

public static void main(String[] args)