net.shibboleth.idp.profile.context.navigate

Class ScriptedContextLookupFunction<T extends BaseContext>

java.lang.Object

net.shibboleth.idp.profile.context.navigate.ScriptedContextLookupFunction<T>

Type Parameters:

T - the specific type of context

All Implemented Interfaces:

Function<T,Object>, ContextDataLookupFunction<T,Object>

public class ScriptedContextLookupFunction<T extends BaseContext>
extends Object
implements ContextDataLookupFunction<T,Object>

A Function over a BaseContext which calls out to a supplied script.

Field Summary

Fields

Modifier and Type	Field and Description
private Object	customObject The custom object we can be injected into the script.
static String	DEFAULT_ENGINE The default language is Javascript.
private boolean	hideExceptions Whether to raise runtime exceptions if a script fails.
private Class<T>	inputClass What class we want the input to test against.
private org.slf4j.Logger	log Class logger.
private String	logPrefix Debugging info.
private Class	outputClass What class we want the output to test against.
private EvaluableScript	script The script we care about.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScriptedContextLookupFunction(Class<T> inClass, EvaluableScript theScript) Constructor.
protected	ScriptedContextLookupFunction(Class<T> inClass, EvaluableScript theScript, String extraInfo) Constructor.
protected	ScriptedContextLookupFunction(Class<T> inClass, EvaluableScript theScript, String extraInfo, Class outputType) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Object	apply(T context)
Object	getCustomObject() Return the custom (externally provided) object.
(package private) static ScriptedContextLookupFunction<MessageContext>	inlineMessageContextScript(String scriptSource) Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.
(package private) static ScriptedContextLookupFunction<MessageContext>	inlineMessageContextScript(String scriptSource, Class outputType) Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.
(package private) static ScriptedContextLookupFunction<MessageContext>	inlineMessageContextScript(String engineName, String scriptSource) Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.
(package private) static ScriptedContextLookupFunction<MessageContext>	inlineMessageContextScript(String engineName, String scriptSource, Class outputType) Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	inlineScript(String scriptSource) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	inlineScript(String scriptSource, Class outputType) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	inlineScript(String engineName, String scriptSource) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	inlineScript(String engineName, String scriptSource, Class outputType) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.
(package private) static ScriptedContextLookupFunction	resourceMessageContextScript(Resource resource) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<MessageContext>	resourceMessageContextScript(Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<MessageContext>	resourceMessageContextScript(String engineName, Resource resource) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<MessageContext>	resourceMessageContextScript(String engineName, Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(Resource resource) Factory to create ScriptedContextLookupFunction from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(String engineName, Resource resource) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(String engineName, Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.
void	setCustomObject(Object object) Set the custom (externally provided) object.
void	setHideExceptions(boolean flag) Set whether to hide exceptions in script execution (default is false).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Field Detail

DEFAULT_ENGINE

@Nonnull
@NotEmpty
public static final String DEFAULT_ENGINE

The default language is Javascript.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

script

@Nonnull
private final EvaluableScript script

The script we care about.

logPrefix

@Nullable
private final String logPrefix

Debugging info.

outputClass

@Nullable
private Class outputClass

What class we want the output to test against.

inputClass

@Nonnull
private final Class<T extends BaseContext> inputClass

What class we want the input to test against.

customObject

@Nullable
private Object customObject

The custom object we can be injected into the script.

hideExceptions

private boolean hideExceptions

Whether to raise runtime exceptions if a script fails.

Constructor Detail

ScriptedContextLookupFunction

protected ScriptedContextLookupFunction(@Nonnull
                             Class<T> inClass,
                             @Nonnull
                             EvaluableScript theScript,
                             @Nullable
                             String extraInfo)

Constructor.

Parameters:

inClass - the class we accept as input.

theScript - the script we will evaluate.

extraInfo - debugging information.

ScriptedContextLookupFunction

protected ScriptedContextLookupFunction(@Nonnull
                             Class<T> inClass,
                             @Nonnull
                             EvaluableScript theScript)

Constructor.

Parameters:

inClass - the class we accept as input.

theScript - the script we will evaluate.

ScriptedContextLookupFunction

protected ScriptedContextLookupFunction(@Nonnull
                             Class<T> inClass,
                             @Nonnull
                             EvaluableScript theScript,
                             @Nullable
                             String extraInfo,
                             @Nullable
                             Class outputType)

Constructor.

Parameters:

inClass - the class we accept as input.

theScript - the script we will evaluate.

extraInfo - debugging information.

outputType - the type to test against.

Method Detail

getCustomObject

@Nullable
public Object getCustomObject()

Return the custom (externally provided) object.

Returns:

the custom object

setCustomObject

@Nullable
public void setCustomObject(Object object)

Set the custom (externally provided) object.

Parameters:

object - the custom object

setHideExceptions

public void setHideExceptions(boolean flag)

Set whether to hide exceptions in script execution (default is false).

Parameters:

flag - flag to set

apply

public Object apply(@Nullable
           T context)

Specified by:

apply in interface Function<T extends BaseContext,Object>

resourceScript

static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(@Nonnull@NotEmpty
                                                                  String engineName,
                                                                  @Nonnull
                                                                  Resource resource)
                                                                    throws ScriptException,
                                                                           IOException

Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.

Parameters:

resource - the resource to look at

engineName - the language

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceScript

static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(@Nonnull@NotEmpty
                                                                  String engineName,
                                                                  @Nonnull
                                                                  Resource resource,
                                                                  @Nullable
                                                                  Class outputType)
                                                                    throws ScriptException,
                                                                           IOException

Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.

Parameters:

resource - the resource to look at

engineName - the language

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceScript

static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(Resource resource)
                                                                    throws ScriptException,
                                                                           IOException

Factory to create ScriptedContextLookupFunction from a Resource.

Parameters:

resource - the resource to look at

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceScript

static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(Resource resource,
                                                                  @Nullable
                                                                  Class outputType)
                                                                    throws ScriptException,
                                                                           IOException

Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.

Parameters:

resource - the resource to look at

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

inlineScript

static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(@Nonnull@NotEmpty
                                                                String engineName,
                                                                @Nonnull@NotEmpty
                                                                String scriptSource)
                                                                  throws ScriptException

Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineScript

static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(@Nonnull@NotEmpty
                                                                String engineName,
                                                                @Nonnull@NotEmpty
                                                                String scriptSource,
                                                                @Nullable
                                                                Class outputType)
                                                                  throws ScriptException

Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineScript

static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(@Nonnull@NotEmpty
                                                                String scriptSource)
                                                                  throws ScriptException

Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.

Parameters:

scriptSource - the script, as a string

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineScript

static ScriptedContextLookupFunction<ProfileRequestContext> inlineScript(@Nonnull@NotEmpty
                                                                String scriptSource,
                                                                @Nullable
                                                                Class outputType)
                                                                  throws ScriptException

Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from inline data.

Parameters:

scriptSource - the script, as a string

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails

resourceMessageContextScript

static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(@Nonnull@NotEmpty
                                                                         String engineName,
                                                                         @Nonnull
                                                                         Resource resource)
                                                                           throws ScriptException,
                                                                                  IOException

Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.

Parameters:

resource - the resource to look at

engineName - the language

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceMessageContextScript

static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(@Nonnull@NotEmpty
                                                                         String engineName,
                                                                         @Nonnull
                                                                         Resource resource,
                                                                         @Nullable
                                                                         Class outputType)
                                                                           throws ScriptException,
                                                                                  IOException

Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.

Parameters:

resource - the resource to look at

engineName - the language

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceMessageContextScript

static ScriptedContextLookupFunction resourceMessageContextScript(Resource resource)
                                                           throws ScriptException,
                                                                  IOException

Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.

Parameters:

resource - the resource to look at

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceMessageContextScript

static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(Resource resource,
                                                                         @Nullable
                                                                         Class outputType)
                                                                           throws ScriptException,
                                                                                  IOException

Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.

Parameters:

resource - the resource to look at

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

inlineMessageContextScript

static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(@Nonnull@NotEmpty
                                                                       String engineName,
                                                                       @Nonnull@NotEmpty
                                                                       String scriptSource)
                                                                         throws ScriptException

Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineMessageContextScript

static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(@Nonnull@NotEmpty
                                                                       String engineName,
                                                                       @Nonnull@NotEmpty
                                                                       String scriptSource,
                                                                       @Nullable
                                                                       Class outputType)
                                                                         throws ScriptException

Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineMessageContextScript

static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(@Nonnull@NotEmpty
                                                                       String scriptSource)
                                                                         throws ScriptException

Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.

Parameters:

scriptSource - the script, aMessageContexts a string

Returns:

the function

Throws:

ScriptException - if the compile fails

inlineMessageContextScript

static ScriptedContextLookupFunction<MessageContext> inlineMessageContextScript(@Nonnull@NotEmpty
                                                                       String scriptSource,
                                                                       @Nullable
                                                                       Class outputType)
                                                                         throws ScriptException

Factory to create ScriptedContextLookupFunction for MessageContexts from inline data.

Parameters:

scriptSource - the script, as a string

outputType - the type to test against.

Returns:

the function

Throws:

ScriptException - if the compile fails