com.rli.ldapclient

Class LDAPOperations2

java.lang.Object

RliLDAPClient

com.rli.ldapclient.LDAPOperations2

All Implemented Interfaces:

java.lang.AutoCloseable

public class LDAPOperations2
extends RliLDAPClient
implements java.lang.AutoCloseable

RLI Ldap client

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Throwable	except
static java.lang.String	groupDNprefix LookUpGroupmembersDN : specialized LookupCondition returning list of dn of entries found For each entry that is a group insert 'groupdn:' in front of the dn found .

Constructor Summary

Constructors

Constructor and Description
LDAPOperations2()
LDAPOperations2(ConnString2 conStr)
LDAPOperations2(org.apache.logging.log4j.Logger logger)
LDAPOperations2(java.lang.String ldapURL)
LDAPOperations2(java.lang.String ldapURL, java.lang.String bindDN, java.lang.String passwd)
LDAPOperations2(VDQuery vdquery)

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String ldapDN, java.util.HashMap<java.lang.String,java.util.List<java.lang.Object>> map) add an entry
static boolean	Authenticate(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord) Authenticate user
static boolean	Authenticate(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord, java.util.Vector<LDAPControl[]> bindResponseControl) Authenticate user
static boolean	Authenticate(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord, java.util.Vector<LDAPControl[]> bindResponseControl, java.util.Vector<LDAPControl> bindRequestControl) Authenticate user
static boolean	Authenticate(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord, java.util.Vector<LDAPControl[]> bindResponseControl, java.util.Vector<LDAPControl> bindRequestControl, java.util.HashMap<java.lang.String,java.lang.Object> additionalProperites) Authenticate user
static boolean	checkBindControlPasswordExpired(LDAPControl[] respControls) check for password expired control
static LDAPOperations2	createDefaultLDAPOperations()
static boolean	csvExport(java.lang.String ldapCMD, java.lang.String ldapUser, java.lang.String ldapPassword, int sizelimit, java.lang.String attributemapping, java.lang.String CSVFilepath) ldapCmd = "ldap://host:389/dc=na,dc=radiantlogic,dc=com??sub?(objectclass=inetOrgPerson)" attributemapping = dn -> DN, cn->NAME, givenname -> FIRSTNAME, sn -> LASTNAME, mail -> EMAIL , tile -> JOBTITLE , uid -> PERSONID; (optional) addinalproperties_map = {"VAL_SEPERATOR"=>"#", "ROW_DELIMITER"=>"\\r\\n", "COL_DELIMITER"=>",")
static boolean	csvExport(java.lang.String ldapCMD, java.lang.String ldapUser, java.lang.String ldapPassword, int sizelimit, java.lang.String attributemapping, java.lang.String CSVFilepath, java.util.Map<java.lang.String,java.lang.String> addnlProps) ldapCmd = "ldap://host:389/dc=na,dc=radiantlogic,dc=com??sub?(objectclass=inetOrgPerson)" attributemapping = dn -> DN, cn->NAME, givenname -> FIRSTNAME, sn -> LASTNAME, mail -> EMAIL , tile -> JOBTITLE , uid -> PERSONID; addinalproperties map {"VAL_SEPERATOR"=>"#", "ROW_DELIMITER"=>"\\r\\n", "COL_DELIMITER"=>",")
static boolean	csvExport(java.lang.String ldapCMD, java.lang.String ldapUser, java.lang.String ldapPassword, int sizelimit, java.lang.String attributemapping, java.lang.String CSVFilepath, java.util.Map<java.lang.String,java.lang.String> addnlProps, boolean append) ldapCmd = "ldap://host:389/dc=na,dc=radiantlogic,dc=com??sub?(objectclass=inetOrgPerson)" attributemapping = dn -> DN, cn->NAME, givenname -> FIRSTNAME, sn -> LASTNAME, mail -> EMAIL , tile -> JOBTITLE , uid -> PERSONID; addinalproperties map {"VAL_SEPERATOR"=>"#", "ROW_DELIMITER"=>"\\r\\n", "COL_DELIMITER"=>",") boolean append : new file or append to existing file
boolean	doConnect(ConnString2 conStr) connect using connection string
boolean	doConnect(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord) connect using ldap url
boolean	doConnect(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord, java.util.Vector<LDAPControl[]> bindResponseControl) connect using ldap url
boolean	doConnect(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord, java.util.Vector<LDAPControl[]> bindResponseControl, boolean disableReferral, boolean mayUseDefProxyCred) connect using ldap url
boolean	doConnect(java.lang.String ldapUrl, java.lang.String username, java.lang.String passWord, java.util.Vector<LDAPControl[]> bindResponseControl, boolean disableReferral, boolean mayUseDefProxyCred, boolean doBind, boolean isPassThroughMode, java.lang.String passThroughUser) connect using ldap url
boolean	doConnect(VDQuery vdQuery) connect using information from VDQuery
void	doDisconnect() Disconnects ldap connection
boolean	doVDSConnect() connect to local vds server
boolean	doVDSConnect(java.lang.String BaseDN) connect to local vds server
boolean	doVDSConnect(java.lang.String BaseDN, java.util.Vector<LDAPControl[]> bindResponseControl) Connect to local vds server using LDAPControls
java.lang.String	findObject(java.lang.String baseDN, java.lang.String filter, int scope)
byte[]	getADDirSyncCookie() returns ADDirSync cookie
static LDAPEntry	getConnPoolStat(java.lang.String dn)
java.lang.Throwable	getLastError()
static java.util.List<LDAPEntry>	getLDAPEntries(java.lang.String ldapUrlcmd, int sizelimit) performs search and returns entries in a list
java.util.List<LDAPEntry>	getLDAPEntries(java.lang.String base_dn, int scope, java.lang.String filter, java.lang.String[] attrs, int sizelimit) performs search and returns entries in a list
static java.util.List<LDAPEntry>	getLDAPEntries(java.lang.String ldapUrlcmd, java.lang.String username, java.lang.String password, int sizelimit) performs search and returns entries in a list
boolean	hasDnVisible(java.lang.String baseDn) check if basedn exist
static boolean	isSimpleBind(java.lang.String username)
static boolean	isStandalone()
java.util.List<java.lang.Object>	LookUpCondition(java.lang.String dn, java.lang.String filter, int scope, java.lang.String outAttr) Lookup : get the values of an attribute from entries based on search criteria.
java.util.List<java.lang.Object>	LookUpCondition(java.lang.String dn, java.lang.String filter, int scope, java.lang.String outAttr, int ldapLimit, boolean distinct) Lookup : get the values of an attribute from entries based on search criteria.
java.util.List<java.lang.Object>	LookUpGroupmembersDN(java.lang.String dn, java.lang.String filter, java.lang.String nestedgroupobjectclass)
java.util.List<java.lang.Object>	LookUpVDS(java.lang.String dn, java.lang.String filter, int scope, java.lang.String outAttr) Lookup : get the values of an attribute from entries based on search criteria
static java.lang.String	mapDnToDomainDn(java.lang.String dn)
void	resetLastError()
LDAPEnumeration	searchADforchanges(java.lang.String basedn, java.lang.String filter, java.lang.String[] attributes, byte[] cookie) search AD for changes using ADDirSyncControl
LDAPEnumeration	searchADforchanges(java.lang.String basedn, java.lang.String filter, java.lang.String[] attributes, byte[] cookie, int sizelimit) search AD for changes using ADDirSyncControl
static LDAPEntry	searchInternalVDS_Base(java.lang.String baseDn) performs base search on vds
static LDAPEntry	searchInternalVDS_Base(java.lang.String baseDn, java.lang.String filter, java.lang.String[] attrs) performs base search on vds
LDAPEnumeration	searchLDAPforchanges(java.lang.String basedn, java.lang.String filter, java.lang.String[] attributes, long changenumber, int sizelimit) search LDAP for changes using changelog
LDAPEnumeration	searchWithoutPaging(java.lang.String basedn, int scope, java.lang.String filter, java.lang.String[] attributes, int sizelimit) search without paging
LDAPEnumeration	searchWithPaging(java.lang.String basedn, int scope, java.lang.String filter, java.lang.String[] attributes, int pageSize) search with paging
static void	setStandalone(boolean standalone)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

