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:

java.lang.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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptEnginePersonAttributeDao.SCRIPT_TYPE

Field Summary

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

WILDCARD, WILDCARD_PATTERN

Constructor Summary

Constructors

Constructor and Description
ScriptEnginePersonAttributeDao() This should probably be deprecated in favor of constructors that guarantee required properties are set
ScriptEnginePersonAttributeDao(java.lang.String scriptFile) Create DAO with reference to file or the contents of a script.
ScriptEnginePersonAttributeDao(java.lang.String scriptFile, java.lang.String engineName) Create DAO with reference to file or the contents of a script.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAvailableQueryAttributes()
java.lang.String	getEngineName()
java.util.Set<IPersonAttributes>	getPeople(java.util.Map<java.lang.String,java.lang.Object> query)
java.util.Set<IPersonAttributes>	getPeopleWithMultivaluedAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> query)
IPersonAttributes	getPerson(java.lang.String uid)
java.util.Set<java.lang.String>	getPossibleUserAttributeNames()
static java.lang.String	getScriptEngineName(java.lang.String filename) This method is static is available as utility for users that are passing the contents of a script and want to set the engineName property based on a filename.
java.lang.String	getScriptFile()
protected ScriptEnginePersonAttributeDao.SCRIPT_TYPE	getScriptType()
boolean	isCaseInsensitiveUsername()
void	setCaseInsensitiveUsername(boolean caseInsensitiveUsername)
void	setEngineName(java.lang.String engineName)
void	setScriptFile(java.lang.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()

This should probably be deprecated in favor of constructors that guarantee required properties are set

ScriptEnginePersonAttributeDao

public ScriptEnginePersonAttributeDao(java.lang.String scriptFile)

Create DAO with reference to file or the contents of a script.

Parameters:

scriptFile - This can be a path to a file, classpath resource, or the script contents as string. If its the string version then engine name must be set using setter.

ScriptEnginePersonAttributeDao

public ScriptEnginePersonAttributeDao(java.lang.String scriptFile,
                                      java.lang.String engineName)

Create DAO with reference to file or the contents of a script.

Parameters:

scriptFile - This can be a path to a file, classpath resource, or the script contents as string. If its the string version then engine name must be set using setter.

engineName - Script engine name such as js, groovy, python

Method Detail

getScriptFile

public java.lang.String getScriptFile()

setScriptFile

public void setScriptFile(java.lang.String scriptFile)

getEngineName

public java.lang.String getEngineName()

getScriptType

protected ScriptEnginePersonAttributeDao.SCRIPT_TYPE getScriptType()

setEngineName

public void setEngineName(java.lang.String engineName)

isCaseInsensitiveUsername

public boolean isCaseInsensitiveUsername()

setCaseInsensitiveUsername

public void setCaseInsensitiveUsername(boolean caseInsensitiveUsername)

getPerson

public IPersonAttributes getPerson(java.lang.String uid)

getPeople

public java.util.Set<IPersonAttributes> getPeople(java.util.Map<java.lang.String,java.lang.Object> query)

getPeopleWithMultivaluedAttributes

public java.util.Set<IPersonAttributes> getPeopleWithMultivaluedAttributes(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> query)

getPossibleUserAttributeNames

public java.util.Set<java.lang.String> getPossibleUserAttributeNames()

getAvailableQueryAttributes

public java.util.Set<java.lang.String> getAvailableQueryAttributes()

getScriptEngineName

public static java.lang.String getScriptEngineName(java.lang.String filename)

This method is static is available as utility for users that are passing the contents of a script and want to set the engineName property based on a filename.

Parameters:

filename -

Returns: