org.opensaml.saml.metadata.resolver.filter.impl

Class ScriptedTrustedNamesFunction

java.lang.Object

org.opensaml.saml.metadata.resolver.filter.impl.ScriptedTrustedNamesFunction

All Implemented Interfaces:

Function<org.opensaml.core.xml.XMLObject,Set<String>>

public class ScriptedTrustedNamesFunction
extends Object
implements Function<org.opensaml.core.xml.XMLObject,Set<String>>

A scripted Function which can be injected into SignatureValidationFilter.setDynamicTrustedNamesStrategy(Function).

Field Summary

Fields

Modifier and Type	Field and Description
private Object	customObject The custom object we can get inject into all scripts.
static String	DEFAULT_ENGINE The default language is JavaScript.
private org.slf4j.Logger	log Class logger.
private String	logPrefix Debugging info.
private EvaluableScript	script The script we care about.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScriptedTrustedNamesFunction(EvaluableScript theScript) Constructor.
protected	ScriptedTrustedNamesFunction(EvaluableScript theScript, String extraInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<String>	apply(org.opensaml.core.xml.XMLObject context)
Object	getCustomObject() Return the custom (externally provided) object.
(package private) static ScriptedTrustedNamesFunction	inlineScript(String scriptSource) Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from inline data.
(package private) static ScriptedTrustedNamesFunction	inlineScript(String engineName, String scriptSource) Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from inline data.
(package private) static ScriptedTrustedNamesFunction	resourceScript(Resource resource) Factory to create ScriptedTrustedNamesFunction from a Resource.
(package private) static ScriptedTrustedNamesFunction	resourceScript(String engineName, Resource resource) Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from a Resource.
void	setCustomObject(Object object) Set the custom (externally provided) object.

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.

customObject

@Nullable
private Object customObject

The custom object we can get inject into all scripts.

logPrefix

@Nullable
private final String logPrefix

Debugging info.

Constructor Detail

ScriptedTrustedNamesFunction

protected ScriptedTrustedNamesFunction(@Nonnull
                                       EvaluableScript theScript,
                                       @Nullable
                                       String extraInfo)

Constructor.

Parameters:

theScript - the script we will evaluate.

extraInfo - debugging information.

ScriptedTrustedNamesFunction

protected ScriptedTrustedNamesFunction(@Nonnull
                                       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(Object object)

Set the custom (externally provided) object.

Parameters:

object - the custom object

apply

public Set<String> apply(@Nullable
                         org.opensaml.core.xml.XMLObject context)

Specified by:

apply in interface Function<org.opensaml.core.xml.XMLObject,Set<String>>

resourceScript

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

Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from a Resource.

Parameters:

engineName - the language

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 ScriptedTrustedNamesFunction resourceScript(@Nonnull
                                                            Resource resource)
                                                     throws ScriptException,
                                                            IOException

Factory to create ScriptedTrustedNamesFunction 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.

inlineScript

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

Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters 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 ScriptedTrustedNamesFunction inlineScript(@Nonnull @NotEmpty
                                                          String scriptSource)
                                                   throws ScriptException

Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from inline data.

Parameters:

scriptSource - the script, as a string

Returns:

the function

Throws:

ScriptException - if the compile fails