Package org.apache.maven.doxia.tools
Class DefaultSiteTool
java.lang.Object
org.apache.maven.doxia.tools.DefaultSiteTool
- All Implemented Interfaces:
SiteTool
Default implementation of the site tool.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.apache.maven.artifact.handler.manager.ArtifactHandlerManager
The component used for getting artifact handlers.protected SiteModelInheritanceAssembler
The component for assembling inheritance.protected org.codehaus.plexus.i18n.I18N
Internationalization.private static final org.slf4j.Logger
protected org.eclipse.aether.RepositorySystem
The component that is used to resolve additional required artifacts.Fields inherited from interface org.apache.maven.doxia.tools.SiteTool
DEFAULT_LOCALE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
appendMenuItem
(org.apache.maven.project.MavenProject project, Menu menu, String name, String href, String defaultHref) private static String
buildRelativePath
(String toPath, String fromPath, char separatorChar) private Locale
codeToLocale
(String localeCode) Converts a locale code like "en", "en_US" or "en_US_win" to ajava.util.Locale
object.private Banner
convertBanner
(Banner oldBanner) private Image
private LinkItem
convertLinkItem
(LinkItem oldLinkItem) convertMenuItems
(List<MenuItem> oldMenuItems) private SiteModel
convertOldToNewSiteModel
(DecorationModel oldModel) private MenuItem
createCategoryMenu
(String name, String href, List<org.apache.maven.reporting.MavenReport> categoryReports, Locale locale) private org.eclipse.aether.resolution.ArtifactRequest
createSiteDescriptorArtifactRequest
(org.apache.maven.project.MavenProject project, String localeStr, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) private void
deletePseudoSiteDescriptorMarkerFile
(org.eclipse.aether.RepositorySystemSession repoSession, org.eclipse.aether.resolution.ArtifactRequest request) private SiteModel
private static String
getDistMgmntSiteUrl
(org.apache.maven.model.DistributionManagement distMgmnt) private static String
getDistMgmntSiteUrl
(org.apache.maven.project.MavenProject project) Return distributionManagement.site.url if defined, null otherwise.getInterpolatedSiteDescriptorContent
(Map<String, String> props, org.apache.maven.project.MavenProject aProject, String siteDescriptorContent) Interpolating several expressions in the site descriptor content.private String
getInterpolatedSiteDescriptorContent
(org.apache.maven.project.MavenProject aProject, String siteDescriptorContent, boolean isEarly) private org.apache.maven.project.MavenProject
getModuleFromReactor
(org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, String module) protected static String
getNormalizedPath
(String path) private static org.apache.maven.model.Plugin
private static String
getPluginParameter
(org.apache.maven.project.MavenProject project, String pluginId, String param) private static String
getRelativeFilePath
(String oldPath, String newPath) getRelativePath
(String to, String from) Deprecated.getSiteDescriptor
(File siteDirectory, Locale locale) Get a site descriptor from the project's site directory.(package private) File
getSiteDescriptorFromRepository
(org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Locale locale) Get a site descriptor from one of the repositories.getSiteLocales
(String locales) Extracts from a comma-separated list the locales that are available insite-tool
resource bundle.getSiteModel
(int depth, File siteDirectory, Locale locale, org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) getSiteModel
(File siteDirectory, Locale locale, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) Get a site model for a project.org.apache.maven.artifact.Artifact
getSkinArtifactFromRepository
(org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Skin skin) Get a skin artifact from one of the repositories.private static boolean
isEmptyList
(List<?> list) Convenience method.private boolean
isOldSiteModel
(String siteDescriptorContent) private void
populateModulesMenu
(SiteModel siteModel, Locale locale, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, boolean keepInheritedRefs) Populate the pre-definedmodules
menu of the model, if used through<menu ref="modules"/>
.private void
populateParentMenu
(SiteModel siteModel, Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.project.MavenProject parentProject, boolean keepInheritedRefs) Populate the pre-definedparent
menu of the site model, if used through<menu ref="parent"/>
.void
populateReportsMenu
(SiteModel siteModel, Locale locale, Map<String, List<org.apache.maven.reporting.MavenReport>> categories) Populate the pre-definedreports
menu of the site model, if used through<menu ref="reports"/>
.private SiteModel
readSiteModel
(String siteDescriptorContent, org.apache.maven.project.MavenProject project, Locale locale) private File
resolveSiteDescriptor
(org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Locale locale) private String
siteModelToString
(SiteModel siteModel) private static String
-
Field Details
-
LOGGER
private static final org.slf4j.Logger LOGGER -
repositorySystem
@Inject protected org.eclipse.aether.RepositorySystem repositorySystemThe component that is used to resolve additional required artifacts. -
artifactHandlerManager
@Inject private org.apache.maven.artifact.handler.manager.ArtifactHandlerManager artifactHandlerManagerThe component used for getting artifact handlers. -
i18n
@Inject protected org.codehaus.plexus.i18n.I18N i18nInternationalization. -
assembler
The component for assembling inheritance.
-
-
Constructor Details
-
DefaultSiteTool
public DefaultSiteTool()
-
-
Method Details
-
getSkinArtifactFromRepository
public org.apache.maven.artifact.Artifact getSkinArtifactFromRepository(org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Skin skin) throws SiteToolException Get a skin artifact from one of the repositories.- Specified by:
getSkinArtifactFromRepository
in interfaceSiteTool
- Parameters:
repoSession
- the repository system session, not null.remoteProjectRepositories
- the Maven remote project repositories, not null.skin
- the Skin model, not null.- Returns:
- the
Skin
artifact defined in aSiteModel
from a given project - Throws:
SiteToolException
- if any
-
getRelativePath
Deprecated.This method is not implemented according to the URI specification and has many weird corner cases where it doesn't do the right thing. Please consider using a better implemented method from a different library such as org.apache.http.client.utils.URIUtils#resolve.- Specified by:
getRelativePath
in interfaceSiteTool
- Parameters:
to
- theto
url of file as stringfrom
- thefrom
url of file as string- Returns:
- a relative path from
from
toto
.
-
getRelativeFilePath
-
getSiteDescriptor
Get a site descriptor from the project's site directory.- Specified by:
getSiteDescriptor
in interfaceSiteTool
- Parameters:
siteDirectory
- the site directory, not nulllocale
- the locale wanted for the site descriptor, not null. Most specific to least specific lookup fromsite_language_country_variant.xml
,site_language_country.xml
,site_language.xml}
, tosite.xml
as last resort forLocale.ROOT
, if provided locale defines a variant and/or a country and/or a language.- Returns:
- the most specific site descriptor file for the given locale
-
getSiteDescriptorFromRepository
File getSiteDescriptorFromRepository(org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Locale locale) throws SiteToolException Get a site descriptor from one of the repositories.- Parameters:
project
- the Maven project, not null.repoSession
- the repository system session, not null.remoteProjectRepositories
- the Maven remote project repositories, not null.locale
- the locale wanted for the site descriptor, not null. SeegetSiteDescriptor(File, Locale)
for details.- Returns:
- the site descriptor into the local repository after download of it from repositories or null if not found in repositories.
- Throws:
SiteToolException
- if any
-
getSiteModel
public SiteModel getSiteModel(File siteDirectory, Locale locale, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) throws SiteToolException Get a site model for a project.- Specified by:
getSiteModel
in interfaceSiteTool
- Parameters:
siteDirectory
- the site directory, may be null if project from repositorylocale
- the locale used for the i18n in SiteModel, not null. SeeSiteTool.getSiteDescriptor(File, Locale)
for details.project
- the Maven project, not null.reactorProjects
- the Maven reactor projects, not null.repoSession
- the repository system session, not null.remoteProjectRepositories
- the Maven remote project repositories, not null.- Returns:
- the
SiteModel
object corresponding to thesite.xml
file with some interpolations. - Throws:
SiteToolException
- if any
-
getInterpolatedSiteDescriptorContent
public String getInterpolatedSiteDescriptorContent(Map<String, String> props, org.apache.maven.project.MavenProject aProject, String siteDescriptorContent) throws SiteToolExceptionInterpolating several expressions in the site descriptor content. Actually, the expressions can be in the project, the environment variables and the specific properties likeencoding
.For instance:
- ${project.name}
- The value from the POM of:
<project>
<name>myProjectName</name>
</project> - ${my.value}
- The value from the POM of:
<properties>
<my.value>hello</my.value>
</properties> - ${JAVA_HOME}
- The value of JAVA_HOME in the environment variables
- Specified by:
getInterpolatedSiteDescriptorContent
in interfaceSiteTool
- Parameters:
props
- a map used for interpolation, not null.aProject
- a Maven project, not null.siteDescriptorContent
- the site descriptor file, not null.- Returns:
- the interpolated site descriptor content.
- Throws:
SiteToolException
- if errors happened during the interpolation.
-
getInterpolatedSiteDescriptorContent
private String getInterpolatedSiteDescriptorContent(org.apache.maven.project.MavenProject aProject, String siteDescriptorContent, boolean isEarly) throws SiteToolException - Throws:
SiteToolException
-
populateParentMenu
private void populateParentMenu(SiteModel siteModel, Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.project.MavenProject parentProject, boolean keepInheritedRefs) Populate the pre-definedparent
menu of the site model, if used through<menu ref="parent"/>
.- Parameters:
siteModel
- the Doxia Sitetools SiteModel, not null.locale
- the locale used for the i18n in SiteModel, not null.project
- a Maven project, not null.parentProject
- a Maven parent project, not null.keepInheritedRefs
- used for inherited references.
-
populateModulesMenu
private void populateModulesMenu(SiteModel siteModel, Locale locale, org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, boolean keepInheritedRefs) throws SiteToolException, IOException Populate the pre-definedmodules
menu of the model, if used through<menu ref="modules"/>
.- Parameters:
siteModel
- the Doxia Sitetools SiteModel, not null.locale
- the locale used for the i18n in SiteModel, not null.project
- a Maven project, not null.reactorProjects
- the Maven reactor projects, not null.keepInheritedRefs
- used for inherited references.- Throws:
SiteToolException
- if anyIOException
-
getModuleFromReactor
private org.apache.maven.project.MavenProject getModuleFromReactor(org.apache.maven.project.MavenProject project, List<org.apache.maven.project.MavenProject> reactorProjects, String module) throws IOException - Throws:
IOException
-
populateReportsMenu
public void populateReportsMenu(SiteModel siteModel, Locale locale, Map<String, List<org.apache.maven.reporting.MavenReport>> categories) Populate the pre-definedreports
menu of the site model, if used through<menu ref="reports"/>
. Notice this menu reference is translated into 2 separate menus: "Project Information" and "Project Reports".- Specified by:
populateReportsMenu
in interfaceSiteTool
- Parameters:
siteModel
- the Doxia Sitetools SiteModel, not null.locale
- the locale used for the i18n in SiteModel, not null. SeeSiteTool.getSiteDescriptor(File, Locale)
for details.categories
- reports per category to put in "Reports" or "Information" menus, not null.- See Also:
-
getSiteLocales
Extracts from a comma-separated list the locales that are available insite-tool
resource bundle.- Specified by:
getSiteLocales
in interfaceSiteTool
- Parameters:
locales
- A comma separated list of locales- Returns:
- a list of
Locale
s.
-
codeToLocale
Converts a locale code like "en", "en_US" or "en_US_win" to ajava.util.Locale
object.If localeCode =
system
, return the current value of the default locale for this instance of the Java Virtual Machine.If localeCode =
default
, return the root locale.- Parameters:
localeCode
- the locale code string.- Returns:
- a java.util.Locale object instanced or null if errors occurred
- See Also:
-
getNormalizedPath
- Parameters:
path
- could be null.- Returns:
- the path normalized, i.e. by eliminating "/../" and "/./" in the path.
- See Also:
-
createSiteDescriptorArtifactRequest
private org.eclipse.aether.resolution.ArtifactRequest createSiteDescriptorArtifactRequest(org.apache.maven.project.MavenProject project, String localeStr, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) - Parameters:
project
- not nulllocaleStr
- not nullremoteProjectRepositories
- not null- Returns:
- the site descriptor artifact request
-
resolveSiteDescriptor
private File resolveSiteDescriptor(org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories, Locale locale) throws org.eclipse.aether.resolution.ArtifactResolutionException - Parameters:
project
- not nullrepoSession
- the repository system session not nullremoteProjectRepositories
- not nulllocale
- not null- Returns:
- the resolved site descriptor or null if not found in repositories.
- Throws:
org.eclipse.aether.resolution.ArtifactResolutionException
- if any
-
deletePseudoSiteDescriptorMarkerFile
private void deletePseudoSiteDescriptorMarkerFile(org.eclipse.aether.RepositorySystemSession repoSession, org.eclipse.aether.resolution.ArtifactRequest request) -
getSiteModel
private Map.Entry<SiteModel,org.apache.maven.project.MavenProject> getSiteModel(int depth, File siteDirectory, Locale locale, org.apache.maven.project.MavenProject project, org.eclipse.aether.RepositorySystemSession repoSession, List<org.eclipse.aether.repository.RemoteRepository> remoteProjectRepositories) throws SiteToolException - Parameters:
depth
- depth of projectsiteDirectory
- , can be null if project.basedir is null, ie POM from repositorylocale
- not nullproject
- not nullrepoSession
- not nullremoteProjectRepositories
- not null- Returns:
- the site model depending the locale and the parent project
- Throws:
SiteToolException
- if any
-
readSiteModel
private SiteModel readSiteModel(String siteDescriptorContent, org.apache.maven.project.MavenProject project, Locale locale) throws SiteToolException - Parameters:
siteDescriptorContent
- not null- Returns:
- the site model object
- Throws:
SiteToolException
- if any
-
convertOldToNewSiteModel
-
convertBanner
-
convertImage
-
convertLinkItem
-
convertMenuItems
-
isOldSiteModel
private boolean isOldSiteModel(String siteDescriptorContent) throws org.codehaus.plexus.util.xml.pull.XmlPullParserException, IOException - Throws:
org.codehaus.plexus.util.xml.pull.XmlPullParserException
IOException
-
getDefaultSiteModel
- Throws:
SiteToolException
-
siteModelToString
- Throws:
SiteToolException
-
buildRelativePath
-
appendMenuItem
private void appendMenuItem(org.apache.maven.project.MavenProject project, Menu menu, String name, String href, String defaultHref) - Parameters:
project
- not nullmenu
- not nullname
- not nullhref
- could be nulldefaultHref
- could be null
-
createCategoryMenu
private MenuItem createCategoryMenu(String name, String href, List<org.apache.maven.reporting.MavenReport> categoryReports, Locale locale) - Parameters:
name
- not nullhref
- not nullcategoryReports
- not nulllocale
- not null- Returns:
- the menu item object
-
isEmptyList
Convenience method.- Parameters:
list
- could be null- Returns:
- true if the list is
null
or empty
-
getDistMgmntSiteUrl
Return distributionManagement.site.url if defined, null otherwise.- Parameters:
project
- not null- Returns:
- could be null
-
getDistMgmntSiteUrl
-
getPlugin
private static org.apache.maven.model.Plugin getPlugin(org.apache.maven.project.MavenProject project, String pluginId) - Parameters:
project
- the projectpluginId
- The id of the plugin- Returns:
- The information about the plugin.
-
getPluginParameter
private static String getPluginParameter(org.apache.maven.project.MavenProject project, String pluginId, String param) - Parameters:
project
- the projectpluginId
- The pluginIdparam
- The child which should be checked.- Returns:
- The value of the dom tree.
-
urlEncode
-