org.apache.turbine.services.velocity
Interface VelocityService

All Superinterfaces:
Initable, Service
All Known Implementing Classes:
TurbineVelocityService

public interface VelocityService
extends Service

Implementations of the VelocityService interface.

Version:
$Id: VelocityService.java,v 1.3 2002/07/11 16:53:23 mpoeschl Exp $
Author:
John D. McNally, Dave Bryson, Jason van Zyl

Field Summary
static java.lang.String CONTEXT
           
static java.lang.String SERVICE_NAME
           
 
Method Summary
 org.apache.velocity.context.Context getContext()
          Create an empty WebContext object.
 org.apache.velocity.context.Context getContext(RunData data)
          Create a Context from the RunData object.
 java.lang.String handleRequest(org.apache.velocity.context.Context context, java.lang.String template)
          Process the request and fill in the template with the values you set in the Context.
 void handleRequest(org.apache.velocity.context.Context context, java.lang.String filename, java.io.OutputStream out)
          Process the request and fill in the template with the values you set in the Context.
 void handleRequest(org.apache.velocity.context.Context context, java.lang.String filename, java.io.Writer writer)
          Process the request and fill in the template with the values you set in the Context.
 void requestFinished(org.apache.velocity.context.Context context)
          Performs post-request actions (releases context tools back to the object pool).
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

CONTEXT

public static final java.lang.String CONTEXT
Method Detail

handleRequest

public java.lang.String handleRequest(org.apache.velocity.context.Context context,
                                      java.lang.String template)
                               throws java.lang.Exception
Process the request and fill in the template with the values you set in the Context.
Parameters:
context - A Context.
template - A String with the filename of the template.
Returns:
The process template as a String.
Throws:
Exception, - a generic exception.

handleRequest

public void handleRequest(org.apache.velocity.context.Context context,
                          java.lang.String filename,
                          java.io.OutputStream out)
                   throws TurbineException
Process the request and fill in the template with the values you set in the Context.
Parameters:
context - A Context.
filename - A String with the filename of the template.
out - A OutputStream where we will write the process template as a String.
Throws:
TurbineException - Any exception trown while processing will be wrapped into a TurbineException and rethrown.

handleRequest

public void handleRequest(org.apache.velocity.context.Context context,
                          java.lang.String filename,
                          java.io.Writer writer)
                   throws TurbineException
Process the request and fill in the template with the values you set in the Context.
Parameters:
context - A Context.
filename - A String with the filename of the template.
writer - A Writer where we will write the process template as a String.
Throws:
TurbineException - Any exception trown while processing will be wrapped into a TurbineException and rethrown.

getContext

public org.apache.velocity.context.Context getContext()
Create an empty WebContext object.
Returns:
An empty WebContext object.

getContext

public org.apache.velocity.context.Context getContext(RunData data)
Create a Context from the RunData object. Adds a pointer to the RunData object to the Context so that RunData is available in the templates.
Parameters:
data - The Turbine RunData object.
Returns:
A clone of the Context needed by Velocity.

requestFinished

public void requestFinished(org.apache.velocity.context.Context context)
Performs post-request actions (releases context tools back to the object pool).
Parameters:
context - a Velocity Context


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.