except

protected java.lang.Throwable except

groupDNprefix

public static java.lang.String groupDNprefix

LookUpGroupmembersDN : specialized LookupCondition returning list of dn of entries found For each entry that is a group insert 'groupdn:' in front of the dn found . a previous connection to an LDAP (or VDS) server must be done using doConnect(...) . This function will help detecting 'nested groups'

Constructor Detail

LDAPOperations2

public LDAPOperations2()

LDAPOperations2

public LDAPOperations2(org.apache.logging.log4j.Logger logger)

LDAPOperations2

public LDAPOperations2(java.lang.String ldapURL)
                throws LDAPException

Parameters:

ldapURL - ldap[s]://hostname:port/basedn

Throws:

LDAPException

LDAPOperations2

public LDAPOperations2(java.lang.String ldapURL,
                       java.lang.String bindDN,
                       java.lang.String passwd)
                throws LDAPException

Parameters:

ldapURL - ldap[s]://hostname:port/basedn

bindDN -

passwd -

Throws:

LDAPException

LDAPOperations2

public LDAPOperations2(ConnString2 conStr)
                throws LDAPException

Parameters:

conStr - connection string

Throws:

LDAPException

LDAPOperations2

public LDAPOperations2(VDQuery vdquery)
                throws LDAPException

Parameters:

