org.digitalmediaserver.crowdin

Class AbstractCrowdinMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.digitalmediaserver.crowdin.AbstractCrowdinMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

BuildCrowdinMojo, CleanDownloadsMojo, DeployCrowdinMojo, FetchCrowdinMojo, PullCrowdinMojo, PushCrowdinMojo

public abstract class AbstractCrowdinMojo
extends org.apache.maven.plugin.AbstractMojo

The abstract base class for the Crowdin Mojos.

Author:

Nadahar

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.impl.client.CloseableHttpClient	client The HTTP client
protected String	comment The custom comment header to add to translation files if AbstractFileSet.addComment is true.
protected String	crowdinServerId Server id in settings.xml.
protected File	downloadFolder The folder where the downloaded language files should be placed.
protected Path	downloadFolderPath The folder where the downloaded language files should be places as a Path.
protected String	lineSeparator The string to use as line separator.
protected org.apache.maven.execution.MavenSession	mavenSession The Maven Session object.
protected org.apache.maven.project.MavenProject	project The current Maven project
protected String	rootBranch The git branch that should be treated as root in Crowdin versions management.
protected org.apache.maven.settings.Server	server The Server to use for Crowdin credentials
protected List<StatusFile>	statusFiles A list of StatusFile elements that defines status files.
protected List<TranslationFileSet>	translationFileSets A list of TranslationFileSet elements that defines a set of translation files.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractCrowdinMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	cleanDownloadFolder() Deletes all files and folders in downloadFolder.
protected void	createClient() Initializes client with a new CloseableHttpClient instance unless one has already been created.
protected String	getBranch() Gets the Crowdin branch name that matches the name of the current Git branch.
protected String	getBranch(boolean create, org.jdom2.Document projectDetails) Creates or gets the Crowdin branch name that matches the name of the current Git branch.
protected void	initializeParameters() Initializes the Mojo parameters since they are set via reflection and can't be handled in the constructor.
protected void	initializeServer() Initializes server by retrieving the appropriate Server instance from the Maven settings and validating its settings.
static boolean	isBlank(CharSequence cs) Evaluates if the specified character sequence is null, empty or only consists of whitespace.
protected void	setClient(org.apache.http.impl.client.CloseableHttpClient client) Sets the CloseableHttpClient.
protected void	setComment(String comment) Sets the comment value.
protected void	setCrowdinServerId(String serverId) Sets the crowdinServerId value.
protected void	setDownloadFolder(File folder) Sets the downloadFolder and downloadFolderPath values.
protected void	setDownloadFolder(Path folder) Sets the downloadFolder and downloadFolderPath values.
protected void	setLineSeparator(String lineSeparator) Sets the lineSeparator value.
protected void	setProject(org.apache.maven.project.MavenProject value) Sets the project value.
protected void	setRootBranch(String branch) Sets the rootBranch value.
protected void	setServer(org.apache.maven.settings.Server server) Sets the Server to use for Crowdin credentials.
protected void	setStatusFiles(List<StatusFile> statusFiles) Sets the StatusFiles.
protected void	setTranslationFileSets(List<TranslationFileSet> translationFileSets) Sets the TranslationFileSets.

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

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

execute

Field Detail

mavenSession

protected org.apache.maven.execution.MavenSession mavenSession

The Maven Session object.

Is readonly.

Is defined by:

default-value:

${session}

Is required.

project

protected org.apache.maven.project.MavenProject project

The current Maven project

Is readonly.

Is defined by:

default-value:

${project}

Is required.

downloadFolder

protected File downloadFolder

The folder where the downloaded language files should be placed.

Is defined by:

Is required.

downloadFolderPath

protected Path downloadFolderPath

The folder where the downloaded language files should be places as a Path. Since Maven doesn't seem to be able to handle Path as a parameter, the File downloadFolder is used as an intermediate.

comment

protected String comment

The custom comment header to add to translation files if AbstractFileSet.addComment is true. If not configured, a generic "do not modify" comment will be added.

Is defined by:

lineSeparator

protected String lineSeparator

The string to use as line separator. Specify \n, \r or \r\n as needed. If not specified, the default will be used.

Is defined by:

rootBranch

protected String rootBranch

The git branch that should be treated as root in Crowdin versions management.

Is defined by:

property:

rootBranch

default-value:

master

crowdinServerId

protected String crowdinServerId

Server id in settings.xml. <username> is project identifier, <password> is API key.

Is defined by:

property:

