Package gda.jython.authenticator

Class LdapMixin

java.lang.Object

gda.jython.authenticator.LdapMixin

public class LdapMixin
extends Object

Contains LDAP-related methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LDAP_ENV_CONNECT_TIMEOUT	The LDAP environment property used to define the timeout for connecting to a socket
static final String	LDAP_ENV_READ_TIMEOUT	The LDAP environment property used to define the timeout for reading from a socket
static final String	LDAPSTAFFCONTEXT_PROPERTY	The java property to use to define which class of Authenticator to use

Constructor Summary

Constructors

Constructor	Description
LdapMixin()

Method Summary

Modifier and Type	Method	Description
LdapContext	createContext(List<String> ldapURLs)	Creates and connects to a new LDAP context given a set of URLs
Hashtable<String,String>	generateLdapEnv(List<String> ldapURLs)	Generates environment variables for an LdapContext to use for authentication.
List<String>	getUrlsToTry()	Returns the LDAP URLs that should be used.
NamingEnumeration<SearchResult>	searchLdapForUser(String fedId, String... requiredAtts)
void	setResolver(HostnameResolver resolver)

Methods inherited from class java.lang.Object

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

Field Details

LDAP_ENV_CONNECT_TIMEOUT

public static final String LDAP_ENV_CONNECT_TIMEOUT

The LDAP environment property used to define the timeout for connecting to a socket

See Also:

• Constant Field Values

LDAP_ENV_READ_TIMEOUT

public static final String LDAP_ENV_READ_TIMEOUT

The LDAP environment property used to define the timeout for reading from a socket

See Also:

• Constant Field Values

LDAPSTAFFCONTEXT_PROPERTY

public static final String LDAPSTAFFCONTEXT_PROPERTY

The java property to use to define which class of Authenticator to use

See Also:

• Constant Field Values

Constructor Details

LdapMixin

public LdapMixin()

Method Details

setResolver

public void setResolver(HostnameResolver resolver)

searchLdapForUser

public NamingEnumeration<SearchResult> searchLdapForUser(String fedId,
 String... requiredAtts)

createContext

public LdapContext createContext(List<String> ldapURLs)
                          throws NamingException

Creates and connects to a new LDAP context given a set of URLs

Parameters:

ldapURLs - The set of URLs to try

Returns:

A new LdapContext

Throws:

NamingException

generateLdapEnv

public Hashtable<String,String> generateLdapEnv(List<String> ldapURLs)

Generates environment variables for an LdapContext to use for authentication. Must be a Hashtable due to requirements by a commonly used class implementing LdapContext, InitialLdapContext

Parameters:

ldapURLs - List of URLs to include in the environment

Returns:

A new Hashtable

getUrlsToTry

public List<String> getUrlsToTry()

Returns the LDAP URLs that should be used.