com.atlassian.jira.util
Interface VelocityParamFactory

All Known Implementing Classes:

VelocityParamFactoryImpl

@InjectableComponent
public interface VelocityParamFactory

Factory that can create default Velocity Parameters for use in Velocity templates.

Since:

v5.0

Method Summary

Map<String,Object>	getDefaultVelocityParams() Method to construct a map with a number of common parameters used by velocity templates.
Map<String,Object>	getDefaultVelocityParams(JiraAuthenticationContext authenticationContext) Method to construct a map with a number of common parameters used by velocity templates.
Map<String,Object>	getDefaultVelocityParams(Map<String,Object> startingParams) Method to construct a map with a number of common parameters used by velocity templates.
Map<String,Object>	getDefaultVelocityParams(Map<String,Object> startingParams, JiraAuthenticationContext authenticationContext) Method to construct a map with a number of common parameters used by velocity templates.

Method Detail

getDefaultVelocityParams

Map<String,Object> getDefaultVelocityParams(JiraAuthenticationContext authenticationContext)

Method to construct a map with a number of common parameters used by velocity templates.

Parameters:

authenticationContext - JiraAuthenticationContext

Returns:

a Map with common velocity parameters

getDefaultVelocityParams

Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams,
                                            JiraAuthenticationContext authenticationContext)

Method to construct a map with a number of common parameters used by velocity templates.

Parameters:

startingParams - Map of parameters that may be used to override any of the parameters set here.

authenticationContext - JiraAuthenticationContext

Returns:

a Map with common velocity parameters

getDefaultVelocityParams

Map<String,Object> getDefaultVelocityParams()

Method to construct a map with a number of common parameters used by velocity templates. It uses the user from the current request.

Returns:

a Map with common velocity parameters

getDefaultVelocityParams

Map<String,Object> getDefaultVelocityParams(Map<String,Object> startingParams)

Method to construct a map with a number of common parameters used by velocity templates. It uses the user from the current request.

Parameters:

startingParams - Map of parameters that may be used to override any of the parameters set here.

Returns:

a Map with common velocity parameters