Package org.bsc.maven.confluence.plugin

Class AbstractConfluenceMojo

    • Field Detail

      • project

        @Parameter(property="project",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project
        Maven Project

      • templateWiki

        @Parameter(defaultValue="${basedir}/src/site/confluence/template.wiki")
protected File templateWiki
        Home page template source. Template name will be used also as template source for children

      • removeSnapshots

        @Parameter(property="confluence.removeSnapshots",
           required=false,
           defaultValue="false")
protected boolean removeSnapshots
        During publish of documentation related to a new release, if it's true, the pages related to SNAPSHOT will be removed

      • childrenTitlesPrefixed

        @Parameter(property="confluence.childrenTitlesPrefixed",
           required=false,
           defaultValue="true")
protected boolean childrenTitlesPrefixed
        prefix child page with the title of the parent
        Since:
        4.9

      • deployState

        @Parameter
protected org.bsc.confluence.DeployStateManager.Parameters deployState
        Experimental feature - Store the last deployed state

        If declared, a local file will be generated that keeps the last update date of all documents involved in publication.
        If such file is present the plugin will check the last update date of each document, skipping it, if no update is detected.

        Example: 
           <deployState>
     <active> true|false </active> ==> default: true
     <outdir> target dir </outdir>  ==> default: ${project.build.directory}
   </deployState>
        Since:
        6.0.0

      • deployStateManager

        protected org.bsc.confluence.DeployStateManager deployStateManager

    • Constructor Detail

      • AbstractConfluenceMojo

        public AbstractConfluenceMojo()

    • Method Detail

      • getChildrenFolder

        protected File getChildrenFolder()

      • getAttachmentFolder

        protected File getAttachmentFolder()

      • getEncoding

        public String getEncoding()
        Returns:

      • setEncoding

        public void setEncoding​(String encoding)
        Parameters:
        encoding -

      • getCharset

        protected final Charset getCharset()
        Returns:

      • getTitle

        protected final String getTitle()
        Returns:

      • setTitle

        public void setTitle​(String title)
        Parameters:
        title -

      • getFileExt

        public String getFileExt()
        Returns:

      • getProject

        public org.apache.maven.project.MavenProject getProject()

      • isRemoveSnapshots

        public boolean isRemoveSnapshots()

      • isSnapshot

        public boolean isSnapshot()

      • isChildrenTitlesPrefixed

        public boolean isChildrenTitlesPrefixed()

      • getPrintableStringForResource

        protected String getPrintableStringForResource​(URI uri)

      • initTemplateProperties

        protected void initTemplateProperties​(org.bsc.confluence.model.Site site)
        initialize properties shared with template

      • addStdProperties

        public void addStdProperties​(biz.source_code.miniTemplator.MiniTemplator t)

      • generateChild

        protected <T extends org.bsc.confluence.model.Site.Page> org.bsc.confluence.ConfluenceService.Model.Page generateChild​(org.bsc.confluence.ConfluenceService confluence,
                                                                                                                       org.bsc.confluence.model.Site site,
                                                                                                                       T child,
                                                                                                                       org.bsc.confluence.ConfluenceService.Model.Page parentPage)
        Parameters:
        site -
        confluence -
        child -
        parentPage -
        Returns: