|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.util.velocity.DefaultVelocityRequestContextFactory
public class DefaultVelocityRequestContextFactory
Return an instance of VelocityRequestContext
, depending on whether we are called from a web or non-web context.
VelocityRequestContext
.
Constructor Summary | |
---|---|
DefaultVelocityRequestContextFactory()
Deprecated. Please use DefaultVelocityRequestContextFactory(com.atlassian.jira.config.properties.ApplicationProperties) instead |
|
DefaultVelocityRequestContextFactory(ApplicationProperties applicationProperties)
|
Method Summary | ||
---|---|---|
static void |
cacheVelocityRequestContext(javax.servlet.http.HttpServletRequest request)
Deprecated. Use VelocityRequestContextFactory.setVelocityRequestContext(javax.servlet.http.HttpServletRequest) instead. Since v5.0. |
|
static void |
cacheVelocityRequestContext(String baseUrl,
javax.servlet.http.HttpServletRequest request)
Deprecated. Use VelocityRequestContextFactory.setVelocityRequestContext(String, javax.servlet.http.HttpServletRequest) instead. Since v5.0. |
|
void |
cacheVelocityRequestContext(VelocityRequestContext velocityRequestContext)
Deprecated. Use VelocityRequestContextFactory.setVelocityRequestContext(VelocityRequestContext) instead. Since v5.0. |
|
void |
clearVelocityRequestContext()
Resets the thread local storage as if no request has occurred, effectively nulling out the current thread local velocity request context. |
|
Map<String,Object> |
getDefaultVelocityParams(Map<String,Object> startingParams,
JiraAuthenticationContext authenticationContext)
Constructs a map with a number of common parameters used by velocity templates. |
|
VelocityRequestContext |
getJiraVelocityRequestContext()
Get the request context. |
|
|
runWithStaticBaseUrl(I input,
com.google.common.base.Function<I,O> runnable)
Run the passed function in an environment where JIRA's configured baseURL is always used. |
|
void |
setVelocityRequestContext(javax.servlet.http.HttpServletRequest request)
Update the thread-local storage with the given request information. |
|
void |
setVelocityRequestContext(String baseUrl,
javax.servlet.http.HttpServletRequest request)
Update the thread-local storage with the given request information. |
|
void |
setVelocityRequestContext(VelocityRequestContext velocityRequestContext)
Update the thread-local storage with the given velocityRequestContext. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultVelocityRequestContextFactory(ApplicationProperties applicationProperties)
public DefaultVelocityRequestContextFactory()
DefaultVelocityRequestContextFactory(com.atlassian.jira.config.properties.ApplicationProperties)
instead
Method Detail |
---|
public VelocityRequestContext getJiraVelocityRequestContext()
VelocityRequestContextFactory
getJiraVelocityRequestContext
in interface VelocityRequestContextFactory
public Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams, JiraAuthenticationContext authenticationContext)
VelocityRequestContextFactory
getDefaultVelocityParams
in interface VelocityRequestContextFactory
startingParams
- Map of parameters that may be used to override any of the parameters set here.authenticationContext
- JiraAuthenticationContext
public static void cacheVelocityRequestContext(javax.servlet.http.HttpServletRequest request)
VelocityRequestContextFactory.setVelocityRequestContext(javax.servlet.http.HttpServletRequest)
instead. Since v5.0.
HttpServletRequest.getContextPath()
along as the baseUrl.
request
- The HttpServletRequest used to construct the RequestContextParameterHolder
public void setVelocityRequestContext(javax.servlet.http.HttpServletRequest request)
VelocityRequestContextFactory
setVelocityRequestContext
in interface VelocityRequestContextFactory
request
- The http request context to store.public static void cacheVelocityRequestContext(String baseUrl, javax.servlet.http.HttpServletRequest request)
VelocityRequestContextFactory.setVelocityRequestContext(String, javax.servlet.http.HttpServletRequest)
instead. Since v5.0.
baseUrl
- Should pass in HttpServletRequest.getContextPath()
request
- The HttpServletRequest used to construct the RequestContextParameterHolder
public void setVelocityRequestContext(String baseUrl, javax.servlet.http.HttpServletRequest request)
VelocityRequestContextFactory
setVelocityRequestContext
in interface VelocityRequestContextFactory
baseUrl
- of the request.request
- The http request context to store.public void cacheVelocityRequestContext(VelocityRequestContext velocityRequestContext)
VelocityRequestContextFactory.setVelocityRequestContext(VelocityRequestContext)
instead. Since v5.0.
VelocityRequestContextFactory
cacheVelocityRequestContext
in interface VelocityRequestContextFactory
velocityRequestContext
- The velocity request context to store.public void setVelocityRequestContext(VelocityRequestContext velocityRequestContext)
VelocityRequestContextFactory
setVelocityRequestContext
in interface VelocityRequestContextFactory
velocityRequestContext
- The velocity request context to store.public <I,O> O runWithStaticBaseUrl(I input, @Nonnull com.google.common.base.Function<I,O> runnable)
VelocityRequestContextFactory
baseURL
is always used. This basically
makes the passed function ignore any smart baseURL
that can be generated from the request associated
with the calling thread.
runWithStaticBaseUrl
in interface VelocityRequestContextFactory
input
- input to pass to the function.runnable
- the function to execute.
public void clearVelocityRequestContext()
VelocityRequestContextFactory
clearVelocityRequestContext
in interface VelocityRequestContextFactory
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |