- 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_LINE_LENGTH - Static variable in class org.apache.maven.plugins.site.deploy.HelpMojo
-
- 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
-
- detail - Variable in class org.apache.maven.plugins.site.deploy.HelpMojo
-
If true
, display all settable properties for each goal.
- 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
-
- 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(File) - Static method in class org.apache.maven.plugins.site.descriptor.SiteDescriptorAttachMojo
-
- getClassifier() - Method in class org.apache.maven.plugins.site.render.SiteJarMojo
-
- 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
-
- getIndentLevel(String) - Static method in class org.apache.maven.plugins.site.deploy.HelpMojo
-
Gets the indentation level of the specified line.
- 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
-
- getPropertyFromExpression(String) - Method in class org.apache.maven.plugins.site.deploy.HelpMojo
-
- 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
-
- getSingleChild(Node, String) - Method in class org.apache.maven.plugins.site.deploy.HelpMojo
-
- 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
-
- getValue(Node, String) - Method in class org.apache.maven.plugins.site.deploy.HelpMojo
-
- getWagon(Repository, WagonManager) - Method in class org.apache.maven.plugins.site.deploy.AbstractDeployMojo
-
- goal - Variable in class org.apache.maven.plugins.site.deploy.HelpMojo
-
The name of the goal for which to show help.
- 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
-