org.apache.commons.jelly.avalon
Interface JellyService

All Known Implementing Classes:

JellyServiceImpl

public interface JellyService

An Avalon based service for executing Jelly scripts. The service allows executing a script based on a name as well as by a URL.

Version:

1.1

Author:

Robert McIntosh

Method Summary

java.util.Map	runNamedScript(java.lang.String name, java.util.Map params) Executes a named script with the supplied Map of parameters.
java.util.Map	runNamedScript(java.lang.String name, java.util.Map params, java.io.OutputStream out) Executes a named script with the supplied Map of parameters and send the output of the script to the supplied output stream.
java.util.Map	runNamedScript(java.lang.String name, java.util.Map params, org.apache.commons.jelly.XMLOutput output) Executes a named script with the supplied Map of parameters.
java.util.Map	runScript(java.lang.String url, java.util.Map params) Runs a script from the supplied url
java.util.Map	runScript(java.lang.String url, java.util.Map params, java.io.OutputStream out) Runs a script from the supplied url and sends the output of the script to the supplied OutputStream.
java.util.Map	runScript(java.lang.String url, java.util.Map params, org.apache.commons.jelly.XMLOutput output) Runs a script from the supplied url

Method Detail

runNamedScript

public java.util.Map runNamedScript(java.lang.String name,
                                    java.util.Map params)
                             throws java.lang.Exception

Executes a named script with the supplied Map of parameters.

Parameters:

params - Parameters to be supplied to the script

Returns:

All of the variables from the JellyContext

Throws:

java.lang.Exception - if the script raises some kind of exception while processing

runNamedScript

public java.util.Map runNamedScript(java.lang.String name,
                                    java.util.Map params,
                                    org.apache.commons.jelly.XMLOutput output)
                             throws java.lang.Exception

Executes a named script with the supplied Map of parameters.

Parameters:

name - is the name of the script to run

params - Parameters to be supplied to the script

output - is the XMLOutput for any output to be sent

Returns:

All of the variables from the JellyContext

Throws:

java.lang.Exception - if the script raises some kind of exception while processing

runNamedScript

public java.util.Map runNamedScript(java.lang.String name,
                                    java.util.Map params,
                                    java.io.OutputStream out)
                             throws java.lang.Exception

Executes a named script with the supplied Map of parameters and send the output of the script to the supplied output stream.

Parameters:

name - is the name of the script to run

params - Parameters to be supplied to the script

out - is the outputStream for output to be sent

Returns:

All of the variables from the JellyContext

Throws:

java.lang.Exception - if the script raises some kind of exception while processing

runScript

public java.util.Map runScript(java.lang.String url,
                               java.util.Map params,
                               org.apache.commons.jelly.XMLOutput output)
                        throws java.lang.Exception

Runs a script from the supplied url

Parameters:

url - The URL of the script

params - Parameters to be supplied to the script

output - is the XMLOutput where output of the script will go

Returns:

All of the variables from the JellyContext

Throws:

java.lang.Exception

runScript

public java.util.Map runScript(java.lang.String url,
                               java.util.Map params,
                               java.io.OutputStream out)
                        throws java.lang.Exception

Runs a script from the supplied url and sends the output of the script to the supplied OutputStream.

Parameters:

url - The URL of the script

params - Parameters to be supplied to the script

out - The OutputStream to send the output of the script to

Returns:

All of the variables from the JellyContext

Throws:

java.lang.Exception - if the script raises some kind of exception while processing

runScript

public java.util.Map runScript(java.lang.String url,
                               java.util.Map params)
                        throws java.lang.Exception

Runs a script from the supplied url

Parameters:

url - The URL of the script

params - Parameters to be supplied to the script

Returns:

All of the variables from the JellyContext

Throws:

java.lang.Exception - if the script raises some kind of exception while processing