Class GenericVelocityMacro

java.lang.Object
com.atlassian.confluence.macro.GenericVelocityMacro
All Implemented Interfaces:
Macro

public class GenericVelocityMacro extends Object implements Macro
A configurable and generic macro that renders a Velocity template as part of its execution.
Since:
4.0
  • Field Details

  • 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 interface Macro
      Throws:
      MacroExecutionException
    • getBodyType

      public Macro.BodyType 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 interface Macro
      Returns:
      The type of body this macro has.
    • setBodyType

      public void setBodyType(Macro.BodyType bodyType)
    • getOutputType

      public Macro.OutputType getOutputType()
      Specified by:
      getOutputType in interface Macro
    • isLegacyWikiTemplate

      @Deprecated public boolean 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

      public String getTemplate()
      Returns:
      the Velocity template rendered by this macro.
    • setTemplate

      public void setTemplate(String template)
      Parameters:
      template - the Velocity template to be rendered by this macro.
    • getName

      public String getName()
    • setName

      public void setName(String name)
    • isEscapeBody

      public boolean isEscapeBody()
    • setEscapeBody

      public void setEscapeBody(boolean escapeBody)
    • setSpaceManager

      public void setSpaceManager(SpaceManager spaceManager)
    • setHtmlToXmlConverter

      public void setHtmlToXmlConverter(HtmlToXmlConverter htmlToXmlConverter)
    • setStorageToViewTransformer

      public void setStorageToViewTransformer(Transformer storageToViewTransformer)
    • getMacroParameters

      public List<MacroParameter> getMacroParameters()
    • setMacroParameters

      public void setMacroParameters(List<MacroParameter> macroParameters)
    • setSubRenderer

      @Deprecated public void setSubRenderer(com.atlassian.renderer.v2.V2SubRenderer subRenderer)
      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

      public void setVelocityHelperService(VelocityHelperService velocityHelperService)
      Since:
      8.6