net.shibboleth.idp.profile.context.navigate

Class ScriptedContextLookupFunction<T extends BaseContext>

java.lang.Object

net.shibboleth.utilities.java.support.scripting.AbstractScriptEvaluator

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

Type Parameters:

T - the specific type of context

All Implemented Interfaces:

com.google.common.base.Function<T,Object>, ContextDataLookupFunction<T,Object>

public class ScriptedContextLookupFunction<T extends BaseContext>
extends AbstractScriptEvaluator
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 Class<T>	inputClass What class we want the input to test against.

Fields inherited from class net.shibboleth.utilities.java.support.scripting.AbstractScriptEvaluator

DEFAULT_ENGINE

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()
(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.
protected void	prepareContext(ScriptContext scriptContext, Object... input)
(package private) static ScriptedContextLookupFunction	resourceMessageContextScript(org.springframework.core.io.Resource resource) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<MessageContext>	resourceMessageContextScript(org.springframework.core.io.Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<MessageContext>	resourceMessageContextScript(String engineName, org.springframework.core.io.Resource resource) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<MessageContext>	resourceMessageContextScript(String engineName, org.springframework.core.io.Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for MessageContexts from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(org.springframework.core.io.Resource resource) Factory to create ScriptedContextLookupFunction from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(org.springframework.core.io.Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(String engineName, org.springframework.core.io.Resource resource) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.
(package private) static ScriptedContextLookupFunction<ProfileRequestContext>	resourceScript(String engineName, org.springframework.core.io.Resource resource, Class outputType) Factory to create ScriptedContextLookupFunction for ProfileRequestContexts from a Resource.

Methods inherited from class net.shibboleth.utilities.java.support.scripting.AbstractScriptEvaluator

evaluate, finalizeContext, getHideExceptions, getLogPrefix, getOutputType, getReturnOnError, setCustomObject, setHideExceptions, setLogPrefix, setOutputType, setReturnOnError

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

inputClass

@Nonnull
private final Class<T extends BaseContext> inputClass

What class we want the input to test against.

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()

Overrides:

getCustomObject in class AbstractScriptEvaluator

apply

public Object apply(@Nullable
           T context)

Specified by:

apply in interface com.google.common.base.Function<T extends BaseContext,Object>

prepareContext

protected void prepareContext(@Nonnull
                  ScriptContext scriptContext,
                  @Nullable
                  Object... input)

Specified by:

prepareContext in class AbstractScriptEvaluator

resourceScript

@Nonnull
static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(@Nonnull@NotEmpty
                                                                          String engineName,
                                                                          @Nonnull
                                                                          org.springframework.core.io.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

@Nonnull
static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(@Nonnull@NotEmpty
                                                                          String engineName,
                                                                          @Nonnull
                                                                          org.springframework.core.io.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

@Nonnull
static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(org.springframework.core.io.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

@Nonnull
static ScriptedContextLookupFunction<ProfileRequestContext> resourceScript(org.springframework.core.io.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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(@Nonnull@NotEmpty
                                                                                 String engineName,
                                                                                 @Nonnull
                                                                                 org.springframework.core.io.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

@Nonnull
static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(@Nonnull@NotEmpty
                                                                                 String engineName,
                                                                                 @Nonnull
                                                                                 org.springframework.core.io.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

@Nonnull
static ScriptedContextLookupFunction resourceMessageContextScript(org.springframework.core.io.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

@Nonnull
static ScriptedContextLookupFunction<MessageContext> resourceMessageContextScript(org.springframework.core.io.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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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