vdquery -

Throws:

LDAPException

Method Detail

setStandalone

public static void setStandalone(boolean standalone)

isStandalone

public static boolean isStandalone()

doConnect

public boolean doConnect(ConnString2 conStr)
                  throws LDAPException

connect using connection string

Parameters:

conStr -

Returns:

Throws:

LDAPException

doConnect

public boolean doConnect(VDQuery vdQuery)
                  throws LDAPException

connect using information from VDQuery

Parameters:

vdQuery -

Returns:

true if connection successful; false otherwise.

Throws:

LDAPException

doVDSConnect

public boolean doVDSConnect()
                     throws LDAPException

connect to local vds server

Returns:

Throws:

LDAPException

doVDSConnect

public boolean doVDSConnect(java.lang.String BaseDN)
                     throws LDAPException

connect to local vds server

Parameters:

BaseDN -

Returns:

Throws:

LDAPException

doVDSConnect

public boolean doVDSConnect(java.lang.String BaseDN,
                            java.util.Vector<LDAPControl[]> bindResponseControl)
                     throws LDAPException

Connect to local vds server using LDAPControls

Parameters:

BaseDN -

bindResponseControl -

Returns:

Throws:

LDAPException

doConnect

public boolean doConnect(java.lang.String ldapUrl,
                         java.lang.String username,
                         java.lang.String passWord)
                  throws LDAPException

connect using ldap url

Parameters:

ldapUrl - ldap[s]://hostname:port/basedn or ldap://[datasourcename]/

username -

passWord -

Returns:

Throws:

LDAPException

doConnect

public boolean doConnect(java.lang.String ldapUrl,
                         java.lang.String username,
                         java.lang.String passWord,
                         java.util.Vector<LDAPControl[]> bindResponseControl)
                  throws LDAPException

connect using ldap url

Parameters:

ldapUrl - ldap[s]://hostname:port/basedn or ldap://[datasourcename]/

username -

passWord -

bindResponseControl -

Returns:

Throws:

LDAPException

doConnect

public boolean doConnect(java.lang.String ldapUrl,
                         java.lang.String username,
                         java.lang.String passWord,
                         java.util.Vector<LDAPControl[]> bindResponseControl,
                         boolean disableReferral,
                         boolean mayUseDefProxyCred)
                  throws LDAPException

connect using ldap url

Parameters:

ldapUrl - ldap[s]://hostname:port/basedn or ldap://[datasourcename]/

username -

passWord -

bindResponseControl -

disableReferral -

mayUseDefProxyCred -

Returns:

Throws:

LDAPException

doConnect

public boolean doConnect(java.lang.String ldapUrl,
                         java.lang.String username,
                         java.lang.String passWord,
                         java.util.Vector<LDAPControl[]> bindResponseControl,
                         boolean disableReferral,
                         boolean mayUseDefProxyCred,
                         boolean doBind,
                         boolean isPassThroughMode,
                         java.lang.String passThroughUser)
                  throws LDAPException

