org.keycloak.scripting

Interface ScriptingProvider

All Superinterfaces:

Provider

All Known Implementing Classes:

DefaultScriptingProvider

public interface ScriptingProvider
extends Provider

A Provider than provides Scripting capabilities.

Author:

Thomas Darimont

Method Summary

Modifier and Type	Method and Description
ScriptModel	createScript(String realmId, String mimeType, String scriptName, String scriptCode, String scriptDescription) Creates a new ScriptModel instance.
EvaluatableScriptAdapter	prepareEvaluatableScript(ScriptModel scriptModel) Returns an EvaluatableScriptAdapter based on the given ScriptModel.
InvocableScriptAdapter	prepareInvocableScript(ScriptModel scriptModel, ScriptBindingsConfigurer bindingsConfigurer) Returns an InvocableScriptAdapter based on the given ScriptModel.

Methods inherited from interface org.keycloak.provider.Provider

close

Method Detail

prepareInvocableScript

InvocableScriptAdapter prepareInvocableScript(ScriptModel scriptModel,
                                              ScriptBindingsConfigurer bindingsConfigurer)

Returns an InvocableScriptAdapter based on the given ScriptModel.

The InvocableScriptAdapter wraps a dedicated ScriptEngine that was populated with the provided ScriptBindingsConfigurer

Parameters:

scriptModel - the scriptModel to wrap

bindingsConfigurer - populates the Bindings

Returns:

prepareEvaluatableScript

EvaluatableScriptAdapter prepareEvaluatableScript(ScriptModel scriptModel)

Returns an EvaluatableScriptAdapter based on the given ScriptModel.

The EvaluatableScriptAdapter wraps a dedicated ScriptEngine that was populated with empty bindings.

Parameters:

scriptModel - the scriptModel to wrap

createScript

ScriptModel createScript(String realmId,
                         String mimeType,
                         String scriptName,
                         String scriptCode,
                         String scriptDescription)

Creates a new ScriptModel instance.

Parameters:

realmId -

scriptName -

scriptCode -

scriptDescription -

Returns: