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:

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, whose <password> is the API token to use.
protected Boolean	disableBranches Disables branches and the reliance on Git
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	gitBaseFolder The Git base folder, if different from Maven project base folder
protected Integer	httpTimeout The HTTP timeout in seconds
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 long	projectId The Project Id, can be found on Crowdin under Tools -> API.
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 BranchInfo	getBranch() Gets the Crowdin branch name that matches the name of the current Git branch.
protected BranchInfo	getBranch(boolean create, List<BranchInfo> branches) Creates or gets the Crowdin branch name that matches the name of the current Git branch.
protected String	getPluginVersion() Retrieves the version of this plugin from Maven's pluginDescriptor.
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.
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	setDisableBranches(Boolean disableBranches) Sets the disableBranches 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	setGitBaseFolder(String gitBaseFolder) Sets the Git base folder.
protected void	setHTTPTimeout(Integer timeout) Sets the HTTP timeout value.
protected void	setLineSeparator(String lineSeparator) Sets the lineSeparator value.
protected void	setProject(org.apache.maven.project.MavenProject value) Sets the project value.
protected void	setProjectId(long projectId) Sets the projectId 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

@Parameter(defaultValue="${session}",
           required=true,
           readonly=true)
protected org.apache.maven.execution.MavenSession mavenSession

The Maven Session object

project

@Parameter(defaultValue="${project}",
           required=true,
           readonly=true)
protected org.apache.maven.project.MavenProject project

The current Maven project

httpTimeout

@Parameter(property="timeout")
protected Integer httpTimeout

The HTTP timeout in seconds

downloadFolder

@Parameter(property="downloadFolder",
           required=true)
protected File downloadFolder

The folder where the downloaded language files should be placed.

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

@Parameter(property="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.

lineSeparator

@Parameter(property="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.

disableBranches

@Parameter(defaultValue="false")
protected Boolean disableBranches

Disables branches and the reliance on Git

gitBaseFolder

@Parameter
protected String gitBaseFolder

The Git base folder, if different from Maven project base folder

rootBranch

@Parameter(property="rootBranch",
           defaultValue="master")
protected String rootBranch

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

crowdinServerId

@Parameter(property="crowdinServerId",
           required=true)
protected String crowdinServerId

Server id in settings.xml, whose <password> is the API token to use.

projectId

@Parameter(property="projectId",
           required=true)
protected long projectId

The Project Id, can be found on Crowdin under Tools -> API.

translationFileSets

@Parameter(property="translationFileSets",
           required=true)
protected List<TranslationFileSet> translationFileSets

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

statusFiles

@Parameter(property="statusFiles",
           required=true)
protected List<StatusFile> statusFiles

A list of StatusFile elements that defines status files.

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.

setHTTPTimeout

protected void setHTTPTimeout(Integer timeout)

Sets the HTTP timeout value.

Parameters:

timeout - the timeout value in seconds.

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.

setDisableBranches

protected void setDisableBranches(Boolean disableBranches)

Sets the disableBranches value.

Parameters:

disableBranches - true to disable branches, false otherwise.

setGitBaseFolder

protected void setGitBaseFolder(String gitBaseFolder)

Sets the Git base folder.

Parameters:

gitBaseFolder - the Git base folder 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

setProjectId

protected void setProjectId(long projectId)

Sets the projectId value.

Parameters:

projectId - the project id to set.

See Also:

projectId

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.

getPluginVersion

protected String getPluginVersion()

Retrieves the version of this plugin from Maven's pluginDescriptor.

Returns:

A String with current version.

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 BranchInfo getBranch()
                        throws org.apache.maven.plugin.MojoExecutionException

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

Returns:

The BranchInfo 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 BranchInfo getBranch(boolean create,
                            @Nullable
                            List<BranchInfo> branches)
                        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.

branches - a List of BranchInfo if it's already possessed, null to make this method retrieve it.

Returns:

The BranchInfo or null if the current git branch is the Crowdin root, or if branches are disabled.

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.