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:

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

Modifier and Type	Field and Description
private static java.lang.String	PARAM_FUNCTION

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

EOL, ROLE

Constructor Summary

Constructors

Constructor and Description
SsiMacro()

Method Summary

Modifier and Type	Method and Description
void	execute(Sink sink, MacroRequest request) Execute the current macro using the given MacroRequest, and emit events into the given sink.
private boolean	isInternalParameter(java.lang.String name)

Methods inherited from class org.apache.maven.doxia.macro.AbstractMacro

enableLogging, getAttributesFromMap, getLog, required

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_FUNCTION

private static final java.lang.String PARAM_FUNCTION

See Also:

Constant Field Values

Constructor Detail

SsiMacro

public SsiMacro()

Method Detail

isInternalParameter

private boolean isInternalParameter(java.lang.String name)

execute

public void execute(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.