Class DefaultSiteRenderer

java.lang.Object

org.apache.maven.doxia.siterenderer.DefaultSiteRenderer

All Implemented Interfaces:

Renderer, SiteRenderer

@Singleton
@Named
public class DefaultSiteRenderer
extends Object
implements Renderer

DefaultSiteRenderer class.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	DefaultSiteRenderer.DuplicateCallback

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String, ContextCustomizer>	contextCustomizers
private org.apache.maven.doxia.Doxia	doxia
private static final String	DOXIA_SITE_RENDERER_VERSION
private static final org.slf4j.Logger	LOGGER
static final String	MERMAID_VERSION
private org.apache.maven.doxia.parser.module.ParserModuleManager	parserModuleManager
private org.codehaus.plexus.PlexusContainer	plexus
private static final String	SKIN_TEMPLATE_LOCATION
private static final String	TOOLS_LOCATION
private org.codehaus.plexus.velocity.VelocityComponent	velocity

Constructor Summary

Constructors

Constructor	Description
DefaultSiteRenderer()

Method Summary

Modifier and Type	Method	Description
private void	addModuleFiles(File siteRootDirectory, SiteRenderingContext.SiteDirectory siteDirectory, File moduleBasedir, org.apache.maven.doxia.parser.module.ParserModule module, String excludes, Map<String, DocumentRenderer> files)	Populates the files map with DocumentRenderers per output name in parameter files for all files in the moduleBasedir matching the module extensions, taking care of duplicates if needed.
private boolean	checkForDuplicate(DocumentRenderingContext newDocRenderingContext, Function<String, DocumentRenderer> lookupFunction, DefaultSiteRenderer.DuplicateCallback callback)
private boolean	checkForDuplicate(DocumentRenderingContext newDocRenderingContext, Map<String, DocumentRenderer> existingDocumentRenderers, boolean skipDuplicates)	Checks if the newDocRenderingContext clashes with an existing document renderer.
private static void	closeZipFile(ZipFile zipFile)
protected void	copyDirectory(File source, File destination)	Copy the directory
private static void	copyFileFromResource(String name, File destFile)
private static void	copyFileFromZip(ZipFile file, ZipEntry entry, File destFile)
void	copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory)	Copy resource files from skin, template, and site resources.
SiteRenderingContext	createContextForSkin(org.apache.maven.artifact.Artifact skin, Map<String,?> attributes, SiteModel siteModel, String defaultTitle, Locale locale)	Create a Site Rendering Context for a site using a skin.
protected org.apache.velocity.context.Context	createDocumentVelocityContext(DocumentRenderingContext docRenderingContext, SiteRenderingContext siteRenderingContext)	Create a Velocity Context for a Doxia document, containing every information about rendered document.
private Map<String,String>	createResourceConditionsMap(SkinModel skinModel)
private SiteRenderingContext	createSiteRenderingContext(Map<String,?> attributes, SiteModel siteModel, String defaultTitle, Locale locale)
protected org.apache.velocity.context.Context	createSiteTemplateVelocityContext(DocumentContent content, SiteRenderingContext siteRenderingContext)	Create a Velocity Context for the site template decorating the document.
protected org.apache.velocity.context.Context	createToolManagedVelocityContext(SiteRenderingContext siteRenderingContext)	Creates a Velocity Context with all generic tools configured wit the site rendering context.
(package private) static boolean	endsWithIgnoreCase(String str, String searchStr)
private static String	escapeLineBreaksForLogging(String input)
private List<String>	filterExtensionIgnoreCase(List<String> fileNames, String extension)
void	generateDocument(Writer writer, SiteRendererSink sink, SiteRenderingContext siteRenderingContext)
(package private) static Properties	getMavenProjectProperties()	Properties contain some resolved properties from this project's Maven model
private static String	getSiteRendererVersion()
private static ZipFile	getZipFile(File file)
private boolean	isResourceRelevant(String name, org.apache.velocity.context.Context velocityContext, Map<String,String> resourceConditions)
Map<String, DocumentRenderer>	locateDocumentFiles(SiteRenderingContext siteRenderingContext)	Locate Doxia document source files in the site source context.
(package private) boolean	matchVersion(String current, String prerequisite)
void	mergeDocumentIntoSite(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext)	Generate a document output integrated in a site from a document content, i.e.
void	render(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory)	Render a collection of documents into a site.
void	renderDocument(Writer writer, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext)	Render a document written in a Doxia markup language.
private void	saveVelocityProcessedContent(DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext, String doxiaContent)
private Reader	validate(Reader source, String resource)

