public interface PullService extends Service
Modifier and Type | Field and Description |
---|---|
static String |
AUTHORIZED_TOOL
Property Key for the authorized tools
|
static String |
GLOBAL_TOOL
Property Key for the global tools
|
static String |
PERSISTENT_TOOL
Property Key for the persistent tools
|
static String |
REQUEST_TOOL
Property Key for the request tools
|
static String |
SERVICE_NAME
The key under which this service is stored in TurbineServices.
|
static String |
SESSION_TOOL
Property Key for the session tools
|
static String |
SESSION_TOOLS_ATTRIBUTE_PREFIX
prefix for key used in the session to store session scope pull tools
|
static String |
TOOL_RESOURCES_DIR_DEFAULT
Default value for the application tool resources.
|
static String |
TOOL_RESOURCES_DIR_KEY
Property tag for application tool resources directory
|
static boolean |
TOOLS_PER_REQUEST_REFRESH_DEFAULT
Default value for per request tool refreshing
|
static String |
TOOLS_PER_REQUEST_REFRESH_KEY
Property tag for per request tool refreshing (for obvious reasons
has no effect for per-request tools)
|
Modifier and Type | Method and Description |
---|---|
String |
getAbsolutePathToResourcesDirectory()
Return the absolute path of the resources directory
used by application tools.
|
org.apache.velocity.context.Context |
getGlobalContext()
Get the context containing global tools that will be
use as part of the Turbine Pull Model.
|
String |
getResourcesDirectory()
Return the resources directory.
|
void |
populateContext(org.apache.velocity.context.Context context,
PipelineData pipelineData)
Populate the given context with all request, session, authorized
and persistent scope tools (it is assumed that the context
already wraps the global context, and thus already contains
the global tools).
|
void |
populateContext(org.apache.velocity.context.Context context,
RunData data)
Populate the given context with all request, session, authorized
and persistent scope tools (it is assumed that the context
already wraps the global context, and thus already contains
the global tools).
|
void |
releaseTools(org.apache.velocity.context.Context context)
Release tool instances from the given context to the
object pool
|
getConfiguration, getName, getProperties, setName, setServiceBroker
static final String SERVICE_NAME
static final String GLOBAL_TOOL
static final String REQUEST_TOOL
static final String SESSION_TOOL
static final String AUTHORIZED_TOOL
static final String PERSISTENT_TOOL
static final String TOOL_RESOURCES_DIR_KEY
static final String TOOL_RESOURCES_DIR_DEFAULT
static final String TOOLS_PER_REQUEST_REFRESH_KEY
static final boolean TOOLS_PER_REQUEST_REFRESH_DEFAULT
static final String SESSION_TOOLS_ATTRIBUTE_PREFIX
org.apache.velocity.context.Context getGlobalContext()
void populateContext(org.apache.velocity.context.Context context, PipelineData pipelineData)
context
- a Velocity Context to populatepipelineData
- a RunData object for request specific datavoid populateContext(org.apache.velocity.context.Context context, RunData data)
context
- a Velocity Context to populatedata
- a RunData object for request specific dataString getAbsolutePathToResourcesDirectory()
String getResourcesDirectory()
void releaseTools(org.apache.velocity.context.Context context)
context
- a Velocity Context to release tools fromCopyright © 2000–2019 The Apache Software Foundation. All rights reserved.