Package org.sakaiproject.unboundid

Class RegexpBlacklistEidValidator

java.lang.Object

org.sakaiproject.unboundid.RegexpBlacklistEidValidator

All Implemented Interfaces:

EidValidator

public class RegexpBlacklistEidValidator
extends Object
implements EidValidator

Implements User EID "validation" by checking for matches in a configurable blacklist, entries in which are treated as regular expressions.

Author:

dmccallum

Constructor Summary

Constructors

Constructor	Description
RegexpBlacklistEidValidator()

Method Summary

Modifier and Type	Method	Description
Collection<String>	getEidBlacklist()	Access the String representation of blacklisted User EID regexps configured on this object.
int	getRegexpFlags()	Access the configured set of Pattern matching flags.
protected boolean	isBlackListedEid(String eid)	Encapsulates the logic for actually checking a user EID against the configured blacklist.
protected boolean	isMinimallyValidEid(String eid)	As implemented requires that the given ID be non-null and non-whitespace.
boolean	isSearchableEid(String eid)	Requires minimally valid and non-blacklisted EIDs.
void	setEidBlacklist(Collection<String> eidBlacklist)	Converts the given collection of Strings into a collection of s and caches the latter for evaluation by isSearchableEid(String).
void	setRegexpFlags(int regexpFlags)	Assign a bitmask for Pattern matching behaviors.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexpBlacklistEidValidator

public RegexpBlacklistEidValidator()

Method Detail

isSearchableEid

public boolean isSearchableEid(String eid)

Requires minimally valid and non-blacklisted EIDs. This is tested by calling isMinimallyValidEid(String) and isBlackListedEid(String). Theoretically, then, a subclass could override isMinimallyValidEid(String) to, for example, allow any non-null EID but allow any EID not described by the current blacklist.

Specified by:

isSearchableEid in interface EidValidator

isMinimallyValidEid

protected boolean isMinimallyValidEid(String eid)

As implemented requires that the given ID be non-null and non-whitespace.

Parameters:

eid - and EID to test

Returns:

true unless the given String is null or entirely whitespace

isBlackListedEid

protected boolean isBlackListedEid(String eid)

Encapsulates the logic for actually checking a user EID against the configured blacklist. If no blacklist is configured, will return false

Returns:

true if the eid matches a configured blacklist pattern. false otherwise (e.g. if no configured blacklist).

getEidBlacklist

public Collection<String> getEidBlacklist()

Access the String representation of blacklisted User EID regexps configured on this object. The returned collection may or may not be equivalent to the collection passed to setEidBlacklist(Collection)

Returns:

setEidBlacklist

public void setEidBlacklist(Collection<String> eidBlacklist)

Converts the given collection of Strings into a collection of s and caches the latter for evaluation by isSearchableEid(String). Configure {link Pattern} evaluation flags with setRegexpFlags(int).

Parameters:

eidBlacklist - a collection of Strings to be compiled into Patterns. May be null, which will have the same semantics as an empty collection.

getRegexpFlags

public int getRegexpFlags()

Access the configured set of Pattern matching flags. Defaults to zero.

Returns:

a bitmask of Pattern matching flags

See Also:

Pattern.compile(String, int)

setRegexpFlags

public void setRegexpFlags(int regexpFlags)

Assign a bitmask for Pattern matching behaviors. Be sure to set this property prior to invoking setEidBlacklist(Collection). The cached Patterns will not be recompiled as a side-effect of invoking this method.

Parameters:

regexpFlags -