Methods inherited from class Object

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

Methods inherited from interface SiteRenderer

locateDocumentFiles

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

velocity

@Inject
private org.codehaus.plexus.velocity.VelocityComponent velocity

parserModuleManager

@Inject
private org.apache.maven.doxia.parser.module.ParserModuleManager parserModuleManager

doxia

@Inject
private org.apache.maven.doxia.Doxia doxia

plexus

@Inject
private org.codehaus.plexus.PlexusContainer plexus

contextCustomizers

@Inject
private Map<String, ContextCustomizer> contextCustomizers

SKIN_TEMPLATE_LOCATION

private static final String SKIN_TEMPLATE_LOCATION

See Also:

• Constant Field Values

TOOLS_LOCATION

private static final String TOOLS_LOCATION

See Also:

• Constant Field Values

DOXIA_SITE_RENDERER_VERSION

private static final String DOXIA_SITE_RENDERER_VERSION

MERMAID_VERSION

public static final String MERMAID_VERSION

Constructor Details

DefaultSiteRenderer

public DefaultSiteRenderer()

Method Details

getMavenProjectProperties

static Properties getMavenProjectProperties()
                                     throws IOException

Properties contain some resolved properties from this project's Maven model

Returns:

some resolved Maven project properties

Throws:

IOException - in case the underlying file could not be accessed

locateDocumentFiles

public Map<String, DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext)
                                                  throws IOException,
RendererException

Locate Doxia document source files in the site source context.

Specified by:

locateDocumentFiles in interface SiteRenderer

Parameters:

siteRenderingContext - the SiteRenderingContext to use

Returns:

the Doxia document renderers in a Map keyed by output file path.

Throws:

IOException - if it bombs.

RendererException - if it bombs.

filterExtensionIgnoreCase

private List<String> filterExtensionIgnoreCase(List<String> fileNames,
 String extension)

addModuleFiles

private void addModuleFiles(File siteRootDirectory,
 SiteRenderingContext.SiteDirectory siteDirectory,
 File moduleBasedir,
 org.apache.maven.doxia.parser.module.ParserModule module,
 String excludes,
 Map<String, DocumentRenderer> files)
                     throws IOException,
RendererException

Populates the files map with DocumentRenderers per output name in parameter files for all files in the moduleBasedir matching the module extensions, taking care of duplicates if needed.

Parameters:

siteRootDirectory -

siteDirectory -

moduleBasedir -

module -

excludes -

files -

Throws:

IOException

RendererException

checkForDuplicate

private boolean checkForDuplicate(DocumentRenderingContext newDocRenderingContext,
 Map<String, DocumentRenderer> existingDocumentRenderers,
 boolean skipDuplicates)
                           throws RendererException

Checks if the newDocRenderingContext clashes with an existing document renderer. This check involves checking for duplicates both case-sensitive and case-insensitive.

Parameters:

newDocRenderingContext - the doc rendering context of a new file

existingDocumentRenderers - the map of already existing renderers

Returns:

true if no duplicates were found, false otherwise

Throws:

RendererException

checkForDuplicate

private boolean checkForDuplicate(DocumentRenderingContext newDocRenderingContext,
 Function<String, DocumentRenderer> lookupFunction,
 DefaultSiteRenderer.DuplicateCallback callback)
                           throws RendererException

Throws:

RendererException

render

public void render(Collection<DocumentRenderer> documents,
 SiteRenderingContext siteRenderingContext,
 File outputDirectory)
            throws RendererException,
IOException

Render a collection of documents into a site.

Specified by:

render in interface SiteRenderer

Parameters:

documents - the documents to render.

siteRenderingContext - the SiteRenderingContext to use.

outputDirectory - the output directory to write results.

Throws:

RendererException - if it bombs.

IOException - if it bombs.

renderDocument

public void renderDocument(Writer writer,
 DocumentRenderingContext docRenderingContext,
 SiteRenderingContext siteContext)
                    throws RendererException

Render a document written in a Doxia markup language. This method is an internal method, used by DoxiaDocumentRenderer.

Specified by:

renderDocument in interface SiteRenderer

Parameters:

writer - the writer to render the document to.

docRenderingContext - the document's rendering context, which is expected to have a non-null parser id.

siteContext - the site's rendering context

Throws:

RendererException - if it bombs.

saveVelocityProcessedContent

private void saveVelocityProcessedContent(DocumentRenderingContext docRenderingContext,
 SiteRenderingContext siteContext,
 String doxiaContent)
                                   throws IOException

Throws:

IOException

