org.digitalmediaserver.crowdin

Class FetchCrowdinMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.digitalmediaserver.crowdin.AbstractCrowdinMojo

org.digitalmediaserver.crowdin.FetchCrowdinMojo

All Implemented Interfaces:

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

@Mojo(name="fetch",
      defaultPhase=NONE)
public class FetchCrowdinMojo
extends AbstractCrowdinMojo

Downloads the translations files to the intermediary AbstractCrowdinMojo.downloadFolder.

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	buildTimeout The number of seconds to wait for builds to complete
protected boolean	exportApprovedOnly Only texts that are both translated and approved will be included in the exported translation files.
protected boolean	skipUntranslatedFiles Only translated files will be included in the exported translation files.
protected boolean	skipUntranslatedStrings Only translated strings will be included in the exported translation files.

Fields inherited from class org.digitalmediaserver.crowdin.AbstractCrowdinMojo

client, comment, crowdinServerId, disableBranches, downloadFolder, downloadFolderPath, gitBaseFolder, httpTimeout, lineSeparator, mavenSession, project, projectId, rootBranch, server, statusFiles, translationFileSets

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

ROLE

Constructor Summary

Constructors

Constructor and Description
FetchCrowdinMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected BuildInfo	buildTranslations(BranchInfo branch, String token) Requests a new build at Crowdin and returns the resulting BuildInfo.
void	doExecute() Performs the task of this Mojo.
protected void	downloadStatusFile() Downloads the translations status file to the intermediary AbstractCrowdinMojo.downloadFolder.
void	execute()
protected void	initializeServer() Initializes AbstractCrowdinMojo.server by retrieving the appropriate Server instance from the Maven settings and validating its settings.
protected void	setBuildTimeout(Integer buildTimeout) Sets the buildTimeout value.
protected void	setExportApprovedOnly(boolean value) Sets the exportApprovedOnly value.
protected void	setSkipUntranslatedFiles(boolean value) Sets the skipUntranslatedFiles value.
protected void	setSkipUntranslatedStrings(boolean value) Sets the skipUntranslatedStrings value.
BuildInfo	waitForBuild(BuildInfo build, long pollIntervalMS, long timeoutMS, String token, org.apache.maven.plugin.logging.Log logger) Polls Crowdin for the status of the specified build until the build is either completed or failed.

Methods inherited from class org.digitalmediaserver.crowdin.AbstractCrowdinMojo

cleanDownloadFolder, createClient, getBranch, getBranch, getPluginVersion, initializeParameters, setClient, setComment, setCrowdinServerId, setDisableBranches, setDownloadFolder, setDownloadFolder, setGitBaseFolder, setHTTPTimeout, setLineSeparator, setProject, setProjectId, setRootBranch, setServer, setStatusFiles, setTranslationFileSets

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

skipUntranslatedStrings

@Parameter(property="skipUntranslatedStrings",
           defaultValue="true")
protected boolean skipUntranslatedStrings

Only translated strings will be included in the exported translation files. This option is not applied to text documents: *.docx, *.pptx, *.xlsx, etc., since missing texts may cause the resulting files to be unreadable.

Note: This parameter cannot be true if skipUntranslatedFiles is true.

skipUntranslatedFiles

@Parameter(property="skipUntranslatedFiles",
           defaultValue="false")
protected boolean skipUntranslatedFiles

Only translated files will be included in the exported translation files.

Note: This parameter cannot be true if skipUntranslatedStrings is true.

exportApprovedOnly

@Parameter(property="exportApprovedOnly",
           defaultValue="false")
protected boolean exportApprovedOnly

Only texts that are both translated and approved will be included in the exported translation files. This will require additional efforts from your proofreaders to approve all suggestions.

buildTimeout

@Parameter(property="buildTimeout",
           defaultValue="60")
protected Integer buildTimeout

The number of seconds to wait for builds to complete

Constructor Detail

FetchCrowdinMojo

public FetchCrowdinMojo()

Method Detail

setSkipUntranslatedStrings

protected void setSkipUntranslatedStrings(boolean value)

Sets the skipUntranslatedStrings value.

Parameters:

value - the value to set.

setSkipUntranslatedFiles

protected void setSkipUntranslatedFiles(boolean value)

Sets the skipUntranslatedFiles value.

Parameters:

value - the value to set.

setExportApprovedOnly

protected void setExportApprovedOnly(boolean value)

Sets the exportApprovedOnly value.

Parameters:

value - the value to set.

setBuildTimeout

protected void setBuildTimeout(@Nonnull
                   Integer buildTimeout)

Sets the buildTimeout value.

Parameters:

buildTimeout - the build timeout in seconds to set.

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

doExecute

public void doExecute()
               throws org.apache.maven.plugin.MojoExecutionException

Performs the task of this Mojo.

Throws:

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

buildTranslations

@Nonnull
protected BuildInfo buildTranslations(@Nullable
                                  BranchInfo branch,
                                  @Nonnull
                                  String token)
                               throws org.apache.maven.plugin.MojoExecutionException

Requests a new build at Crowdin and returns the resulting BuildInfo.

Parameters:

branch - the BranchInfo if building for a branch.

token - the API token.

Returns:

The resulting BuildInfo.

Throws:

org.apache.maven.plugin.MojoExecutionException - If the build fails for some reason.

downloadStatusFile

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

Downloads the translations status file to the intermediary AbstractCrowdinMojo.downloadFolder.

Throws:

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

waitForBuild

@Nonnull
public BuildInfo waitForBuild(@Nonnull
                             BuildInfo build,
                             long pollIntervalMS,
                             long timeoutMS,
                             @Nonnull
                             String token,
                             @Nullable
                             org.apache.maven.plugin.logging.Log logger)
                       throws org.apache.maven.plugin.MojoExecutionException

Polls Crowdin for the status of the specified build until the build is either completed or failed.

Parameters:

build - the BuildInfo for the build to wait for.

pollIntervalMS - the time in milliseconds between each poll.

timeoutMS - the time in milliseconds before abandoning waiting and declaring the build a failure.

token - the API token.

logger - the Log to log to.

Returns:

the BuildInfo with containing the new build status.

Throws:

org.apache.maven.plugin.MojoExecutionException - If the polling fails or the timeout expires.

initializeServer

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

Description copied from class: AbstractCrowdinMojo

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

Overrides:

initializeServer in class AbstractCrowdinMojo

Throws:

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