com.hfg.ldap

Class LDAPClient<U extends LDAP_User>

java.lang.Object

com.hfg.ldap.LDAPClient<U>

public class LDAPClient<U extends LDAP_User>
extends Object

Simple LDAP Client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LDAPClient.ReferralHandling

Constructor Summary

Constructors

Constructor and Description
LDAPClient()
LDAPClient(LDAP_Config inConfig)

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(LoginCredentials inCredentials)
U	getInfoForUser(LdapName inBaseDN, String inQuery)
U	getInfoForUser(LdapName inBaseDN, String inQuery, List<LDAP_UserField> inFields)
U	getInfoForUser(String inQuery)
U	getInfoForUser(String inQuery, List<LDAP_UserField> inFields)
List<U>	getInfoForUsers(LdapName inBaseDN, String inFilter, List<LDAP_UserField> inFields)
List<U>	getInfoForUsers(String inQuery)
List<U>	getInfoForUsers(String inFilter, List<LDAP_UserField> inFields)
List<U>	getInfoForUsersWithPaging(LdapContext inCtx, LdapName inBaseDN, String inFilter, List<LDAP_UserField> inFields)
static Logger	getLogger()
LDAPClient.ReferralHandling	getReferralHandling()
String	getServerURL()
LDAP_UserObjFactory<U>	getUserFactory()
List<U>	getUsersForGroup(String inFilter)
LDAPClient<U>	setGroupContext(LdapName inValue)
LDAPClient<U>	setGroupContext(String inValue)
LDAPClient<U>	setPrincipalContext(LdapName inValue)
LDAPClient<U>	setPrincipalContext(String inValue)
LDAPClient<U>	setPrincipalCredentials(LoginCredentials inValue) Specifies the credentials to be used to access the LDAP server.
LDAPClient<U>	setPrincipalFieldName(String inValue)
LDAPClient<U>	setPrincipalSuffix(String inValue)
LDAPClient<U>	setReferralHandling(LDAPClient.ReferralHandling inValue)
LDAPClient<U>	setServerURL(String inValue)
LDAPClient<U>	setUserContext(LdapName inValue)
LDAPClient<U>	setUserContext(String inValue)
LDAPClient<U>	setUserFactory(LDAP_UserObjFactory<U> inValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPClient

public LDAPClient()

LDAPClient

public LDAPClient(LDAP_Config inConfig)

Method Detail

getLogger

public static Logger getLogger()

setServerURL

public LDAPClient<U> setServerURL(String inValue)

getServerURL

public String getServerURL()

setUserContext

public LDAPClient<U> setUserContext(String inValue)

setReferralHandling

public LDAPClient<U> setReferralHandling(LDAPClient.ReferralHandling inValue)

getReferralHandling

public LDAPClient.ReferralHandling getReferralHandling()

setUserContext

public LDAPClient<U> setUserContext(LdapName inValue)

setGroupContext

public LDAPClient<U> setGroupContext(String inValue)

setGroupContext

public LDAPClient<U> setGroupContext(LdapName inValue)

setPrincipalContext

public LDAPClient<U> setPrincipalContext(String inValue)

setPrincipalContext

public LDAPClient<U> setPrincipalContext(LdapName inValue)

setPrincipalSuffix

public LDAPClient<U> setPrincipalSuffix(String inValue)

setPrincipalCredentials

public LDAPClient<U> setPrincipalCredentials(LoginCredentials inValue)

Specifies the credentials to be used to access the LDAP server.

Parameters:

inValue - the security principal credentials

Returns:

this LDAPClient object to facilitate method chaining

setPrincipalFieldName

public LDAPClient<U> setPrincipalFieldName(String inValue)

getUserFactory

public LDAP_UserObjFactory<U> getUserFactory()

setUserFactory

public LDAPClient<U> setUserFactory(LDAP_UserObjFactory<U> inValue)

authenticate

public boolean authenticate(LoginCredentials inCredentials)

getInfoForUser

public U getInfoForUser(String inQuery)

getInfoForUser

public U getInfoForUser(String inQuery,
                        List<LDAP_UserField> inFields)

getInfoForUser

public U getInfoForUser(LdapName inBaseDN,
                        String inQuery)

getInfoForUser

public U getInfoForUser(LdapName inBaseDN,
                        String inQuery,
                        List<LDAP_UserField> inFields)

getInfoForUsers

public List<U> getInfoForUsers(String inQuery)

getInfoForUsers

public List<U> getInfoForUsers(String inFilter,
                               List<LDAP_UserField> inFields)

getInfoForUsers

public List<U> getInfoForUsers(LdapName inBaseDN,
                               String inFilter,
                               List<LDAP_UserField> inFields)

getInfoForUsersWithPaging

public List<U> getInfoForUsersWithPaging(LdapContext inCtx,
                                         LdapName inBaseDN,
                                         String inFilter,
                                         List<LDAP_UserField> inFields)
                                  throws Exception

Throws:

Exception

getUsersForGroup

public List<U> getUsersForGroup(String inFilter)