edu.amc.sakai.user

Class SearchExecutingLdapConnectionLivenessValidator

java.lang.Object

edu.amc.sakai.user.SearchExecutingLdapConnectionLivenessValidator

All Implemented Interfaces:

LdapConnectionLivenessValidator

public class SearchExecutingLdapConnectionLivenessValidator
extends Object
implements LdapConnectionLivenessValidator

Tests LDAPConnection liveness by executing a search filter and verifying that the result contains at least one entry. This strategy is appropriate when LDAPConnection.isConnectionAlive() is not reliable, e.g. when running against a non-OpenLDAP service provider.

This particular implementation makes an effort to generate filters which will be easily traceable in LDAP logs. Generally, filters take the form (|(objectclass=*)({attr}={unique-string})). The search itself is limited by LDAPConnection.SCOPE_BASE, where "BASE" is specified by baseDn. Often, baseDn corresponds to the DN of the "system user" as whom JLDAPDirectoryProvider binds when running in "autoBind" mode.

Author:

dmccallum@unicon.net

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST_NAME
static com.novell.ldap.LDAPSearchConstraints	DEFAULT_LDAP_CONSTRAINTS
static String	DEFAULT_SEARCH_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
SearchExecutingLdapConnectionLivenessValidator()

Method Summary

Modifier and Type	Method and Description
protected String	formatSearchFilter() Generates an executable search filter string by injecting the result of generateUniqueSearchFilterTerm() into the current searchFilter.
protected Object	generateUniqueSearchFilterTerm() Generates a portion of the search filter which will (likely) uniquely identify an execution of that filter.
protected String	generateUniqueToken() Just returns the current system time in millis.
String	getBaseDn()
String	getHostName()
protected String	getLocalhostName() Returns localhost's name as reported by InetAddress#getLocalHost()#toString().
String	getSearchAttributeName()
com.novell.ldap.LDAPSearchConstraints	getSearchConstraints()
String	getSearchFilter()
String	getSearchStamp()
ServerConfigurationService	getServerConfigService()
void	init() Invoke prior to testing any connections.
boolean	isConnectionAlive(com.novell.ldap.LDAPConnection connectionToTest)
protected String	newUnformattedSearchFilter()
void	setBaseDn(String baseDn)
void	setHostName(String hostName) Assign the host name to be appended to (semi) invocation-unique search terms.
void	setSearchAttributeName(String searchAttributeName)
void	setSearchConstraints(com.novell.ldap.LDAPSearchConstraints searchConstraints)
void	setSearchFilter(String searchFilter)
void	setSearchStamp(String searchStamp)
void	setServerConfigService(ServerConfigurationService serverConfigService)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SEARCH_ATTRIBUTE_NAME

public static final String DEFAULT_SEARCH_ATTRIBUTE_NAME

See Also:

Constant Field Values

DEFAULT_LDAP_CONSTRAINTS

public static final com.novell.ldap.LDAPSearchConstraints DEFAULT_LDAP_CONSTRAINTS

DEFAULT_HOST_NAME

public static final String DEFAULT_HOST_NAME

See Also:

Constant Field Values

Constructor Detail

SearchExecutingLdapConnectionLivenessValidator

public SearchExecutingLdapConnectionLivenessValidator()

Method Detail

init

public void init()

Invoke prior to testing any connections. Caches a host name to include in search terms.

getLocalhostName

protected String getLocalhostName()
                           throws UnknownHostException

Returns localhost's name as reported by InetAddress#getLocalHost()#toString(). Factored into a method to enable override during testing.

Returns:

Throws:

UnknownHostException

isConnectionAlive

public boolean isConnectionAlive(com.novell.ldap.LDAPConnection connectionToTest)

Specified by:

isConnectionAlive in interface LdapConnectionLivenessValidator

newUnformattedSearchFilter

protected String newUnformattedSearchFilter()

formatSearchFilter

protected String formatSearchFilter()

Generates an executable search filter string by injecting the result of generateUniqueSearchFilterTerm() into the current searchFilter. This term is usually treated as a portion of the value to match against searchAttributeName

Returns:

an LDAP search filter

generateUniqueSearchFilterTerm

protected Object generateUniqueSearchFilterTerm()

Generates a portion of the search filter which will (likely) uniquely identify an execution of that filter. By default concatenates a semi-unique token (generateUniqueToken() and the local host name, separated by a dash ("-").

Returns:

See Also:

setHostName(String), getHostName(), generateUniqueToken(), setServerConfigService(ServerConfigurationService)

generateUniqueToken

protected String generateUniqueToken()

Just returns the current system time in millis. This is factored into a method so it can be overriden in testing (otherwise unique tokens are quite difficult to verify).

Returns:

See Also:

System.currentTimeMillis()

getSearchStamp

public String getSearchStamp()

setSearchStamp

public void setSearchStamp(String searchStamp)

getSearchAttributeName

public String getSearchAttributeName()

setSearchAttributeName

public void setSearchAttributeName(String searchAttributeName)

getBaseDn

public String getBaseDn()

setBaseDn

public void setBaseDn(String baseDn)

getSearchConstraints

public com.novell.ldap.LDAPSearchConstraints getSearchConstraints()

setSearchConstraints

public void setSearchConstraints(com.novell.ldap.LDAPSearchConstraints searchConstraints)

getSearchFilter

public String getSearchFilter()

setSearchFilter

public void setSearchFilter(String searchFilter)

getServerConfigService

public ServerConfigurationService getServerConfigService()

setServerConfigService

public void setServerConfigService(ServerConfigurationService serverConfigService)

getHostName

public String getHostName()

setHostName

public void setHostName(String hostName)

Assign the host name to be appended to (semi) invocation-unique search terms. Falls back to DEFAULT_HOST_NAME if argument is null. If this setter is not ivoked, init() will control the default value.

Parameters:

hostName -

See Also:

init()