createToolManagedVelocityContext

protected org.apache.velocity.context.Context createToolManagedVelocityContext(SiteRenderingContext siteRenderingContext)

Creates a Velocity Context with all generic tools configured wit the site rendering context.

Parameters:

siteRenderingContext - the site rendering context

Returns:

a Velocity tools managed context

createDocumentVelocityContext

protected org.apache.velocity.context.Context createDocumentVelocityContext(DocumentRenderingContext docRenderingContext,
 SiteRenderingContext siteRenderingContext)

Create a Velocity Context for a Doxia document, containing every information about rendered document.

Parameters:

docRenderingContext - the document's rendering context (may be null in which case the context does not contain document-specific information)

siteRenderingContext - the site rendering context

Returns:

a Velocity tools managed context

createSiteTemplateVelocityContext

protected org.apache.velocity.context.Context createSiteTemplateVelocityContext(DocumentContent content,
 SiteRenderingContext siteRenderingContext)

Create a Velocity Context for the site template decorating the document. In addition to all the informations from the document, this context contains data gathered in SiteRendererSink during document rendering.

Parameters:

content - the document content to be merged into the template

siteRenderingContext - the site rendering context

Returns:

a Velocity tools managed context

generateDocument

public void generateDocument(Writer writer,
 SiteRendererSink sink,
 SiteRenderingContext siteRenderingContext)
                      throws RendererException

Throws:

RendererException

mergeDocumentIntoSite

public void mergeDocumentIntoSite(Writer writer,
 DocumentContent content,
 SiteRenderingContext siteRenderingContext)
                           throws RendererException

Generate a document output integrated in a site from a document content, i.e. merge the document content into the site template.

Specified by:

mergeDocumentIntoSite in interface SiteRenderer

Parameters:

writer - the Writer to use.

content - the document content to be merged.

siteRenderingContext - the SiteRenderingContext to use.

Throws:

RendererException - if it bombs.

createSiteRenderingContext

private SiteRenderingContext createSiteRenderingContext(Map<String,?> attributes,
 SiteModel siteModel,
 String defaultTitle,
 Locale locale)

createContextForSkin

public SiteRenderingContext createContextForSkin(org.apache.maven.artifact.Artifact skin,
 Map<String,?> attributes,
 SiteModel siteModel,
 String defaultTitle,
 Locale locale)
                                          throws IOException,
RendererException

Create a Site Rendering Context for a site using a skin.

Specified by:

createContextForSkin in interface SiteRenderer

Parameters:

skin - a skin

attributes - attributes to use

siteModel - a site model

defaultTitle - default title

locale - locale to use

Returns:

a SiteRenderingContext.

Throws:

IOException - if it bombs.

RendererException - if it bombs.

matchVersion

boolean matchVersion(String current,
 String prerequisite)
              throws RendererException

Throws:

RendererException

copyResources

public void copyResources(SiteRenderingContext siteRenderingContext,
 File outputDirectory)
                   throws IOException

Copy resource files from skin, template, and site resources.

Specified by:

copyResources in interface SiteRenderer

Parameters:

siteRenderingContext - the SiteRenderingContext to use.

outputDirectory - output directory as file

Throws:

IOException - if it bombs.

copyFileFromResource

private static void copyFileFromResource(String name,
 File destFile)
                                  throws IOException

Throws:

IOException

isResourceRelevant

private boolean isResourceRelevant(String name,
 org.apache.velocity.context.Context velocityContext,
 Map<String,String> resourceConditions)

createResourceConditionsMap

private Map<String,String> createResourceConditionsMap(SkinModel skinModel)

escapeLineBreaksForLogging

private static String escapeLineBreaksForLogging(String input)

copyFileFromZip

private static void copyFileFromZip(ZipFile file,
 ZipEntry entry,
 File destFile)
                             throws IOException

Throws:

IOException

copyDirectory

protected void copyDirectory(File source,
 File destination)
                      throws IOException

Copy the directory

Parameters:

source - source file to be copied

destination - destination file

Throws:

IOException - if any

validate

private Reader validate(Reader source,
 String resource)
                 throws org.apache.maven.doxia.parser.ParseException,
IOException

Throws:

org.apache.maven.doxia.parser.ParseException

IOException

endsWithIgnoreCase

static boolean endsWithIgnoreCase(String str,
 String searchStr)

getZipFile

private static ZipFile getZipFile(File file)
                           throws IOException

Throws:

IOException

closeZipFile

private static void closeZipFile(ZipFile zipFile)

getSiteRendererVersion

private static String getSiteRendererVersion()