Package net.shibboleth.idp.profile

Class ScriptedAction

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.profile.ScriptedAction

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class ScriptedAction
extends AbstractProfileAction

An action which calls out to a supplied script.

The return value must be an event ID to signal. As this is a generic wrapper, the action may return any event depending on the context of the activity, and may manipulate the profile context tree as required.

Event:

EventIds.INVALID_PROFILE_CTX

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ScriptedAction.ActionScriptEvaluator	Evaluator bound to the Action semantic.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ENGINE	The default language is Javascript.
private org.slf4j.Logger	log	Class logger.
private ScriptedAction.ActionScriptEvaluator	scriptEvaluator	Evaluator.

Constructor Summary

Constructors

Constructor	Description
ScriptedAction(net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript)	Constructor.
ScriptedAction(net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript, String extraInfo)	Deprecated. ...

Method Summary

Modifier and Type	Method	Description
void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileContext)
protected void	doInitialize()
Object	getCustomObject()	Return the custom (externally provided) object.
(package private) static ScriptedAction	inlineScript(String scriptSource)	Factory to create ScriptedAction from inline data.
(package private) static ScriptedAction	inlineScript(String engineName, String scriptSource)	Factory to create ScriptedAction from inline data.
(package private) static ScriptedAction	resourceScript(String engineName, Resource resource)	Factory to create ScriptedAction from a Resource.
(package private) static ScriptedAction	resourceScript(Resource resource)	Factory to create ScriptedAction 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 net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

doPreExecute, getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

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.

scriptEvaluator

@Nonnull
private final ScriptedAction.ActionScriptEvaluator scriptEvaluator

Evaluator.

Constructor Detail

ScriptedAction

@Deprecated
public ScriptedAction(@Nonnull
                      net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript,
                      @Nullable
                      String extraInfo)

Deprecated.

...

Constructor.

Parameters:

theScript - the script we will evaluate

extraInfo - debugging information

ScriptedAction

public ScriptedAction(@Nonnull
                      net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript)

Constructor.

Parameters:

theScript - the script we will evaluate

Method Detail

getCustomObject

@Nullable
public Object getCustomObject()

Return the custom (externally provided) object.

Returns:

the custom object

setCustomObject

@Nullable
public void setCustomObject(@Nullable
                            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

Since:

3.4.0

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doExecute

public void doExecute(@Nullable
                      org.opensaml.profile.context.ProfileRequestContext profileContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction

resourceScript

static ScriptedAction resourceScript(@Nonnull @NotEmpty
                                     String engineName,
                                     @Nonnull
                                     Resource resource)
                              throws ScriptException,
                                     IOException

Factory to create ScriptedAction from a Resource.

Parameters:

resource - the resource to look at

engineName - the language

Returns:

the predicate

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

resourceScript

static ScriptedAction resourceScript(@Nonnull
                                     Resource resource)
                              throws ScriptException,
                                     IOException

Factory to create ScriptedAction from a Resource.

Parameters:

resource - the resource to look at

Returns:

the predicate

Throws:

ScriptException - if the compile fails

IOException - if the file doesn't exist.

inlineScript

static ScriptedAction inlineScript(@Nonnull @NotEmpty
                                   String engineName,
                                   @Nonnull @NotEmpty
                                   String scriptSource)
                            throws ScriptException

Factory to create ScriptedAction from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

Returns:

the predicate

Throws:

ScriptException - if the compile fails

inlineScript

static ScriptedAction inlineScript(@Nonnull @NotEmpty
                                   String scriptSource)
                            throws ScriptException

Factory to create ScriptedAction from inline data.

Parameters:

scriptSource - the script, as a string

Returns:

the predicate

Throws:

ScriptException - if the compile fails