edu.internet2.middleware.grouper.ldap.ldaptive

Class LdaptiveSessionImpl

java.lang.Object

edu.internet2.middleware.grouper.ldap.ldaptive.LdaptiveSessionImpl

All Implemented Interfaces:

LdapSession

public class LdaptiveSessionImpl
extends Object
implements LdapSession

will handle the ldap config, and inverse of control for pooling

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ENCRYPTABLE_LDAPTIVE_PROPERTIES What ldaptive properties will be decrypted if their values are Morph files? (We don't decrypt all properties because that would prevent the use of slashes in the property values)

Constructor Summary

Constructors

Constructor and Description
LdaptiveSessionImpl()

Method Summary

Modifier and Type	Method and Description
void	assignDebug(boolean isDebug) if we should capture debug info
void	assignDebug(boolean isDebug, StringBuilder theDebugLog) if we should capture debug info
void	authenticate(String ldapServerId, String userDn, String password) Authenticate a user
boolean	create(String ldapServerId, LdapEntry ldapEntry) Create entry.
void	delete(String ldapServerId, String dn) Delete an entry if it exists.
StringBuilder	getDebugLog() debug log where lines are separated by newlines
void	internal_modifyHelper(String ldapServerId, String dn, List<LdapModificationItem> ldapModificationItems) modify attributes for an object.
boolean	isDebug() if we are debugging
<R> List<R>	list(Class<R> returnType, String ldapServerId, String searchDn, LdapSearchScope ldapSearchScope, String filter, String attributeName) run a filter, for one attribute, and return a list of that attribute typecast as a certain type note, if it is a multi-valued attributes, and there are multiple object results, it will be flattened into one list
List<LdapEntry>	list(String ldapServerId, String searchDn, LdapSearchScope ldapSearchScope, String filter, String[] attributeNames, Long sizeLimit) Run a filter and return the results.
<R> Map<String,List<R>>	listInObjects(Class<R> returnType, String ldapServerId, String searchDn, LdapSearchScope ldapSearchScope, String filter, String attributeName) run a filter, for one attribute, and return a map of the DN key to the value of list of that attribute typecast as a certain type
boolean	move(String ldapServerId, String oldDn, String newDn) Move an object to a new dn.
List<LdapEntry>	read(String ldapServerId, String searchDn, List<String> dnList, String[] attributeNames) Get the following entries.
void	refreshConnectionsIfNeeded(String ldapServerId) Check if connections need to be refreshed due to config changes
boolean	testConnection(String ldapServerId) test a connection

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

What ldaptive properties will be decrypted if their values are Morph files? (We don't decrypt all properties because that would prevent the use of slashes in the property values)

Constructor Detail

LdaptiveSessionImpl

public LdaptiveSessionImpl()

Method Detail

getDebugLog

public StringBuilder getDebugLog()

debug log where lines are separated by newlines

Specified by:

getDebugLog in interface LdapSession

Returns:

isDebug

public boolean isDebug()

if we are debugging

Specified by:

isDebug in interface LdapSession

Returns:

assignDebug

public void assignDebug(boolean isDebug,
                        StringBuilder theDebugLog)

if we should capture debug info

Parameters:

isDebug -

assignDebug

public void assignDebug(boolean isDebug)

if we should capture debug info

Specified by:

assignDebug in interface LdapSession

Parameters:

isDebug -

list

public <R> List<R> list(Class<R> returnType,
                        String ldapServerId,
                        String searchDn,
                        LdapSearchScope ldapSearchScope,
                        String filter,
                        String attributeName)

Description copied from interface: LdapSession

run a filter, for one attribute, and return a list of that attribute typecast as a certain type note, if it is a multi-valued attributes, and there are multiple object results, it will be flattened into one list

Specified by:

list in interface LdapSession

Parameters:

returnType - note, only String.class is currently supported

Returns:

the list of results, never null

See Also:

LdapSession.list(java.lang.Class, java.lang.String, java.lang.String, edu.internet2.middleware.grouper.ldap.LdapSearchScope, java.lang.String, java.lang.String)

listInObjects

public <R> Map<String,List<R>> listInObjects(Class<R> returnType,
                                             String ldapServerId,
                                             String searchDn,
                                             LdapSearchScope ldapSearchScope,
                                             String filter,
                                             String attributeName)

Description copied from interface: LdapSession

run a filter, for one attribute, and return a map of the DN key to the value of list of that attribute typecast as a certain type

Specified by:

listInObjects in interface LdapSession

Parameters:

returnType - note, only String.class is currently supported

Returns:

the list of results, never null

See Also:

LdapSession.listInObjects(java.lang.Class, java.lang.String, java.lang.String, edu.internet2.middleware.grouper.ldap.LdapSearchScope, java.lang.String, java.lang.String)

list

public List<LdapEntry> list(String ldapServerId,
                            String searchDn,
                            LdapSearchScope ldapSearchScope,
                            String filter,
                            String[] attributeNames,
                            Long sizeLimit)

Description copied from interface: LdapSession

Run a filter and return the results.

Specified by:

list in interface LdapSession

Returns:

the list of results, never null

See Also:

LdapSession.list(java.lang.String, java.lang.String, edu.internet2.middleware.grouper.ldap.LdapSearchScope, java.lang.String, java.lang.String[], java.lang.Long)

read

public List<LdapEntry> read(String ldapServerId,
                            String searchDn,
                            List<String> dnList,
                            String[] attributeNames)

Description copied from interface: LdapSession

Get the following entries.

Specified by:

read in interface LdapSession

Returns:

the list of results, never null

authenticate

public void authenticate(String ldapServerId,
                         String userDn,
                         String password)

Description copied from interface: LdapSession

Authenticate a user

Specified by:

authenticate in interface LdapSession

See Also:

LdapSession.authenticate(java.lang.String, java.lang.String, java.lang.String)

delete

public void delete(String ldapServerId,
                   String dn)

Description copied from interface: LdapSession

Delete an entry if it exists.

Specified by:

delete in interface LdapSession

create

public boolean create(String ldapServerId,
                      LdapEntry ldapEntry)

Description copied from interface: LdapSession

Create entry. If entry exists, update attributes instead.

Specified by:

create in interface LdapSession

Returns:

true if created, false if updated

move

public boolean move(String ldapServerId,
                    String oldDn,
                    String newDn)

Description copied from interface: LdapSession

Move an object to a new dn. Assuming this would only be called if it's expected to work. i.e. If the ldap server doesn't allow this, the caller should avoid calling this and instead do a delete/re-create as appropriate.

Specified by:

move in interface LdapSession

Returns:

true if moved, false if newDn exists and oldDn doesn't exist so no update

internal_modifyHelper

public void internal_modifyHelper(String ldapServerId,
                                  String dn,
                                  List<LdapModificationItem> ldapModificationItems)

Description copied from interface: LdapSession

modify attributes for an object. this should be done in bulk, and if there is an error, throw it

Specified by:

internal_modifyHelper in interface LdapSession

testConnection

public boolean testConnection(String ldapServerId)

Description copied from interface: LdapSession

test a connection

Specified by:

testConnection in interface LdapSession

Returns:

true if success, false or exception if not successful (error is in exception)

refreshConnectionsIfNeeded

public void refreshConnectionsIfNeeded(String ldapServerId)

Description copied from interface: LdapSession

Check if connections need to be refreshed due to config changes

Specified by:

refreshConnectionsIfNeeded in interface LdapSession