connect using ldap url

Parameters:

ldapUrl - ldap[s]://hostname:port/basedn or ldap://[datasourcename]/

username -

passWord -

bindResponseControl -

disableReferral -

mayUseDefProxyCred -

doBind -

Returns:

Throws:

LDAPException

doDisconnect

public void doDisconnect()

Disconnects ldap connection

searchInternalVDS_Base

public static LDAPEntry searchInternalVDS_Base(java.lang.String baseDn)
                                        throws LDAPException

performs base search on vds

Parameters:

baseDn -

Returns:

Throws:

LDAPException

searchInternalVDS_Base

public static LDAPEntry searchInternalVDS_Base(java.lang.String baseDn,
                                               java.lang.String filter,
                                               java.lang.String[] attrs)
                                        throws LDAPException

performs base search on vds

Parameters:

baseDn -

filter -

attrs -

Returns:

Throws:

LDAPException

Authenticate

public static boolean Authenticate(java.lang.String ldapUrl,
                                   java.lang.String username,
                                   java.lang.String passWord)
                            throws LDAPException

Authenticate user

Parameters:

ldapUrl - ldap[s]://hostname:port/basedn or ldap://[datasourcename]/

username -

passWord -

Returns:

Throws:

LDAPException

Authenticate

public static boolean Authenticate(java.lang.String ldapUrl,
                                   java.lang.String username,
                                   java.lang.String passWord,
                                   java.util.Vector<LDAPControl[]> bindResponseControl)
                            throws LDAPException

Authenticate user

Parameters:

ldapUrl - ldap[s]://hostname:port/basedn or ldap://[datasourcename]/

username -

passWord -

bindResponseControl -

Returns:

Throws:

LDAPException

Authenticate

public static boolean Authenticate(java.lang.String ldapUrl,
                                   java.lang.String username,
                                   java.lang.String passWord,
                                   java.util.Vector<LDAPControl[]> bindResponseControl,
                                   java.util.Vector<LDAPControl> bindRequestControl)
                            throws LDAPException

Authenticate user

Parameters:

ldapUrl -

username -

passWord -

bindResponseControl -

bindRequestControl -

Returns:

Throws:

LDAPException

Authenticate

public static boolean Authenticate(java.lang.String ldapUrl,
                                   java.lang.String username,
                                   java.lang.String passWord,
                                   java.util.Vector<LDAPControl[]> bindResponseControl,
                                   java.util.Vector<LDAPControl> bindRequestControl,
                                   java.util.HashMap<java.lang.String,java.lang.Object> additionalProperites)
                            throws LDAPException

Authenticate user

Parameters:

ldapUrl - ldap[s]://hostname:port/basedn or ldap://[datasourcename]/

username -

passWord -

bindResponseControl -

bindRequestControl -

additionalProperites -

Returns:

Throws:

LDAPException

LookUpCondition

public java.util.List<java.lang.Object> LookUpCondition(java.lang.String dn,
                                                        java.lang.String filter,
                                                        int scope,
                                                        java.lang.String outAttr)

Lookup : get the values of an attribute from entries based on search criteria. a previous connection to an LDAP (or VDS) server must be done using doConnect(...)

Parameters:

dn - - dn defining the starting point to look from

filter - - valid ldap search filter syntax example : (&(orderid=3)(productid=3))

Scope - --- scope - one, sub or base

outAttr - name of the output attribute

Returns:

values of the output Attribute in a List , or null if no match found

LookUpCondition

public java.util.List<java.lang.Object> LookUpCondition(java.lang.String dn,
                                                        java.lang.String filter,
                                                        int scope,
                                                        java.lang.String outAttr,
                                                        int ldapLimit,
                                                        boolean distinct)

Lookup : get the values of an attribute from entries based on search criteria. a previous connection to an LDAP (or VDS) server must be done using doConnect(...)

Parameters:

dn - - dn defining the starting point to look from

filter - - valid ldap search filter syntax example : (&(orderid=3)(productid=3))

