com.digitalmediaserver.crowdin

Class AbstractCrowdinMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.digitalmediaserver.crowdin.AbstractCrowdinMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplyCrowdinMojo, BuildCrowdinMojo, FetchCrowdinMojo, PullCrowdinMojo, PushCrowdinMojo

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

The abstract crowdin Mojo base class.

Author:

Nadahar

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	API_URL The crowdin API URL
protected org.apache.maven.wagon.authentication.AuthenticationInfo	authenticationInfo The AuthenticationInfo
protected org.apache.http.impl.client.CloseableHttpClient	client The HTTP client
protected String	crowdinServerId Server id in settings.xml.
protected File	downloadFolder The folder where the downloaded language files should be placed.
protected File	languageFilesFolder The folder where the language files are located in the project.
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 static org.jdom.input.SAXBuilder	SAX_BUILDER The static SAXBuilder instance
protected File	statusFile The file where the translations status/statistics should be stored.
protected org.apache.maven.artifact.manager.WagonManager	wagonManager The Maven Wagon manager to use when obtaining server authentication details.

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 boolean	crowdinContainsBranch(org.jdom.Element files, String branchName) Checks if the given Element contains the specified branch.
protected boolean	crowdinContainsFile(org.jdom.Element files, String fileName) Checks if the given Element contains the specified file.
protected boolean	crowdinContainsFile(org.jdom.Element files, String fileName, boolean folder, boolean branch) Checks if the given Element contains the specified file, folder or branch.
protected boolean	crowdinContainsFolder(org.jdom.Element files, String folderName) Checks if the given Element contains the specified folder.
protected void	crowdinCreateBranch(String branchName) Creates a new branch at crowdin.
protected void	crowdinCreateFolder(String folderName) Creates a new folder at crowdin.
protected org.jdom.Element	crowdinGetBranch(List<org.jdom.Element> items, String branchName) Extracts the branch Element with the given name.
protected org.jdom.Element	crowdinGetFolder(List<org.jdom.Element> items, String folderName) Extracts the folder Element with the given name.
protected org.jdom.Element	crowdinGetFolder(List<org.jdom.Element> items, String folderName, boolean branch) Extracts the folder or branch Element with the given name.
protected boolean	crowdinIsBranch(org.jdom.Element item) Verifies whether a given Element is a crowdin branch.
protected boolean	crowdinIsFolder(org.jdom.Element item) Verifies whether a given Element is a crowdin folder.
protected org.jdom.Document	crowdinRequestAPI(String method, Map<String,String> parameters, Map<String,File> files, boolean mustSucceed) Makes a request to the crowdin API and returns the result as a Document.
protected org.jdom.Document	crowdinRequestAPI(String method, Map<String,String> parameters, Map<String,File> files, Map<String,String> titles, Map<String,String> patterns, boolean mustSucceed) Makes a request to the crowdin API and returns the result as a Document.
void	execute()
protected String	getBranch() Gets the crowdin branch name that matches the name of the current Git branch.
protected String	getBranch(boolean create, org.jdom.Document projectDetails) Creates or gets the crowdin branch name that matches the name of the current Git branch.
protected org.jdom.Element	getCrowdinFiles(String branch, org.jdom.Document projectDetails) Requests project information including all files and returns the files element.
protected String	getMavenId(org.apache.maven.artifact.Artifact artifact) Gets the Maven id from the given Artifact.
protected void	setCrowdinServerId(String serverId) Sets the crowdinServerId value.
protected void	setDownloadFolder(File folder) Sets the downloadFolder value.
protected void	setLanguageFilesFolder(File folder) Sets the languageFilesFolder 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	setStatusFile(File statusFile) Sets the statusFile value.
protected void	setWagonManager(org.apache.maven.artifact.manager.WagonManager wagonManager) Sets the wagonManager value.

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

SAX_BUILDER

protected static final org.jdom.input.SAXBuilder SAX_BUILDER

The static SAXBuilder instance

API_URL

protected static final String API_URL

The crowdin API URL

See Also:

Constant Field Values

project

protected org.apache.maven.project.MavenProject project

The current Maven project

Is required.

Is defined by:

default-value:

${project}

Is readonly.

languageFilesFolder

protected File languageFilesFolder

The folder where the language files are located in the project.

Is required.

Is defined by:

downloadFolder

protected File downloadFolder

The folder where the downloaded language files should be placed.

Is required.

Is defined by:

statusFile

protected File statusFile

The file where the translations status/statistics should be stored.

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

wagonManager

protected org.apache.maven.artifact.manager.WagonManager wagonManager

The Maven Wagon manager to use when obtaining server authentication details.

Is a Plexus component defined by:

role:

org.apache.maven.artifact.manager.WagonManager

crowdinServerId

protected String crowdinServerId

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

Is required.

Is defined by:

property:

crowdinServerId

client

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

The HTTP client

authenticationInfo

protected org.apache.maven.wagon.authentication.AuthenticationInfo authenticationInfo

The AuthenticationInfo

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.

setLanguageFilesFolder

protected void setLanguageFilesFolder(File folder)

Sets the languageFilesFolder value.

Parameters:

folder - the File representing a folder to set.

setDownloadFolder

protected void setDownloadFolder(File folder)

Sets the downloadFolder value.

Parameters:

folder - the File representing a folder to set.

setStatusFile

protected void setStatusFile(File statusFile)

Sets the statusFile value.

Parameters:

statusFile - the status File to set.

setRootBranch

protected void setRootBranch(String branch)

Sets the rootBranch value.

Parameters:

branch - the Git root branch name.

setWagonManager

protected void setWagonManager(org.apache.maven.artifact.manager.WagonManager wagonManager)

Sets the wagonManager value.

