Index

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

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

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

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

append(String, String) - Method in class org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo

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

Make sure the given url ends with a slash.

archive - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

The archive configuration to use.

archiveExcludes - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

List of files to exclude.

archiveIncludes - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

List of files to include.

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

The component for assembling site decoration model inheritance.

attach - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

Specifies whether to attach the generated artifact to the project.

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

Additional template properties for rendering the site.

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

This was changed from private to package local so that it can be unit tested.

B

basedir - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

basedir - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo

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.

categoryReports - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer

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

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

Whether to run the "chmod" command on the remote site after the deploy.

chmod(Wagon, Repository, String, String) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

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

The mode used by the "chmod" command.

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

The options used by the "chmod" command.

classLoader - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer

configureWagon(Wagon, String, Settings, PlexusContainer, Log) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Configure the Wagon with the information from serverConfigurationMap ( which comes from settings.xml )

configureWagonWithMaven2(ComponentConfigurator, Wagon, PlexusConfiguration, PlexusContainer) - Static method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

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

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

context - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory

context - Variable in class org.apache.maven.plugins.site.run.DoxiaBean

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

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

createArchive(File, String) - Method in class org.apache.maven.plugins.site.render.SiteJarMojo

Method that creates the jar file.

createSink(File, String) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory

createSink(File, String, String) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory

createSink(OutputStream) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory

createSink(OutputStream, String) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory

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

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

D

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

Decodes the specified (portion of a) URL.

decoration - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata

DEFAULT_ARCHIVE_EXCLUDES - Static variable in class org.apache.maven.plugins.site.render.SiteJarMojo

DEFAULT_ARCHIVE_INCLUDES - Static variable in class org.apache.maven.plugins.site.render.SiteJarMojo

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

The String "staging/".

deploy(File, Repository) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

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

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

Use wagon to deploy the generated site to a given repository.

desc1 - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer

desc2 - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer

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

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

Find the URL where staging will take place.

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

Find the directory where staging will take place.

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

documents - Variable in class org.apache.maven.plugins.site.run.DoxiaBean

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

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

encoding - Variable in class org.apache.maven.plugins.site.render.SiteMap

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

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

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

extractItems(List<MenuItem>, Sink) - Static method in class org.apache.maven.plugins.site.render.SiteMap

F

file - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorArtifactMetadata

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

Returns the filename portion of a file specification string.

finalName - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

Specifies the filename that will be used for the generated jar file.

G

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

Generates a sitemap.xml in targetDir/xdoc/.

generatedSiteContext - Variable in class org.apache.maven.plugins.site.run.DoxiaBean

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

Directory containing generated documentation.

generateMultiPage(Locale, SinkFactory, Sink) - Method in class org.apache.maven.plugins.site.render.ReportDocumentRenderer

Try to generate report with extended multi-page API.

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

Whether to generate the summary page for project reports: project-info.html.

generateReports - Variable in class org.apache.maven.plugins.site.render.SiteMojo

Convenience parameter that allows you to disable report generation.

generateSitemap - Variable in class org.apache.maven.plugins.site.render.SiteMojo

Generate a sitemap.

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

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

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

getClassifier(File) - Static method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo

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

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

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.

getExecutionRootProject(List<MavenProject>) - Static method in class org.apache.maven.plugins.site.deploy.SiteStageMojo

Find the execution root in the reactor.

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

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

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

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

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

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

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

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

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

Get plugin information from report's Manifest.

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

getProxy(Repository, SettingsDecrypter) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

Get proxy information for Maven 3.

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.

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

Extract the value of the stagingSiteURL configuration parameter of maven-site-plugin for the given project.

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

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.

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

Extract the distributionManagement.site of the top most project in the hierarchy that specifies a stagingSiteURL, starting at the actual 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

getWagon(Repository, WagonManager) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

H

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

host - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

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

i18n - Variable in class org.apache.maven.plugins.site.render.SiteMap

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

