Package com.atlassian.confluence.macro
Class GenericVelocityMacro
java.lang.Object
com.atlassian.confluence.macro.GenericVelocityMacro
- All Implemented Interfaces:
Macro
A configurable and generic macro that renders a Velocity template as part of its execution.
- Since:
- 4.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.atlassian.confluence.macro.Macro
Macro.BodyType, Macro.OutputType
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe value of "macro.required.velocity.context.keys" is a string of keys inMacroUtils.defaultVelocityContext()
, split by ",". -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe type of body that this macro has, this is used to infer the migration task if no custom one is provided.getName()
boolean
boolean
Deprecated.since 4.0.void
setBodyType
(Macro.BodyType bodyType) void
setEscapeBody
(boolean escapeBody) void
setHtmlToXmlConverter
(HtmlToXmlConverter htmlToXmlConverter) void
setLegacyWikiTemplate
(boolean legacyWikiTemplate) void
setMacroParameters
(List<MacroParameter> macroParameters) void
void
setSpaceManager
(SpaceManager spaceManager) void
setStorageToViewTransformer
(Transformer storageToViewTransformer) void
setSubRenderer
(com.atlassian.renderer.v2.V2SubRenderer subRenderer) Deprecated.since 4.0.void
setTemplate
(String template) void
setVelocityHelperService
(VelocityHelperService velocityHelperService)
-
Field Details
-
REQUIRED_VELOCITY_CONTEXT_KEYS
The value of "macro.required.velocity.context.keys" is a string of keys inMacroUtils.defaultVelocityContext()
, split by ",".
-
-
Constructor Details
-
GenericVelocityMacro
public GenericVelocityMacro()
-
-
Method Details
-
execute
public String execute(Map<String, String> parameters, String body, ConversionContext context) throws MacroExecutionException- Specified by:
execute
in interfaceMacro
- Throws:
MacroExecutionException
-
getBodyType
Description copied from interface:Macro
The type of body that this macro has, this is used to infer the migration task if no custom one is provided.- Specified by:
getBodyType
in interfaceMacro
- Returns:
- The type of body this macro has.
-
setBodyType
-
getOutputType
- Specified by:
getOutputType
in interfaceMacro
-
isLegacyWikiTemplate
Deprecated.since 4.0. This is a transition method that will be removed fairly quickly after the 4.0 release since we expected admin's to manually fix their user macros to no longer use wiki templates.- Returns:
- true if this is a user macro that still uses a wiki template.
- Since:
- 4.0
-
setLegacyWikiTemplate
public void setLegacyWikiTemplate(boolean legacyWikiTemplate) -
getTemplate
- Returns:
- the Velocity template rendered by this macro.
-
setTemplate
- Parameters:
template
- the Velocity template to be rendered by this macro.
-
getName
-
setName
-
isEscapeBody
public boolean isEscapeBody() -
setEscapeBody
public void setEscapeBody(boolean escapeBody) -
setSpaceManager
-
setHtmlToXmlConverter
-
setStorageToViewTransformer
-
getMacroParameters
-
setMacroParameters
-
setSubRenderer
Deprecated.since 4.0. Rendering wiki macro templates is no longer supported. You will need to manually fix any macros with wiki templates.- Parameters:
subRenderer
- the v2 subRenderer to be used if this is an old user macro with a wiki template which has not yet been fixed.
-
setVelocityHelperService
- Since:
- 8.6
-