Scope - --- scope - one, sub or base

outAttr - name of the output attribute

ldapLimit - --- ldap limit - 0 returns all entries

Returns:

values of the output Attribute in a List , or null if no match found

LookUpVDS

public java.util.List<java.lang.Object> LookUpVDS(java.lang.String dn,
                                                  java.lang.String filter,
                                                  int scope,
                                                  java.lang.String outAttr)
                                           throws LDAPException

Lookup : get the values of an attribute from entries based on search criteria

Parameters:

dn -

filter -

scope -

outAttr - name of the output attribute

Returns:

Throws:

LDAPException

hasDnVisible

public boolean hasDnVisible(java.lang.String baseDn)

check if basedn exist

Parameters:

baseDn -

Returns:

true if baseDn exist; otherwise returns false

getLDAPEntries

public java.util.List<LDAPEntry> getLDAPEntries(java.lang.String base_dn,
                                                int scope,
                                                java.lang.String filter,
                                                java.lang.String[] attrs,
                                                int sizelimit)

performs search and returns entries in a list

Parameters:

base_dn -

scope -

filter -

attrs -

sizelimit -

Returns:

getLDAPEntries

public static java.util.List<LDAPEntry> getLDAPEntries(java.lang.String ldapUrlcmd,
                                                       int sizelimit)
                                                throws LDAPException

performs search and returns entries in a list

Parameters:

ldapUrlcmd - ldap://[datasourcename]/basedn?list_attribute_to_return?scope?filter

sizelimit -

Returns:

Throws:

LDAPException

getLDAPEntries

public static java.util.List<LDAPEntry> getLDAPEntries(java.lang.String ldapUrlcmd,
                                                       java.lang.String username,
                                                       java.lang.String password,
                                                       int sizelimit)
                                                throws LDAPException

performs search and returns entries in a list

Parameters:

ldapUrlcmd - ldap://[datasourcename]/basedn?list_attribute_to_return?scope?filter

username -

password -

sizelimit -

Returns:

Throws:

LDAPException

LookUpGroupmembersDN

public java.util.List<java.lang.Object> LookUpGroupmembersDN(java.lang.String dn,
                                                             java.lang.String filter,
                                                             java.lang.String nestedgroupobjectclass)

add

public void add(java.lang.String ldapDN,
                java.util.HashMap<java.lang.String,java.util.List<java.lang.Object>> map)
         throws LDAPException

add an entry

Parameters:

ldapDN -

map -

Throws:

LDAPException

checkBindControlPasswordExpired

public static boolean checkBindControlPasswordExpired(LDAPControl[] respControls)

check for password expired control

Parameters:

respControls -

Returns:

findObject

public java.lang.String findObject(java.lang.String baseDN,
                                   java.lang.String filter,
                                   int scope)

Returns:

full dn of first object found matching the condition or null otherwise

csvExport

public static boolean csvExport(java.lang.String ldapCMD,
                                java.lang.String ldapUser,
                                java.lang.String ldapPassword,
                                int sizelimit,
                                java.lang.String attributemapping,
                                java.lang.String CSVFilepath)
                         throws java.lang.Exception

ldapCmd = "ldap://host:389/dc=na,dc=radiantlogic,dc=com??sub?(objectclass=inetOrgPerson)"
attributemapping = dn -> DN, cn->NAME, givenname -> FIRSTNAME, sn -> LASTNAME, mail -> EMAIL , tile -> JOBTITLE , uid -> PERSONID;
(optional) addinalproperties_map = {"VAL_SEPERATOR"=>"#", "ROW_DELIMITER"=>"\\r\\n", "COL_DELIMITER"=>",")

Throws:

java.lang.Exception

csvExport

public static boolean csvExport(java.lang.String ldapCMD,
                                java.lang.String ldapUser,
                                java.lang.String ldapPassword,
                                int sizelimit,
                                java.lang.String attributemapping,
                                java.lang.String CSVFilepath,
                                java.util.Map<java.lang.String,java.lang.String> addnlProps)
                         throws java.lang.Exception

