Package freemarker.template.utility

Class Execute

java.lang.Object

freemarker.template.utility.Execute

All Implemented Interfaces:

TemplateMethodModel, TemplateModel

public class Execute
extends Object
implements TemplateMethodModel

Gives FreeMarker the the ability to execute external commands. Will fork a process, and inline anything that process sends to stdout in the template. Based on a patch submitted by Peter Molettiere.

BE CAREFUL! this tag, depending on use, may allow you to set something up so that users of your web application could run arbitrary code on your server. This can only happen if you allow unchecked GET/POST submissions to be used as the command string in the exec tag.

Usage:
From java:

 SimpleHash root = new SimpleHash();

 root.put( "exec", new freemarker.template.utility.Execute() );

 ...
 

From your FreeMarker template:

 The following is executed:
 ${exec( "/usr/bin/ls" )}

 ...
 

Field Summary

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor	Description
Execute()

Method Summary

Modifier and Type	Method	Description
Object	exec(List arguments)	Executes a method call.

Methods inherited from class java.lang.Object

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

Constructor Details

Execute

public Execute()

Method Details

exec

public Object exec(List arguments)
            throws TemplateModelException

Executes a method call.

Specified by:

exec in interface TemplateMethodModel

Parameters:

arguments - a List of String objects containing the values of the arguments passed to the method.

Returns:

the TemplateModel produced by the method, or null.

Throws:

TemplateModelException