Package org.bsc.mojo

Class AbstractBaseConfluenceMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.bsc.mojo.AbstractBaseConfluenceMojo

All Implemented Interfaces:

org.bsc.AsyncFunctionDefinition

Direct Known Subclasses:

AbstractBaseConfluenceSiteMojo, ConfluenceBlogpostMojo, ConfluenceExportMojo

public abstract class AbstractBaseConfluenceMojo
extends org.apache.maven.plugin.AbstractMojo
implements org.bsc.AsyncFunctionDefinition

Author:

bsorrentino

Nested Class Summary

Nested classes/interfaces inherited from interface org.bsc.AsyncFunctionDefinition

org.bsc.AsyncFunctionDefinition.AsyncFunc<T extends java.lang.Object,R extends java.lang.Object>, org.bsc.AsyncFunctionDefinition.AsyncPageFunc<T extends java.lang.Object>, org.bsc.AsyncFunctionDefinition.AsyncPageSupplier, org.bsc.AsyncFunctionDefinition.AsyncProcessPageFunc, org.bsc.AsyncFunctionDefinition.AsyncSupplier<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.maven.settings.Settings	mavenSettings
protected boolean	skip	Skip plugin execution
protected org.bsc.ssl.SSLCertificateInfo	sslCertificate	if using a https url, configure if the plugin accepts every certifactes or respects hostnameVerifierClass and trustManagerClass (if set).

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractBaseConfluenceMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Perform whatever build-process behavior this Mojo implements.
abstract void	execute(org.bsc.confluence.ConfluenceService confluenceService)
java.lang.String	getEndPoint()
java.util.Map<java.lang.String,java.lang.String>	getHttpHeaders()
java.lang.String	getPassword()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getSpaceKey()
java.lang.String	getUsername()
boolean	isFailOnError()	Indicates whether the build will continue even if there are clean errors.
protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page>	loadParentPage(org.bsc.confluence.ConfluenceService confluence, java.util.Optional<org.bsc.confluence.model.Site> site)
protected java.lang.RuntimeException	RTE(java.lang.String message, java.lang.Object... args)
protected <T> T	throwRTE(java.lang.String message, java.lang.Object... args)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

skip

@Parameter(defaultValue="false")
protected boolean skip

Skip plugin execution

Since:

5.1

mavenSettings

@Parameter(readonly=true,
           property="settings")
protected org.apache.maven.settings.Settings mavenSettings

Since:

3.1.1

sslCertificate

@Parameter
protected org.bsc.ssl.SSLCertificateInfo sslCertificate

if using a https url, configure if the plugin accepts every certifactes or respects hostnameVerifierClass and trustManagerClass (if set). Below the Template

 <sslCertificate>
  <ignore>true|false  <!-- default: false -->
  <hostNameVerifierClass>FQN  <!-- default: null -->
  <trustManagerClass>FQN <!-- default: null -->
 </sslCertificate>

 

Since:

4.1.0

Constructor Detail

AbstractBaseConfluenceMojo

public AbstractBaseConfluenceMojo()

Method Detail

isFailOnError

public boolean isFailOnError()

Indicates whether the build will continue even if there are clean errors.

Returns:

true if build have to fail on error, otherwise false

getEndPoint

public final java.lang.String getEndPoint()

getSpaceKey

public final java.lang.String getSpaceKey()

getUsername

public final java.lang.String getUsername()

getPassword

public final java.lang.String getPassword()

getHttpHeaders

public final java.util.Map<java.lang.String,java.lang.String> getHttpHeaders()

getProperties

public final java.util.Map<java.lang.String,java.lang.String> getProperties()

loadParentPage

protected java.util.concurrent.CompletableFuture<org.bsc.confluence.ConfluenceService.Model.Page> loadParentPage(org.bsc.confluence.ConfluenceService confluence,
                                                                                                                 java.util.Optional<org.bsc.confluence.model.Site> site)

Parameters:

confluence -

Returns:

Throws:

org.apache.maven.plugin.MojoExecutionException

RTE

protected java.lang.RuntimeException RTE(java.lang.String message,
                                         java.lang.Object... args)

throwRTE

protected <T> T throwRTE(java.lang.String message,
                         java.lang.Object... args)

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Perform whatever build-process behavior this Mojo implements.
This is the main trigger for the Mojo inside the Maven system, and allows the Mojo to communicate errors.

Throws:

org.apache.maven.plugin.MojoExecutionException - if an unexpected problem occurs. Throwing this exception causes a "BUILD ERROR" message to be displayed.

org.apache.maven.plugin.MojoFailureException - if an expected problem (such as a compilation failure) occurs. Throwing this exception causes a "BUILD FAILURE" message to be displayed.

execute

public abstract void execute(org.bsc.confluence.ConfluenceService confluenceService)
                      throws java.lang.Exception

Throws:

java.lang.Exception