ldapCmd = "ldap://host:389/dc=na,dc=radiantlogic,dc=com??sub?(objectclass=inetOrgPerson)"
attributemapping = dn -> DN, cn->NAME, givenname -> FIRSTNAME, sn -> LASTNAME, mail -> EMAIL , tile -> JOBTITLE , uid -> PERSONID;
addinalproperties map {"VAL_SEPERATOR"=>"#", "ROW_DELIMITER"=>"\\r\\n", "COL_DELIMITER"=>",")

Throws:

java.lang.Exception

csvExport

public static boolean csvExport(java.lang.String ldapCMD,
                                java.lang.String ldapUser,
                                java.lang.String ldapPassword,
                                int sizelimit,
                                java.lang.String attributemapping,
                                java.lang.String CSVFilepath,
                                java.util.Map<java.lang.String,java.lang.String> addnlProps,
                                boolean append)
                         throws java.lang.Exception

ldapCmd = "ldap://host:389/dc=na,dc=radiantlogic,dc=com??sub?(objectclass=inetOrgPerson)"
attributemapping = dn -> DN, cn->NAME, givenname -> FIRSTNAME, sn -> LASTNAME, mail -> EMAIL , tile -> JOBTITLE , uid -> PERSONID;
addinalproperties map {"VAL_SEPERATOR"=>"#", "ROW_DELIMITER"=>"\\r\\n", "COL_DELIMITER"=>",") boolean append : new file or append to existing file

Throws:

java.lang.Exception

getLastError

public java.lang.Throwable getLastError()

resetLastError

public void resetLastError()

createDefaultLDAPOperations

public static LDAPOperations2 createDefaultLDAPOperations()
                                                   throws LDAPException

Returns:

Throws:

LDAPException

mapDnToDomainDn

public static java.lang.String mapDnToDomainDn(java.lang.String dn)

Parameters:

dn -

Returns:

getConnPoolStat

public static LDAPEntry getConnPoolStat(java.lang.String dn)

Parameters:

dn -

Returns:

searchADforchanges

public LDAPEnumeration searchADforchanges(java.lang.String basedn,
                                          java.lang.String filter,
                                          java.lang.String[] attributes,
                                          byte[] cookie)
                                   throws LDAPException

search AD for changes using ADDirSyncControl

Parameters:

basedn -

filter -

attributes -

cookie -

Returns:

Throws:

LDAPException

searchADforchanges

public LDAPEnumeration searchADforchanges(java.lang.String basedn,
                                          java.lang.String filter,
                                          java.lang.String[] attributes,
                                          byte[] cookie,
                                          int sizelimit)
                                   throws LDAPException

search AD for changes using ADDirSyncControl

Parameters:

basedn -

filter -

attributes -

cookie -

sizelimit -

Returns:

LDAPEnumeration

Throws:

LDAPException

getADDirSyncCookie

public byte[] getADDirSyncCookie()

returns ADDirSync cookie

Returns:

cookie

searchLDAPforchanges

public LDAPEnumeration searchLDAPforchanges(java.lang.String basedn,
                                            java.lang.String filter,
                                            java.lang.String[] attributes,
                                            long changenumber,
                                            int sizelimit)
                                     throws LDAPException

search LDAP for changes using changelog

Parameters:

basedn -

filter -

attributes -

cookie -

sizelimit -

Returns:

LDAPEnumeration

Throws:

LDAPException

searchWithoutPaging

public LDAPEnumeration searchWithoutPaging(java.lang.String basedn,
                                           int scope,
                                           java.lang.String filter,
                                           java.lang.String[] attributes,
                                           int sizelimit)
                                    throws LDAPException

search without paging

Parameters:

basedn -

scope -

filter -

attributes -

sizelimit -

Returns:

Throws:

LDAPException

searchWithPaging

public LDAPEnumeration searchWithPaging(java.lang.String basedn,
                                        int scope,
                                        java.lang.String filter,
                                        java.lang.String[] attributes,
                                        int pageSize)
                                 throws LDAPException

search with paging

Parameters:

basedn -

scope -

filter -

attributes -

pageSize - - must be >0 to work correctly, must be proper size (500?) to work efficiently.

Returns:

Throws:

LDAPException

isSimpleBind

public static boolean isSimpleBind(java.lang.String username)