A

AbstractDeployMojo - Class in org.apache.maven.plugins.site.deploy

Abstract base class for deploy mojos.

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

 

AbstractSiteDescriptorMojo - Class in org.apache.maven.plugins.site.descriptor

Abstract class to compute effective site decoration model for site descriptors.

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

 

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.render

Base class for site rendering mojos.

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

 

AbstractStagingMojo - Class in org.apache.maven.plugins.site.deploy

Abstract base class for staging mojos.

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

 

appendSlash(String) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Make sure the given url ends with a slash.

B

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

Derive the path portion of the given URL.

BugFixedRepository - Class in org.apache.maven.plugins.site.deploy.wagon

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

BugFixedRepository(String, String) - Constructor for class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

C

categoriseReports(Collection<MavenReport>) - Method in class org.apache.maven.plugins.site.render.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.render

Renders a Maven report.

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

 

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

 

checkInputEncoding() - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo

 

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

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

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

 

D

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

The String "staging/".

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

 

determineDeploySite() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

 

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

Deploy directly to the current project's distribution management site.

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

 

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

 

determineTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

 

determineTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.AbstractStagingMojo

By default, staging mojos will get their top distribution management site url by getting top parent with the same site, which is a good heuristics.

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

Deploy distribution site url is directly the current project value.

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

If stagingSiteURL is configured, top most parent with same staging site url will be used.

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

Returns the directory path portion of a file specification string.

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

 

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

 

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

Bean to handle Doxia in a servlet context attribute

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

 

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

Render a page as requested.

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

 

E

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

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

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

 

equals(Object) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

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

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

 

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

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

 

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

 

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

Generate the project site

throws MojoExecutionException if any

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

 

F

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

Returns the filename portion of a file specification string.

G

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

Generates a sitemap.xml in targetDir/xdoc/.

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

Directory containing generated documentation in source format (Doxia supported markup).

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

 

getBasedir() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

Retrieve the base directory of the repository.

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

 

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

 

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

 

getDeployModuleDirectory() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Find the relative path between the distribution URLs of the top site and the current project.

getDeploySite() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Get the site used for deployment, with its id to look up credential settings and the target URL for the deploy.

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

 

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

Get the encoding to use when writing the output file.

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

Find the build directory of the execution root project in the reactor.

getGeneratedSiteContext() - Method in class org.apache.maven.plugins.site.run.DoxiaBean

 

getHost() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

Get the value of i18n.

getId() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

Gets the input files encoding.

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

 

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

 

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

 

getMavenVersion() - Static method in class org.apache.maven.plugins.site.AbstractSiteMojo

 

getName() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

Gets the effective reporting output files encoding.

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

 

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

 

getParameter(String) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

getPassword() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

getPermissions() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

getPort() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

 

getProtocol() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

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.descriptor.SiteDescriptorArtifactMetadata

 

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

 

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

 

getReports() - Method in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo

 

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

 

getSite(MavenProject) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Extract the distributionManagement site from the given MavenProject.

getTopDistributionManagementSiteUrl() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Get the top distribution management site url, used for module relative path calculations.

getTopLevelProject(MavenProject) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Extract the distributionManagement site of the top level parent of the given MavenProject.

getUrl() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

getUsername() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

H

hashCode() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

Display help information on maven-site-plugin.
Call mvn site:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

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

 

host(String) - Static method in class org.apache.maven.plugins.site.deploy.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.run.DoxiaFilter

 

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

 

isDeploy() - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Detect if the mojo is staging or deploying.

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

 

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

 

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

 

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

 

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

 

isMaven3OrMore() - Static method in class org.apache.maven.plugins.site.AbstractSiteMojo

Check the current Maven version to see if it's Maven 3.0 or newer.

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

 

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

 

L

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

 

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

The local repository.

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

Locate every document to be rendered for given locale: handwritten content, ie Doxia files, reports, "Project Information" and "Project Reports" category summaries.

locateReports(List<MavenReportExecution>, Map<String, DocumentRenderer>, Locale) - Method in class org.apache.maven.plugins.site.render.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

mavenSession - Variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

 

mavenSession - Variable in class org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo

The current Maven session.

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

 

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

 

O

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

 

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

 

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

 

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

 

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

 

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

 

output - Variable in class org.apache.maven.plugins.site.descriptor.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.render.SiteMojo

Directory where the project sites and report distributions will be generated (as html/css/...).

P

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

 

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

Various path (URL) manipulation routines.

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

 

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

 

prepareDecorationModel(Locale) - Method in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

 

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

The Maven project.

protocol(String) - Static method in class org.apache.maven.plugins.site.deploy.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.render.CategorySummaryDocumentRenderer

 

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

 

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

Renders a Maven report in a Doxia site.

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

 

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

Reports (Maven 2).

repositories - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

Remote repositories used for the project.

S

setBasedir(String) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

 

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

 

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

Set the encoding to use when writing the output file.

setGeneratedSiteContext(SiteRenderingContext) - Method in class org.apache.maven.plugins.site.run.DoxiaBean

 

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

Set the value of i18n.

setId(String) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

setName(String) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

setParameters(Properties) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

setPermissions(RepositoryPermissions) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

setPort(int) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

 

setProtocol(String) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

 

setUrl(String) - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

 

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

Deploys the generated site using wagon supported protocols to the site URL specified in the <distributionManagement> section of the POM.

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

 

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

Attach a POM to an artifact.

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

 

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

Adds the site descriptor (site.xml) to the list of files to be installed/deployed.
For Maven-2.x this is enabled by default only when the project has pom packaging since it will be used by modules inheriting, but this can be enabled for other projects packaging if needed.
This default execution has been removed from the built-in lifecycle of Maven 3.x for pom-projects.

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

 

siteDirectory - Variable in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).

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

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.render.SiteJarMojo

 

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

Generate a sitemap.

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

Constructor sets default values.

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

Generates the site for a single project.

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

 

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

Site renderer.

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

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

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

 

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

Deploys the generated site to a staging or mock URL to the site URL specified in the <distributionManagement> section of the POM, using wagon supported protocols

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

 

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

Deploys the generated site to 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.deploy.SiteStageMojo

 

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

SiteTool.

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

Set this to 'true' to skip site generation and staging.

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

 

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

 

T

topSiteURL - Variable in class org.apache.maven.plugins.site.deploy.AbstractStagingMojo

Top distribution management site url, for manual configuration when auto-calculated value doesn't match expectations.

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

 

toString() - Method in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

 

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

 

U

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

 

W

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

Write comments in a normalize way.

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

Write comments in the Effective POM/settings header.

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