Package org.apache.maven.doxia.macro
Class SsiMacro
java.lang.Object
org.apache.maven.doxia.macro.AbstractMacro
org.apache.maven.doxia.macro.SsiMacro
- All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled
,Macro
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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute
(org.apache.maven.doxia.sink.Sink sink, MacroRequest request) Execute the current macro using the given MacroRequest, and emit events into the given sink.Methods inherited from class org.apache.maven.doxia.macro.AbstractMacro
enableLogging, getAttributesFromMap, getLog, required
-
Constructor Details
-
SsiMacro
public SsiMacro()
-
-
Method Details
-
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.
-