org.digitalmediaserver.crowdin.tool

Class CrowdinAPI

java.lang.Object

org.digitalmediaserver.crowdin.tool.CrowdinAPI

public class CrowdinAPI
extends Object

This is a utility class for calling the Crowdin API and related tasks.

Author:

Nadahar

Method Summary

Methods

Modifier and Type	Method and Description
static org.apache.http.impl.client.CloseableHttpClient	createHTTPClient() Creates a new CloseableHttpClient instance.
static org.jdom2.Element	getFiles(org.apache.http.client.HttpClient httpClient, org.apache.maven.settings.Server server, String branch, org.jdom2.Document projectDetails, org.apache.maven.plugin.logging.Log logger) Requests project information including all files and returns the files element.
static org.jdom2.Document	requestGetDocument(org.apache.http.client.HttpClient httpClient, org.apache.maven.settings.Server server, String method, Map<String,String> parameters, org.apache.maven.plugin.logging.Log logger) Makes a GET request to the Crowdin API and returns the result as a Document.
static org.apache.http.HttpResponse	requestPost(org.apache.http.client.HttpClient httpClient, org.apache.maven.settings.Server server, String method, Map<String,String> parameters, org.apache.maven.plugin.logging.Log logger) Makes a POST request to the Crowdin API and returns the HttpResponse.
static org.apache.http.HttpResponse	requestPost(org.apache.http.client.HttpClient httpClient, org.apache.maven.settings.Server server, String method, Map<String,String> parameters, Map<String,File> files, Map<String,String> titles, Map<String,String> patterns, org.apache.maven.plugin.logging.Log logger) Makes a POST request to the Crowdin API and returns the HttpResponse.
static org.jdom2.Document	requestPostDocument(org.apache.http.client.HttpClient httpClient, org.apache.maven.settings.Server server, String method, Map<String,String> parameters, Map<String,File> files, boolean mustSucceed, org.apache.maven.plugin.logging.Log logger) Makes a POST request to the Crowdin API and returns the result as a Document.
static org.jdom2.Document	requestPostDocument(org.apache.http.client.HttpClient httpClient, org.apache.maven.settings.Server server, String method, Map<String,String> parameters, Map<String,File> files, Map<String,String> titles, Map<String,String> patterns, boolean mustSucceed, org.apache.maven.plugin.logging.Log logger) Makes a POST request to the Crowdin API and returns the result as a Document.

Methods inherited from class java.lang.Object

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

Method Detail

createHTTPClient

public static org.apache.http.impl.client.CloseableHttpClient createHTTPClient()
                                                                        throws IOException

Creates a new CloseableHttpClient instance.

Returns:

The new CloseableHttpClient.

Throws:

IOException - If an error occurs during the operation.

getFiles

@Nullable
public static org.jdom2.Element getFiles(@Nonnull
                                  org.apache.http.client.HttpClient httpClient,
                                  @Nonnull
                                  org.apache.maven.settings.Server server,
                                  @Nullable
                                  String branch,
                                  @Nullable
                                  org.jdom2.Document projectDetails,
                                  @Nullable
                                  org.apache.maven.plugin.logging.Log logger)
                                  throws IOException

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:

httpClient - the HttpClient to use.

server - the Server to use for Crowdin credentials.

branch - the branch name.

projectDetails - the project details.

logger - the Log instance to use for logging.

Returns:

The relevant files Element.

Throws:

IOException - If an error occurs during the operation.

requestGetDocument

@Nonnull
public static org.jdom2.Document requestGetDocument(@Nonnull
                                            org.apache.http.client.HttpClient httpClient,
                                            @Nonnull
                                            org.apache.maven.settings.Server server,
                                            @Nonnull
                                            String method,
                                            @Nullable
                                            Map<String,String> parameters,
                                            @Nullable
                                            org.apache.maven.plugin.logging.Log logger)
                                             throws IOException

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

Parameters:

httpClient - the HttpClient to use.

