A B C D E F G H I L M O P R S T U W

A

AbstractSiteMojo - Class in org.apache.maven.plugins.site

Base class for site mojos.

AbstractSiteMojo() - Constructor for class org.apache.maven.plugins.site.AbstractSiteMojo

AbstractSiteRenderingMojo - Class in org.apache.maven.plugins.site

Base class for site rendering mojos.

AbstractSiteRenderingMojo() - Constructor for class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

artifactFactory - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

The component used for creating artifact instances.

artifactResolver - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

The component that is used to resolve additional artifacts required.

assembler - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

The component for assembling inheritance.

attributes - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

The template properties for rendering the site.

B

basedir(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

Derive the path portion of the given URL.

C

categoriseReports(Collection<MavenReport>) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

Go through the collection of reports and put each report into a list for the appropriate category.

CategorySummaryDocumentRenderer - Class in org.apache.maven.plugins.site

Renders a Maven report.

CategorySummaryDocumentRenderer(RenderingContext, String, String, String, I18N, List<MavenReport>) - Constructor for class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer

CategorySummaryDocumentRenderer(RenderingContext, String, String, String, I18N, List<MavenReport>, Log) - Constructor for class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer

contextualize(Context) - Method in class org.apache.maven.plugins.site.SiteDeployMojo

contextualize(Context) - Method in class org.apache.maven.plugins.site.SiteStageDeployMojo

createSiteRenderingContext(Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

D

DEFAULT_STAGING_DIRECTORY - Static variable in class org.apache.maven.plugins.site.SiteStageMojo

destroy() - Method in class org.apache.maven.plugins.site.webapp.DoxiaFilter

dirname(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

Returns the directory path portion of a file specification string.

dirnames(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.maven.plugins.site.webapp.DoxiaFilter

DoxiaBean - Class in org.apache.maven.plugins.site.webapp

Bean to handle Doxia in a servlet context attribute

DoxiaBean(SiteRenderingContext, Map<String, DocumentRenderer>, File) - Constructor for class org.apache.maven.plugins.site.webapp.DoxiaBean

DoxiaFilter - Class in org.apache.maven.plugins.site.webapp

Render a page as requested.

DoxiaFilter() - Constructor for class org.apache.maven.plugins.site.webapp.DoxiaFilter

E

EffectiveSiteMojo - Class in org.apache.maven.plugins.site

Displays the effective site descriptor as an XML for this build, after inheritance and interpolation of site.xml.

EffectiveSiteMojo() - Constructor for class org.apache.maven.plugins.site.EffectiveSiteMojo

equals(Object) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

execute() - Method in class org.apache.maven.plugins.site.EffectiveSiteMojo

execute() - Method in class org.apache.maven.plugins.site.HelpMojo

execute() - Method in class org.apache.maven.plugins.site.SiteDeployMojo

execute() - Method in class org.apache.maven.plugins.site.SiteDescriptorAttachMojo

execute() - Method in class org.apache.maven.plugins.site.SiteJarMojo

execute() - Method in class org.apache.maven.plugins.site.SiteMojo

Generate the project site

throws MojoExecutionException if any

execute() - Method in class org.apache.maven.plugins.site.SiteRunMojo

execute() - Method in class org.apache.maven.plugins.site.SiteStageDeployMojo

Generate the project site

throws MojoExecutionException if any

execute() - Method in class org.apache.maven.plugins.site.SiteStageMojo

F

filename(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

Returns the filename portion of a file specification string.

filterReports(List<MavenReport>) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

G

generate(DecorationModel, File, Locale) - Method in class org.apache.maven.plugins.site.SiteMap

Generates a sitemap.xml in targetDir/xdoc/.

generatedSiteDirectory - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

Directory containing generated documentation.

getArtifactType() - Method in class org.apache.maven.plugins.site.SiteJarMojo

getBasedir() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

Retrieve the base directory of the repository.

getBaseVersion() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

getClassifier() - Method in class org.apache.maven.plugins.site.SiteJarMojo

getContext() - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean

getDocuments() - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean

getEncoding() - Method in class org.apache.maven.plugins.site.SiteMap

Get the encoding to use when writing the output file.

getGeneratedSiteDirectory() - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean

getHost() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getI18n() - Method in class org.apache.maven.plugins.site.SiteMap

Get the value of i18n.

getId() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getInputEncoding() - Method in class org.apache.maven.plugins.site.AbstractSiteMojo

Gets the input files encoding.

getKey() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

getLocalFilename(ArtifactRepository) - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

getName() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getOutputEncoding() - Method in class org.apache.maven.plugins.site.AbstractSiteMojo

Gets the effective reporting output files encoding.

getOutputName() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer

getOutputName() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer

getParameter(String) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getPassword() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getPermissions() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getPort() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getProtocol() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getProxyInfo(Repository, WagonManager) - Static method in class org.apache.maven.plugins.site.SiteDeployMojo

Get the ProxyInfo of the proxy associated with the host and the protocol of the given repository.

getRemoteFilename() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

getRenderingContext() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer

getRenderingContext() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer

getStagingDirectory(MavenProject, List<MavenProject>, File) - Method in class org.apache.maven.plugins.site.SiteStageMojo

Find the directory where staging will take place.

getStagingSiteURL(MavenProject, List<MavenProject>, String) - Method in class org.apache.maven.plugins.site.SiteStageDeployMojo

Find the URL where staging will take place.

getStructure(MavenProject, boolean) - Static method in class org.apache.maven.plugins.site.SiteStageMojo

Generates the site structure using the project hiearchy (project and its modules) or using the distributionManagement elements from the pom.xml.

getTopLevelProject(List<MavenProject>) - Method in class org.apache.maven.plugins.site.SiteStageMojo

Find the top level parent in the reactor, i.e.

getUrl() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

getUsername() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

H

hashCode() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

HelpMojo - Class in org.apache.maven.plugins.site

Display help information on maven-site-plugin.
Call

HelpMojo() - Constructor for class org.apache.maven.plugins.site.HelpMojo

host(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

Return the host name (Removes protocol and path from the URL) E.g: for input http://www.codehause.org this method will return www.apache.org

I

i18n - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo

Internationalization.

I18N_DOXIA_CONTEXTS_KEY - Static variable in class org.apache.maven.plugins.site.webapp.DoxiaFilter

init(FilterConfig) - Method in class org.apache.maven.plugins.site.webapp.DoxiaFilter

isExternalReport() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer

isOverwrite() - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer

isOverwrite() - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer

L

locales - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo

A comma separated list of locales supported by Maven.

LOCALES_LIST_KEY - Static variable in class org.apache.maven.plugins.site.webapp.DoxiaFilter

localRepository - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo

The local repository.

locateDocuments(SiteRenderingContext, List<MavenReport>, Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

locateReports(List<MavenReport>, Map<String, DocumentRenderer>, Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

Go through the list of reports and process each one like this: Add the report to a map of reports keyed by filename having the report itself as value If the report is not yet in the map of documents, add it together with a suitable renderer

M

merge(ArtifactMetadata) - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

moduleExcludes - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)

The configuration looks like this:

O

org.apache.maven.plugins.site - package org.apache.maven.plugins.site

org.apache.maven.plugins.site.wagon - package org.apache.maven.plugins.site.wagon

org.apache.maven.plugins.site.wagon.repository - package org.apache.maven.plugins.site.wagon.repository

org.apache.maven.plugins.site.webapp - package org.apache.maven.plugins.site.webapp

output - Variable in class org.apache.maven.plugins.site.EffectiveSiteMojo

Optional parameter to write the output of this help in a given file, instead of writing to the console.

outputDirectory - Variable in class org.apache.maven.plugins.site.SiteMojo

Directory containing the generated project sites and report distributions.

P

password(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

PathUtils - Class in org.apache.maven.plugins.site.wagon

Various path (URL) manipulation routines.

populateReportItems(DecorationModel, Locale, Map<String, MavenReport>) - Method in class org.apache.maven.plugins.site.AbstractSiteMojo

port(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

project - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo

The maven project.

protocol(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

/** Return the protocol name.

R

reactorProjects - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo

The reactor projects.

renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.plugins.site.CategorySummaryDocumentRenderer

renderDocument(Writer, Renderer, SiteRenderingContext) - Method in class org.apache.maven.plugins.site.ReportDocumentRenderer

ReportDocumentRenderer - Class in org.apache.maven.plugins.site

Renders a Maven report.

ReportDocumentRenderer(MavenReport, RenderingContext, Log) - Constructor for class org.apache.maven.plugins.site.ReportDocumentRenderer

reports - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

repositories - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

Remote repositories used for the project.

Repository - Class in org.apache.maven.plugins.site.wagon.repository

This class is an abstraction of the location from/to resources can be transfered.

Repository() - Constructor for class org.apache.maven.plugins.site.wagon.repository.Repository

Deprecated.

use Repository.Repository(String, String)

Repository(String, String) - Constructor for class org.apache.maven.plugins.site.wagon.repository.Repository

S

setBasedir(String) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

setContext(SiteRenderingContext) - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean

setDocuments(Map<String, DocumentRenderer>) - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean

setEncoding(String) - Method in class org.apache.maven.plugins.site.SiteMap

Set the encoding to use when writing the output file.

setGeneratedSiteDirectory(File) - Method in class org.apache.maven.plugins.site.webapp.DoxiaBean

setI18n(I18N) - Method in class org.apache.maven.plugins.site.SiteMap

Set the value of i18n.

setId(String) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

setName(String) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

setParameters(Properties) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

setPermissions(RepositoryPermissions) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

setPort(int) - Method in class org.apache.maven.plugins.site.SiteRunMojo

setPort(int) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

setProtocol(String) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

setTempWebappDirectory(File) - Method in class org.apache.maven.plugins.site.SiteRunMojo

setUrl(String) - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

SITE_RENDERER_KEY - Static variable in class org.apache.maven.plugins.site.webapp.DoxiaFilter

SiteDeployMojo - Class in org.apache.maven.plugins.site

Deploys the generated site using scp or file protocol to the site URL specified in the <distributionManagement> section of the POM.

SiteDeployMojo() - Constructor for class org.apache.maven.plugins.site.SiteDeployMojo

SiteDescriptorArtifactMetadata - Class in org.apache.maven.plugins.site

Attach a POM to an artifact.

SiteDescriptorArtifactMetadata(Artifact, DecorationModel, File) - Constructor for class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

SiteDescriptorAttachMojo - Class in org.apache.maven.plugins.site

Adds the site descriptor (site.xml) to the list of files to be installed/deployed.

SiteDescriptorAttachMojo() - Constructor for class org.apache.maven.plugins.site.SiteDescriptorAttachMojo

siteDirectory - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo

Directory containing the site.xml file and the source for apt, fml and xdoc docs.

SiteJarMojo - Class in org.apache.maven.plugins.site

Bundles the site output into a JAR so that it can be deployed to a repository.

SiteJarMojo() - Constructor for class org.apache.maven.plugins.site.SiteJarMojo

SiteMap - Class in org.apache.maven.plugins.site

Generate a sitemap.

SiteMap(String, I18N) - Constructor for class org.apache.maven.plugins.site.SiteMap

SiteMojo - Class in org.apache.maven.plugins.site

Generates the site for a single project.

SiteMojo() - Constructor for class org.apache.maven.plugins.site.SiteMojo

siteRenderer - Variable in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

Site renderer.

SiteRunMojo - Class in org.apache.maven.plugins.site

Starts the site up, rendering documents as requested for faster editing.

SiteRunMojo() - Constructor for class org.apache.maven.plugins.site.SiteRunMojo

SiteStageDeployMojo - Class in org.apache.maven.plugins.site

Deploys the generated site to a staging or mock directory to the site URL specified in the <distributionManagement> section of the POM.

SiteStageDeployMojo() - Constructor for class org.apache.maven.plugins.site.SiteStageDeployMojo

SiteStageMojo - Class in org.apache.maven.plugins.site

Generates a site in a local staging or mock directory based on the site URL specified in the <distributionManagement> section of the POM.

SiteStageMojo() - Constructor for class org.apache.maven.plugins.site.SiteStageMojo

siteTool - Variable in class org.apache.maven.plugins.site.AbstractSiteMojo

SiteTool.

stagingDirectory - Variable in class org.apache.maven.plugins.site.SiteStageMojo

Staging directory location.

storedInArtifactVersionDirectory() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

storeInLocalRepository(ArtifactRepository, ArtifactRepository) - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

T

toRelative(File, String) - Static method in class org.apache.maven.plugins.site.AbstractSiteMojo

TODO should be removed see PLXUTILS-61

toRelative(File, String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

toString() - Method in class org.apache.maven.plugins.site.SiteDescriptorArtifactMetadata

toString() - Method in class org.apache.maven.plugins.site.wagon.repository.Repository

U

user(String) - Static method in class org.apache.maven.plugins.site.wagon.PathUtils

W

writeComment(XMLWriter, String) - Static method in class org.apache.maven.plugins.site.EffectiveSiteMojo

Write comments in a normalize way.

writeHeader(XMLWriter) - Static method in class org.apache.maven.plugins.site.EffectiveSiteMojo

Write comments in the Effective POM/settings header.

writeXmlFile(File, String) - Static method in class org.apache.maven.plugins.site.EffectiveSiteMojo

A B C D E F G H I L M O P R S T U W