Parameters:

wagonManager - the WagonManager to set.

setCrowdinServerId

protected void setCrowdinServerId(String serverId)

Sets the crowdinServerId value.

Parameters:

serverId - The Maven server id to set.

See Also:

crowdinServerId

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

crowdinContainsFile

protected boolean crowdinContainsFile(org.jdom.Element files,
                          String fileName,
                          boolean folder,
                          boolean branch)
                               throws org.apache.maven.plugin.MojoExecutionException

Checks if the given Element contains the specified file, folder or branch.

Parameters:

files - the Element to check.

fileName - the file name to look for.

folder - whether the check is for a folder instead of a file.

branch - whether the check is for a branch instead of a file.

Returns:

true if the file, folder or branch exists in files, false otherwise.

Throws:

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

crowdinContainsFile

protected boolean crowdinContainsFile(org.jdom.Element files,
                          String fileName)
                               throws org.apache.maven.plugin.MojoExecutionException

Checks if the given Element contains the specified file.

Parameters:

files - the Element to check.

fileName - the file name to look for.

Returns:

true if the file exists in files, false otherwise.

Throws:

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

crowdinContainsFolder

protected boolean crowdinContainsFolder(org.jdom.Element files,
                            String folderName)
                                 throws org.apache.maven.plugin.MojoExecutionException

Checks if the given Element contains the specified folder.

Parameters:

files - the Element to check.

folderName - the folder name to look for.

Returns:

true if the folder exists in files, false otherwise.

Throws:

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

crowdinContainsBranch

protected boolean crowdinContainsBranch(org.jdom.Element files,
                            String branchName)
                                 throws org.apache.maven.plugin.MojoExecutionException

Checks if the given Element contains the specified branch.

Parameters:

files - the Element to check.

branchName - the file name to look for.

Returns:

true if the branch exists in files, false otherwise.

Throws:

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

crowdinGetFolder

protected org.jdom.Element crowdinGetFolder(List<org.jdom.Element> items,
                                String folderName)

Extracts the folder Element with the given name.

Parameters:

items - the List of Elements to extract from.

folderName - the folder name.

Returns:

The matching Element or null.

crowdinGetBranch

protected org.jdom.Element crowdinGetBranch(List<org.jdom.Element> items,
                                String branchName)

Extracts the branch Element with the given name.

Parameters:

items - the List of Elements to extract from.

branchName - the branch name.

Returns:

The matching Element or null.

crowdinGetFolder

protected org.jdom.Element crowdinGetFolder(List<org.jdom.Element> items,
                                String folderName,
                                boolean branch)

Extracts the folder or branch Element with the given name.

Parameters:

items - the List of Elements to extract from.

folderName - the branch or folder name.

branch - whether to look for a branch instead of a folder.

Returns:

The matching Element or null.

crowdinIsFolder

protected boolean crowdinIsFolder(org.jdom.Element item)

Verifies whether a given Element is a crowdin folder.

Parameters:

item - the Element to check.

Returns:

true if item is a crowdin folder, false otherwise.

crowdinIsBranch

protected boolean crowdinIsBranch(org.jdom.Element item)

Verifies whether a given Element is a crowdin branch.

Parameters:

item - the Element to check.

Returns:

true if item is a crowdin branch, false otherwise.

crowdinCreateFolder

protected void crowdinCreateFolder(String folderName)
                            throws org.apache.maven.plugin.MojoExecutionException

Creates a new folder at crowdin.

Parameters:

folderName - the name of the new folder.

Throws:

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

crowdinCreateBranch

protected void crowdinCreateBranch(String branchName)
                            throws org.apache.maven.plugin.MojoExecutionException

Creates a new branch at crowdin.

Parameters:

branchName - the name of the new branch.

Throws:

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

crowdinRequestAPI

protected org.jdom.Document crowdinRequestAPI(String method,
                                  Map<String,String> parameters,
                                  Map<String,File> files,
                                  boolean mustSucceed)
                                       throws org.apache.maven.plugin.MojoExecutionException

Makes a request to the crowdin API and returns the result as a Document.

Parameters:

method - the API method to use.

parameters - the Map of API parameters to use.

files - the Map of files to use.

mustSucceed - whether to throw a MojoExecutionException if the returned Document contains an error code.

Returns:

The retrieved Document.

Throws:

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

crowdinRequestAPI

protected org.jdom.Document crowdinRequestAPI(String method,
                                  Map<String,String> parameters,
                                  Map<String,File> files,
                                  Map<String,String> titles,
                                  Map<String,String> patterns,
                                  boolean mustSucceed)
                                       throws org.apache.maven.plugin.MojoExecutionException

Makes a request to the crowdin API and returns the result as a Document.

Parameters:

method - the API method to use.

parameters - the Map of API parameters to use.

files - the Map of files to use.

titles - the Map of titles to use.

patterns - the Map of patterns to use.

mustSucceed - whether to throw a MojoExecutionException if the returned Document contains an error code.

Returns:

The retrieved Document.

Throws:

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

getCrowdinFiles

protected org.jdom.Element getCrowdinFiles(String branch,
                               org.jdom.Document projectDetails)
                                    throws org.apache.maven.plugin.MojoExecutionException

Requests project information including all files and returns the files element. Branch may be null in which case the root files Element is returned.

Parameters:

branch - the branch name.

projectDetails - the project details.

Returns:

The relevant files Element.

Throws:

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

getMavenId

protected String getMavenId(org.apache.maven.artifact.Artifact artifact)

Gets the Maven id from the given Artifact.

Parameters:

artifact - the Artifact whose Maven id to return.

Returns:

The Maven id.

getBranch

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

protected String getBranch(boolean create,
               org.jdom.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.