i18nDoxiaContexts - Variable in class org.apache.maven.plugins.site.run.DoxiaFilter

id - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

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

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

Directory containing the generated project sites and report distributions.

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

Specifies the input encoding.

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

J

jarArchiver - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

The Jar archiver.

jarOutputDirectory - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

Specifies the directory where the generated jar file will be put.

L

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

A comma separated list of locales to render.

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

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

log - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer

log - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer

M

MARK - Static variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo.URIEncoder

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.

MAX_IDLE_TIME - Static variable in class org.apache.maven.plugins.site.run.SiteRunMojo

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

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

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

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

MultiPageSinkFactory(RenderingContext) - Constructor for class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory

MultiPageSubSink(File, String, RenderingContext) - Constructor for class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink

N

name - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

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.

outputDir - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink

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

Directory where the project sites and report distributions will be generated.

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

Specifies the output encoding.

outputName - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSubSink

P

parameters - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

Properties influencing wagon behaviour which are very specific to particular wagon.

password - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

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.

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

permissions - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

pomPackagingOnly - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo

Attach site descriptor only if packaging is pom.

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

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

port - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

port - Variable in class org.apache.maven.plugins.site.run.SiteRunMojo

The port to execute the HTTP server on.

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.

projectHelper - Variable in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo

Maven ProjectHelper.

projectHelper - Variable in class org.apache.maven.plugins.site.render.SiteJarMojo

Used for attaching the artifact in the project.

protocol - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

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

/** Return the protocol name.

push(File, Repository, Wagon, ProxyInfo, List<Locale>, String) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo

R

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

The reactor projects.

relativePath(String) - Static method in class org.apache.maven.plugins.site.render.SiteMap

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

Make links in the site descriptor relative to the project URL.

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

renderDoxiaDocuments(Map<String, DocumentRenderer>, SiteRenderingContext, File, boolean) - Method in class org.apache.maven.plugins.site.render.SiteMojo

Render Doxia documents from the list given, but not reports.

renderingContext - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer

renderingContext - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer

renderLocale(Locale, List<MavenReportExecution>) - Method in class org.apache.maven.plugins.site.render.SiteMojo

report - Variable 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

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

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

reportMojoInfo - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer

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

Configuration section used internally by Maven 3.

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.

RESERVED - Static variable in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo.URIEncoder

S

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

Whether to save Velocity processed Doxia content (*.<ext>.vm) to ${generatedSiteDirectory}/processed.

serialVersionUID - Static variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

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

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

The current user system settings for use in Maven.

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

sinks - Variable in class org.apache.maven.plugins.site.render.ReportDocumentRenderer.MultiPageSinkFactory

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

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.

siteRenderer - Variable in class org.apache.maven.plugins.site.run.DoxiaFilter

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.

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

Set this to 'true' to skip site deployment.

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

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

Staging directory location.

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

stagingRepositoryId - Variable in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo

The identifier of the repository where the staging site will be deployed.

stagingSiteURL - Variable in class org.apache.maven.plugins.site.deploy.SiteStageDeployMojo

The staged site will be deployed to this URL.

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

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

The location of a Velocity template file to use.

tempWebappDirectory - Variable in class org.apache.maven.plugins.site.run.SiteRunMojo

Where to create the dummy web application.

title - Variable in class org.apache.maven.plugins.site.render.CategorySummaryDocumentRenderer

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

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

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

url - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

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

username - Variable in class org.apache.maven.plugins.site.deploy.wagon.BugFixedRepository

V

validate - Variable in class org.apache.maven.plugins.site.render.SiteMojo

Whether to validate xml input documents.

W

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

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

Write comments in a normalize way.

writeEffectiveSite(DecorationModel, XMLWriter) - Method in class org.apache.maven.plugins.site.descriptor.EffectiveSiteMojo

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

X

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

Deprecated.

use the standard m2 directory layout

A B C D E F G H I J L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form