public interface VelocityService extends Service
Modifier and Type | Field and Description |
---|---|
static boolean |
CATCH_ERRORS_DEFAULT
Default: Yes
|
static String |
CATCH_ERRORS_KEY
Shall we catch Velocity Errors and report them?
|
static String |
CONTEXT
Key for storing the Context in the RunData object
|
static String |
PIPELINEDATA_KEY
The Key for storing the PipelineData Object in the Context
|
static String |
RUNDATA_KEY
The Key for storing the RunData Object in the Context
|
static String |
SERVICE_NAME
The Service Name
|
static String |
VELOCITY_EXTENSION
The default extension of Velocity Pages
|
Modifier and Type | Method and Description |
---|---|
org.apache.velocity.context.Context |
getContext()
Create an empty WebContext object.
|
org.apache.velocity.context.Context |
getContext(PipelineData pipelineData)
Create a Context from the PipelineData object.
|
org.apache.velocity.context.Context |
getNewContext()
This method returns a new, empty Context object.
|
String |
handleRequest(org.apache.velocity.context.Context context,
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,
String filename,
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,
String filename,
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).
|
getConfiguration, getName, getProperties, setName, setServiceBroker
static final String SERVICE_NAME
static final String CONTEXT
static final String VELOCITY_EXTENSION
static final String RUNDATA_KEY
static final String PIPELINEDATA_KEY
static final String CATCH_ERRORS_KEY
static final boolean CATCH_ERRORS_DEFAULT
String handleRequest(org.apache.velocity.context.Context context, String template) throws Exception
context
- A Context.template
- A String with the filename of the template.Exception
- a generic exception.void handleRequest(org.apache.velocity.context.Context context, String filename, OutputStream out) throws TurbineException
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.TurbineException
- Any exception thrown while processing will be
wrapped into a TurbineException and rethrown.void handleRequest(org.apache.velocity.context.Context context, String filename, Writer writer) throws TurbineException
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.TurbineException
- Any exception thrown while processing will be
wrapped into a TurbineException and rethrown.org.apache.velocity.context.Context getContext()
org.apache.velocity.context.Context getNewContext()
org.apache.velocity.context.Context getContext(PipelineData pipelineData)
pipelineData
- The Turbine PipelineData object.void requestFinished(org.apache.velocity.context.Context context)
context
- a Velocity ContextCopyright © 2000–2019 The Apache Software Foundation. All rights reserved.