server - the Server to use for Crowdin credentials.

method - the API method to use.

parameters - the Map of API parameters to use.

logger - the Log instance to use for logging.

Returns:

The retrieved Document.

Throws:

IOException - If an error occurs during the operation.

IllegalArgumentException - If method is blank.

requestPostDocument

@Nonnull
public static org.jdom2.Document requestPostDocument(@Nonnull
                                             org.apache.http.client.HttpClient httpClient,
                                             @Nonnull
                                             org.apache.maven.settings.Server server,
                                             @Nonnull
                                             String method,
                                             @Nullable
                                             Map<String,String> parameters,
                                             @Nullable
                                             Map<String,File> files,
                                             boolean mustSucceed,
                                             @Nullable
                                             org.apache.maven.plugin.logging.Log logger)
                                              throws IOException

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

Parameters:

httpClient - the HttpClient to use.

server - the Server to use for Crowdin credentials.

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 IOException if the returned Document contains an error code.

logger - the Log instance to use for logging.

Returns:

The retrieved Document.

Throws:

IOException - If an error occurs during the operation.

IllegalArgumentException - If method is blank.

requestPostDocument

@Nonnull
public static org.jdom2.Document requestPostDocument(@Nonnull
                                             org.apache.http.client.HttpClient httpClient,
                                             @Nonnull
                                             org.apache.maven.settings.Server server,
                                             @Nonnull
                                             String method,
                                             @Nullable
                                             Map<String,String> parameters,
                                             @Nullable
                                             Map<String,File> files,
                                             @Nullable
                                             Map<String,String> titles,
                                             @Nullable
                                             Map<String,String> patterns,
                                             boolean mustSucceed,
                                             @Nullable
                                             org.apache.maven.plugin.logging.Log logger)
                                              throws IOException

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

Parameters:

httpClient - the HttpClient to use.

server - the Server to use for Crowdin credentials.

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 IOException if the returned Document contains an error code.

logger - the Log instance to use for logging.

Returns:

The retrieved Document.

Throws:

IOException - If an error occurs during the operation.

IllegalArgumentException - If method is blank.

requestPost

@Nonnull
public static org.apache.http.HttpResponse requestPost(@Nonnull
                                               org.apache.http.client.HttpClient httpClient,
                                               @Nonnull
                                               org.apache.maven.settings.Server server,
                                               @Nonnull
                                               String method,
                                               @Nullable
                                               Map<String,String> parameters,
                                               @Nullable
                                               org.apache.maven.plugin.logging.Log logger)
                                                throws IOException

Makes a POST request to the Crowdin API and returns the HttpResponse.

Parameters:

httpClient - the HttpClient to use.

server - the Server to use for Crowdin credentials.

method - the API method to use.

parameters - the Map of API parameters to use.

logger - the Log instance to use for logging.

Returns:

The resulting HttpResponse.

Throws:

IOException - If an error occurs during the operation.

IllegalArgumentException - If method is blank.

requestPost

@Nonnull
public static org.apache.http.HttpResponse requestPost(@Nonnull
                                               org.apache.http.client.HttpClient httpClient,
                                               @Nonnull
                                               org.apache.maven.settings.Server server,
                                               @Nonnull
                                               String method,
                                               @Nullable
                                               Map<String,String> parameters,
                                               @Nullable
                                               Map<String,File> files,
                                               @Nullable
                                               Map<String,String> titles,
                                               @Nullable
                                               Map<String,String> patterns,
                                               @Nullable
                                               org.apache.maven.plugin.logging.Log logger)
                                                throws IOException

Makes a POST request to the Crowdin API and returns the HttpResponse.

Parameters:

httpClient - the HttpClient to use.

server - the Server to use for Crowdin credentials.

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.

logger - the Log instance to use for logging.

Returns:

The resulting HttpResponse.

Throws:

IOException - If an error occurs during the operation.

IllegalArgumentException - If method is blank.