org.apereo.services.persondir.support

Class ScriptEnginePersonAttributeDao

java.lang.Object

org.apereo.services.persondir.support.BasePersonAttributeDao

org.apereo.services.persondir.support.ScriptEnginePersonAttributeDao

All Implemented Interfaces:

Comparable<IPersonAttributeDao>, IPersonAttributeDao

public class ScriptEnginePersonAttributeDao
extends BasePersonAttributeDao

A DAO implementation that takes advantage of Java's scripting engine functionality to load an arbitrary script to resolve attributes. The script is loaded as an external file, a resource on the classpath or in native "raw/string" format and is passed the username plus a logger object at a minimum. It's expected that the outcome of the script be a map of user attributes, with attributes being multi-valued in form of collections.

The script must also return an attribute named username.

A sample script implementation in Groovy follows:

   import java.util.*
   def Map<String, List<Object>> run(final Object... args) {
       def uid = args[0]
       def logger = args[1]
       return[username:[uid], likes:["cheese", "food"], id:[1234,2,3,4,5], another:"attribute"]
   }
 

For the script engine to do its job, relevant libraries must be available on the classpath. Options include groovy, python and javascript libraries. The script type is determined by script file extension.

Author:

Misagh Moayyed

Field Summary

Fields inherited from class org.apereo.services.persondir.support.BasePersonAttributeDao

logger

Fields inherited from interface org.apereo.services.persondir.IPersonAttributeDao

WILDCARD, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor and Description
ScriptEnginePersonAttributeDao()

Method Summary

Modifier and Type	Method and Description
Set<String>	getAvailableQueryAttributes()
Set<IPersonAttributes>	getPeople(Map<String,Object> query)
Set<IPersonAttributes>	getPeopleWithMultivaluedAttributes(Map<String,List<Object>> query)
IPersonAttributes	getPerson(String uid)
Set<String>	getPossibleUserAttributeNames()
String	getScriptFile()
boolean	isCaseInsensitiveUsername()
void	setCaseInsensitiveUsername(boolean caseInsensitiveUsername)
void	setScriptFile(String scriptFile)

Methods inherited from class org.apereo.services.persondir.support.BasePersonAttributeDao

compareTo, flattenResults, getMultivaluedUserAttributes, getMultivaluedUserAttributes, getOrder, getUserAttributes, getUserAttributes, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptEnginePersonAttributeDao

public ScriptEnginePersonAttributeDao()

Method Detail

getScriptFile

public String getScriptFile()

setScriptFile

public void setScriptFile(String scriptFile)

isCaseInsensitiveUsername

public boolean isCaseInsensitiveUsername()

setCaseInsensitiveUsername

public void setCaseInsensitiveUsername(boolean caseInsensitiveUsername)

getPerson

public IPersonAttributes getPerson(String uid)

getPeople

public Set<IPersonAttributes> getPeople(Map<String,Object> query)

getPeopleWithMultivaluedAttributes

public Set<IPersonAttributes> getPeopleWithMultivaluedAttributes(Map<String,List<Object>> query)

getPossibleUserAttributeNames

public Set<String> getPossibleUserAttributeNames()

getAvailableQueryAttributes

public Set<String> getAvailableQueryAttributes()