info.magnolia.module.groovy.console

Class MgnlGroovyConsole

java.lang.Object

groovy.lang.GroovyObjectSupport

groovy.lang.GroovyShell

info.magnolia.module.groovy.console.MgnlGroovyConsole

All Implemented Interfaces:

groovy.lang.GroovyObject

public class MgnlGroovyConsole
extends groovy.lang.GroovyShell

Groovy console using MgnlGroovyClassLoader to parse Groovy source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MgnlGroovyConsole.ScriptCallback Callback to handle script progress and result asynchronously.

Field Summary

Fields inherited from class groovy.lang.GroovyShell

DEFAULT_CODE_BASE

Constructor Summary

Constructors

Constructor and Description
MgnlGroovyConsole(groovy.lang.Binding binding) Deprecated. since 2.4.6, please use MgnlGroovyConsole#MgnlGroovyConsole(Binding, MessagesManager, SimpleTranslator))
MgnlGroovyConsole(groovy.lang.Binding binding, info.magnolia.ui.framework.message.MessagesManager messagesManager, info.magnolia.i18nsystem.SimpleTranslator simpleTranslator)

Method Summary

Modifier and Type	Method and Description
Object	evaluate(InputStream in, String fileName, Writer out) Deprecated. since 2.4.6, please use runAsync(String, UI, ScriptCallback)} instead.
String	generateScriptName()
groovy.lang.Script	parse(groovy.lang.GroovyCodeSource codeSource) Parses the given script and returns it ready to be run.
void	runAsync(String source, com.vaadin.ui.UI ui, MgnlGroovyConsole.ScriptCallback callback) Runs a Script asynchronously in a separate thread from the UI one.

Methods inherited from class groovy.lang.GroovyShell

evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, getClassLoader, getContext, getProperty, getVariable, main, parse, parse, parse, parse, parse, parse, resetLoadedClasses, run, run, run, run, run, run, run, run, run, run, setProperty, setVariable

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, invokeMethod, setMetaClass

Methods inherited from class java.lang.Object

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

Constructor Detail

MgnlGroovyConsole

public MgnlGroovyConsole(groovy.lang.Binding binding)

Deprecated. since 2.4.6, please use MgnlGroovyConsole#MgnlGroovyConsole(Binding, MessagesManager, SimpleTranslator))

MgnlGroovyConsole

public MgnlGroovyConsole(groovy.lang.Binding binding,
                         info.magnolia.ui.framework.message.MessagesManager messagesManager,
                         info.magnolia.i18nsystem.SimpleTranslator simpleTranslator)

Method Detail

evaluate

@Deprecated
public Object evaluate(InputStream in,
                                   String fileName,
                                   Writer out)
                            throws org.codehaus.groovy.control.CompilationFailedException

Deprecated. since 2.4.6, please use runAsync(String, UI, ScriptCallback)} instead.

Creates and run a Script synchronously. MgnlContext is wrapped into a MgnlGroovyConsoleContext for the script running time and then set back to its original value.

Throws:

org.codehaus.groovy.control.CompilationFailedException

runAsync

public void runAsync(String source,
                     com.vaadin.ui.UI ui,
                     MgnlGroovyConsole.ScriptCallback callback)
              throws IOException,
                     InterruptedException

Runs a Script asynchronously in a separate thread from the UI one. This prevents AdminCentral from being frozen until the script is done, in case of long running scripts.

MgnlContext is wrapped into a MgnlGroovyConsoleContext within the thread running the script.

Throws:

IOException

InterruptedException

parse

public groovy.lang.Script parse(groovy.lang.GroovyCodeSource codeSource)
                         throws org.codehaus.groovy.control.CompilationFailedException

Parses the given script and returns it ready to be run. When running in a secure environment (-Djava.security.manager) codeSource.getCodeSource() determines what policy grants should be given to the script.

Overrides:

parse in class groovy.lang.GroovyShell

Parameters:

codeSource -

Returns:

ready to run script

Throws:

org.codehaus.groovy.control.CompilationFailedException

generateScriptName

public String generateScriptName()

Overrides:

generateScriptName in class groovy.lang.GroovyShell