org.tigris.scarab.services.email
Interface EmailService

All Superinterfaces:

org.apache.fulcrum.Service

All Known Implementing Classes:

VelocityEmailService

public interface EmailService

extends org.apache.fulcrum.Service

The Turbine service interface to Velocity.

Version:

$Id: EmailService.java 7872 2003-05-06 08:17:49Z jon $

Author:

John D. McNally, Dave Bryson, Jason van Zyl, Daniel Rall

Field Summary

static java.lang.String

SERVICE_NAME

Method Summary

java.lang.String	handleRequest(org.apache.velocity.context.Context context, java.lang.String filename) Process the request and fill in the template using the values set in 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 using the values set in context.
void	handleRequest(org.apache.velocity.context.Context context, java.lang.String filename, java.io.OutputStream out, java.lang.String charset, java.lang.String encoding) Process the request and fill in the template using the values set in context.
java.lang.String	handleRequest(org.apache.velocity.context.Context context, java.lang.String template, java.lang.String charset, java.lang.String encoding) Process the request and fill in the template using the values set in 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 using the values set in context.
void	handleRequest(org.apache.velocity.context.Context context, java.lang.String filename, java.io.Writer writer, java.lang.String encoding) Process the request and fill in the template using the values set in context.

Methods inherited from interface org.apache.fulcrum.Service

getCategory, getConfiguration, getRealPath, getStatus, init, isInitialized, setName, setServiceBroker, shutdown

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

handleRequest

public java.lang.String handleRequest(org.apache.velocity.context.Context context,
                                      java.lang.String filename)
                               throws java.lang.Exception

Process the request and fill in the template using the values set in context.

Parameters:

context - A context to use when evaluating the specified template.

filename - The file name of the template.

Returns:

The processed template.

Throws:

Exception, - a generic exception.

java.lang.Exception

handleRequest

public java.lang.String handleRequest(org.apache.velocity.context.Context context,
                                      java.lang.String template,
                                      java.lang.String charset,
                                      java.lang.String encoding)
                               throws java.lang.Exception

Process the request and fill in the template using the values set in context.

Parameters:

context - A context to use when evaluating the specified template.

charset - The character set to use when writing the result.

encoding - The encoding to use when merging context and template.

Returns:

The processed template.

Throws:

Exception, - a generic exception.

java.lang.Exception

handleRequest

public void handleRequest(org.apache.velocity.context.Context context,
                          java.lang.String filename,
                          java.io.OutputStream out)
                   throws org.apache.fulcrum.ServiceException

Process the request and fill in the template using the values set in context.

Parameters:

context - A context to use when evaluating the specified template.

filename - The file name of the template.

out - The stream to which we will write the processed template as a String.

Throws:

org.apache.fulcrum.ServiceException - Any exception trown while processing will be wrapped into a ServiceException and rethrown.

handleRequest

public void handleRequest(org.apache.velocity.context.Context context,
                          java.lang.String filename,
                          java.io.OutputStream out,
                          java.lang.String charset,
                          java.lang.String encoding)
                   throws org.apache.fulcrum.ServiceException

Process the request and fill in the template using the values set in context.

Parameters:

context - A context to use when evaluating the specified template.

filename - The file name of the template.

out - The stream to which we will write the processed template as a String.

charset - The character set to use when writing the result.

encoding - The encoding to use when merging context and template.

Throws:

org.apache.fulcrum.ServiceException - Any exception trown while processing will be wrapped into a ServiceException and rethrown.

handleRequest

public void handleRequest(org.apache.velocity.context.Context context,
                          java.lang.String filename,
                          java.io.Writer writer)
                   throws org.apache.fulcrum.ServiceException

Process the request and fill in the template using the values set in context.

Parameters:

context - A context to use when evaluating the specified template.

filename - The file name of the template.

writer - The writer to which we will write the processed template.

Throws:

org.apache.fulcrum.ServiceException - Any exception trown while processing will be wrapped into a ServiceException and rethrown.

handleRequest

public void handleRequest(org.apache.velocity.context.Context context,
                          java.lang.String filename,
                          java.io.Writer writer,
                          java.lang.String encoding)
                   throws org.apache.fulcrum.ServiceException

Process the request and fill in the template using the values set in context.

Parameters:

context - A context to use when evaluating the specified template.

filename - The file name of the template.

writer - The writer to which we will write the processed template.

encoding - The encoding to use when merging context and template.

Throws:

org.apache.fulcrum.ServiceException - Any exception trown while processing will be wrapped into a ServiceException and rethrown.