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

A

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

Abstract base class for deploy mojos.

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

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

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

Make sure the given url ends with a slash.

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

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

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

D

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

The String "staging/".

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 HelpMojo

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

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

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

F

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

Returns the filename portion of a file specification string.

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

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

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

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

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

Specifies the id to look up credential settings.

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

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

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

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

Specifies the target URL for the deploy.

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

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

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

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

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

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

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

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

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

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

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

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

Extract the distributionManagement site from the given MavenProject.

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

Find the build directory of the top level project in the reactor.

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 <Unnamed>

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

HelpMojo() - Constructor for class 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

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

Detect if the mojo is staging or deploying.

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

isExternalReport() - Method in class org.apache.maven.plugins.site.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.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<MavenReportExecution>, Locale) - Method in class org.apache.maven.plugins.site.AbstractSiteRenderingMojo

locateReports(List<MavenReportExecution>, 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

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

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

The current Maven session.

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

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

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 where the project sites and report distributions will be generated.

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

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 in a doxia site.

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

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

Reports (Maven 2).

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(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 wagon supported protocols 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.
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.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

Constructor sets default values.

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, using wagon supported protocols

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

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

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

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

SiteTool.

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