crowdinServerId

Is required.

translationFileSets

protected List<TranslationFileSet> translationFileSets

A list of TranslationFileSet elements that defines a set of translation files.

Is defined by:

Is required.

statusFiles

protected List<StatusFile> statusFiles

A list of StatusFile elements that defines status files.

Is defined by:

Is required.

client

protected org.apache.http.impl.client.CloseableHttpClient client

The HTTP client

server

protected org.apache.maven.settings.Server server

The Server to use for Crowdin credentials

Constructor Detail

AbstractCrowdinMojo

public AbstractCrowdinMojo()

Method Detail

setProject

protected void setProject(org.apache.maven.project.MavenProject value)

Sets the project value.

Parameters:

value - the MavenProject to set.

setDownloadFolder

protected void setDownloadFolder(Path folder)

Sets the downloadFolder and downloadFolderPath values.

Parameters:

folder - the Path representing a folder to set.

setDownloadFolder

protected void setDownloadFolder(File folder)

Sets the downloadFolder and downloadFolderPath values.

Parameters:

folder - the File representing a folder to set.

setComment

protected void setComment(String comment)

Sets the comment value.

Parameters:

comment - the comment to set.

setLineSeparator

protected void setLineSeparator(String lineSeparator)

Sets the lineSeparator value.

Parameters:

lineSeparator - the line-separator to set.

setRootBranch

protected void setRootBranch(String branch)

Sets the rootBranch value.

Parameters:

branch - the Git root branch name.

setCrowdinServerId

protected void setCrowdinServerId(String serverId)

Sets the crowdinServerId value.

Parameters:

serverId - The Maven server id to set.

See Also:

crowdinServerId

setTranslationFileSets

protected void setTranslationFileSets(List<TranslationFileSet> translationFileSets)

Sets the TranslationFileSets.

Parameters:

translationFileSets - the TranslationFileSets to set.

setStatusFiles

protected void setStatusFiles(List<StatusFile> statusFiles)

Sets the StatusFiles.

Parameters:

statusFiles - the StatusFiles to set.

setClient

protected void setClient(org.apache.http.impl.client.CloseableHttpClient client)

Sets the CloseableHttpClient.

Parameters:

client - the CloseableHttpClient to set.

setServer

protected void setServer(org.apache.maven.settings.Server server)

Sets the Server to use for Crowdin credentials.

Parameters:

server - the Server to set.

initializeServer

protected void initializeServer()
                         throws org.apache.maven.plugin.MojoExecutionException

Initializes server by retrieving the appropriate Server instance from the Maven settings and validating its settings.

Throws:

org.apache.maven.plugin.MojoExecutionException - If a required parameter is missing or the specified crowdinServerId isn't configured.

createClient

protected void createClient()
                     throws org.apache.maven.plugin.MojoExecutionException

Initializes client with a new CloseableHttpClient instance unless one has already been created.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error occurs during the operation.

initializeParameters

protected void initializeParameters()
                             throws org.apache.maven.plugin.MojoExecutionException

Initializes the Mojo parameters since they are set via reflection and can't be handled in the constructor.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error occurs during initialization.

getBranch

@Nullable
protected String getBranch()
                    throws org.apache.maven.plugin.MojoExecutionException

Gets the Crowdin branch name that matches the name of the current Git branch.

Returns:

The branch name or null if the current git branch is the Crowdin root.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error occurs during the operation.

getBranch

@Nullable
protected String getBranch(boolean create,
                        @Nullable
                        org.jdom2.Document projectDetails)
                    throws org.apache.maven.plugin.MojoExecutionException

Creates or gets the Crowdin branch name that matches the name of the current Git branch.

Parameters:

create - whether the branch should be created at Crowdin if it doesn't exist.

projectDetails - the Document containing the project details. If null the project details will be retrieved from Crowdin.

Returns:

The branch name or null if the current git branch is the Crowdin root.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error occurs during the operation.

cleanDownloadFolder

protected void cleanDownloadFolder()
                            throws org.apache.maven.plugin.MojoExecutionException

Deletes all files and folders in downloadFolder.

Throws:

org.apache.maven.plugin.MojoExecutionException - If an error occurs during the operation.

isBlank

public static boolean isBlank(@Nullable
              CharSequence cs)

Evaluates if the specified character sequence is null, empty or only consists of whitespace.

Parameters:

cs - the CharSequence to evaluate.

Returns:

true if cs is null, empty or only consists of whitespace, false otherwise.