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

Class ScriptedTrustedNamesFunction

java.lang.Object

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

All Implemented Interfaces:

com.google.common.base.Function<XMLObject,java.util.Set<java.lang.String>>

public class ScriptedTrustedNamesFunction
extends java.lang.Object
implements com.google.common.base.Function<XMLObject,java.util.Set<java.lang.String>>

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ENGINE The default language is JavaScript.
private org.slf4j.Logger	log Class logger.
private java.lang.String	logPrefix Debugging info.
private net.shibboleth.utilities.java.support.scripting.EvaluableScript	script The script we care about.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScriptedTrustedNamesFunction(net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript) Constructor.
protected	ScriptedTrustedNamesFunction(net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript, java.lang.String extraInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	apply(XMLObject context)
(package private) static ScriptedTrustedNamesFunction	inlineScript(java.lang.String scriptSource) Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from inline data.
(package private) static ScriptedTrustedNamesFunction	inlineScript(java.lang.String engineName, java.lang.String scriptSource) Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from inline data.
(package private) static ScriptedTrustedNamesFunction	resourceScript(net.shibboleth.utilities.java.support.resource.Resource resource) Factory to create ScriptedTrustedNamesFunction from a Resource.
(package private) static ScriptedTrustedNamesFunction	resourceScript(java.lang.String engineName, net.shibboleth.utilities.java.support.resource.Resource resource) Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from a Resource.

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 java.lang.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 net.shibboleth.utilities.java.support.scripting.EvaluableScript script

The script we care about.

logPrefix

@Nullable
private final java.lang.String logPrefix

Debugging info.

Constructor Detail

ScriptedTrustedNamesFunction

protected ScriptedTrustedNamesFunction(@Nonnull
                                       net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript,
                                       @Nullable
                                       java.lang.String extraInfo)

Constructor.

Parameters:

theScript - the script we will evaluate.

extraInfo - debugging information.

ScriptedTrustedNamesFunction

protected ScriptedTrustedNamesFunction(@Nonnull
                                       net.shibboleth.utilities.java.support.scripting.EvaluableScript theScript)

Constructor.

Parameters:

theScript - the script we will evaluate.

Method Detail

apply

public java.util.Set<java.lang.String> apply(@Nullable
                                             XMLObject context)

Specified by:

apply in interface com.google.common.base.Function<XMLObject,java.util.Set<java.lang.String>>

resourceScript

@Nonnull
static ScriptedTrustedNamesFunction resourceScript(@Nonnull @NotEmpty
                                                            java.lang.String engineName,
                                                            @Nonnull
                                                            net.shibboleth.utilities.java.support.resource.Resource resource)
                                                     throws javax.script.ScriptException,
                                                            java.io.IOException

Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from a Resource.

Parameters:

engineName - the language

resource - the resource to look at

Returns:

the function

Throws:

javax.script.ScriptException - if the compile fails

java.io.IOException - if the file doesn't exist.

resourceScript

@Nonnull
static ScriptedTrustedNamesFunction resourceScript(@Nonnull
                                                            net.shibboleth.utilities.java.support.resource.Resource resource)
                                                     throws javax.script.ScriptException,
                                                            java.io.IOException

Factory to create ScriptedTrustedNamesFunction from a Resource.

Parameters:

resource - the resource to look at

Returns:

the function

Throws:

javax.script.ScriptException - if the compile fails

java.io.IOException - if the file doesn't exist.

inlineScript

@Nonnull
static ScriptedTrustedNamesFunction inlineScript(@Nonnull @NotEmpty
                                                          java.lang.String engineName,
                                                          @Nonnull @NotEmpty
                                                          java.lang.String scriptSource)
                                                   throws javax.script.ScriptException

Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from inline data.

Parameters:

scriptSource - the script, as a string

engineName - the language

Returns:

the function

Throws:

javax.script.ScriptException - if the compile fails

inlineScript

@Nonnull
static ScriptedTrustedNamesFunction inlineScript(@Nonnull @NotEmpty
                                                          java.lang.String scriptSource)
                                                   throws javax.script.ScriptException

Factory to create ScriptedTrustedNamesFunction for SignatureValidationFilters from inline data.

Parameters:

scriptSource - the script, as a string

Returns:

the function

Throws:

javax.script.ScriptException - if the compile fails