com.atlassian.confluence.velocity.context
Class ConfluenceContextUtils

java.lang.Object
  com.atlassian.confluence.velocity.context.ConfluenceContextUtils

public final class ConfluenceContextUtils
extends java.lang.Object

Tools for enhancing the capabilities of Velocity context according to system policy

Method Summary

static void	modifyRequestContext(org.apache.velocity.context.Context context, javax.servlet.http.HttpServletRequest request) Adds request based information to the given context.
static void	processContextForHtmlRendering(org.apache.velocity.context.Context context) Process an event context that is to be used for rendering HTML.
static void	processContextForTemplate(org.apache.velocity.Template template, org.apache.velocity.context.Context context) Process the context appropriately for the template being rendered

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

processContextForTemplate

public static void processContextForTemplate(org.apache.velocity.Template template,
                                             org.apache.velocity.context.Context context)

Process the context appropriately for the template being rendered

Parameters:

template - Template render target

context - Context to process

processContextForHtmlRendering

public static void processContextForHtmlRendering(org.apache.velocity.context.Context context)

Process an event context that is to be used for rendering HTML.

Parameters:

context - Context to process

modifyRequestContext

public static void modifyRequestContext(org.apache.velocity.context.Context context,
                                        javax.servlet.http.HttpServletRequest request)

Adds request based information to the given context. This Context will, presumably, be a ConfluenceVelocityContext, created for the current request. Values added to the context are:

• user -- the User associated with the request
• userHistory -- the user's confluence navigation history if such a history has been associated with the current session

Parameters:

context - the context

request - the request