Class SsiMacro

  • All Implemented Interfaces:
    org.apache.maven.doxia.logging.LogEnabled, Macro

    @Component(role=Macro.class,
               hint="ssi")
    public class SsiMacro
    extends AbstractMacro
    Server-Side Include directive, to insert a SSI into the output. Required parameter is function to define SSI function, then additional parameters are completely free.
    Since:
    1.7
    • Field Summary

      • Fields inherited from interface org.apache.maven.doxia.macro.Macro

        EOL, ROLE
    • Constructor Summary

      Constructors 
      Constructor Description
      SsiMacro()  
    • Constructor Detail

      • SsiMacro

        public SsiMacro()
    • Method Detail

      • execute

        public void execute​(org.apache.maven.doxia.sink.Sink sink,
                            MacroRequest request)
                     throws MacroExecutionException
        Execute the current macro using the given MacroRequest, and emit events into the given sink.
        Parameters:
        sink - The sink to receive the events.
        request - The corresponding MacroRequest.
        Throws:
        MacroExecutionException - if an error occurred during execution.