.. java:import:: com.fasterxml.jackson.core.type TypeReference .. java:import:: com.fasterxml.jackson.databind ObjectMapper .. java:import:: io.taskmonk.auth OAuthClientCredentials .. java:import:: io.taskmonk.auth TokenResponse .. java:import:: io.taskmonk.http RedirectStrategy .. java:import:: org.apache.commons.io FilenameUtils .. java:import:: org.apache.http HttpHost .. java:import:: org.apache.http HttpResponse .. java:import:: org.apache.http NameValuePair .. java:import:: org.apache.http.client.entity GzipCompressingEntity .. java:import:: org.apache.http.client.entity GzipDecompressingEntity .. java:import:: org.apache.http.client.utils URIBuilder .. java:import:: org.apache.http.entity ContentType .. java:import:: org.apache.http.entity StringEntity .. java:import:: org.apache.http.impl.client CloseableHttpClient .. java:import:: org.apache.http.impl.client HttpClients .. java:import:: org.apache.http.impl.client LaxRedirectStrategy .. java:import:: org.apache.http.impl.nio.client CloseableHttpAsyncClient .. java:import:: org.apache.http.impl.nio.client HttpAsyncClients .. java:import:: org.apache.http.message BasicNameValuePair .. java:import:: org.apache.http.util EntityUtils .. java:import:: org.slf4j Logger .. java:import:: org.slf4j LoggerFactory .. java:import:: java.io ByteArrayOutputStream .. java:import:: java.io File .. java:import:: java.io FileOutputStream .. java:import:: java.io InputStream .. java:import:: java.net URL .. java:import:: java.nio.channels Channels .. java:import:: java.nio.channels ReadableByteChannel .. java:import:: java.nio.file Files .. java:import:: java.util.concurrent Future .. java:import:: java.util.zip GZIPOutputStream TaskMonkClient ============== .. java:package:: io.taskmonk.client :noindex: .. java:type:: public class TaskMonkClient Fields ------ credentials ^^^^^^^^^^^ .. java:field:: OAuthClientCredentials credentials :outertype: TaskMonkClient httpHost ^^^^^^^^ .. java:field:: HttpHost httpHost :outertype: TaskMonkClient proxyHost ^^^^^^^^^ .. java:field:: HttpHost proxyHost :outertype: TaskMonkClient tokenResponse ^^^^^^^^^^^^^ .. java:field:: TokenResponse tokenResponse :outertype: TaskMonkClient Constructors ------------ TaskMonkClient ^^^^^^^^^^^^^^ .. java:constructor:: public TaskMonkClient(String server, OAuthClientCredentials credentials) :outertype: TaskMonkClient TaskMonkClient ^^^^^^^^^^^^^^ .. java:constructor:: public TaskMonkClient(String server, String proxy, OAuthClientCredentials credentials) :outertype: TaskMonkClient Methods ------- addTask ^^^^^^^ .. java:method:: public String addTask(String batchId, Task task) throws Exception :outertype: TaskMonkClient Add an external task :param batchId: :param task: \ :java:ref:`Task`\ - the task to be added :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: task id of the newly created task createBatch ^^^^^^^^^^^ .. java:method:: public String createBatch(String projectId, NewBatchData newBatchData) throws Exception :outertype: TaskMonkClient Create a new batch in an existing project with parameters set :param projectId: project id for the project in which the batch has to be created :param newBatchData: \ :java:ref:`NewBatchData`\ New batch information :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`String`\ returns the id of the batch createBatch ^^^^^^^^^^^ .. java:method:: public String createBatch(String projectId, String batchName) throws Exception :outertype: TaskMonkClient Create a new batch in an existing project :param projectId: . project id for the project in which the batch has to be created :param batchName: . name of the batch to be created :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`String`\ returns the id of the batch deleteBatch ^^^^^^^^^^^ .. java:method:: public Boolean deleteBatch(String batchId) throws Exception :outertype: TaskMonkClient To delete a specific batch :param batchId: - id of the batch :throws Exception: :return: \ :java:ref:`Boolean`\ - returns the deleted batchId editBatch ^^^^^^^^^ .. java:method:: public ApiResponse editBatch(String batchId, String batchName, Integer priority, String comments, List notifications) throws Exception :outertype: TaskMonkClient update the details of an existing batch :param batchId: - id of an existing batch :param batchName: - name of new batch :param priority: - priority of batch :param comments: - comments in new batch :param notifications: - notifications of a new batch :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`ApiResponse`\ - returns the id of the updated batch getBatchOutput ^^^^^^^^^^^^^^ .. java:method:: public void getBatchOutput(String batchId, String outputFormat, String outputPath) throws Exception :outertype: TaskMonkClient Get the batch output in a local file path :param batchId: - batch id of an existing batch :param outputFormat: output format for the file - "CSV" or "Excel" :param outputPath: - path where the output file should be created :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs getBatchOutputDictionary ^^^^^^^^^^^^^^^^^^^^^^^^ .. java:method:: public Page getBatchOutputDictionary(String batchId) throws Exception :outertype: TaskMonkClient Get the batch output as a dictionary . The output is page of tasks. Each task is a Map with the field and its value. :param batchId: :throws Exception: :return: \ :java:ref:`Page`\ A page of task and query params. Default of 500 tasks are returned getBatchOutputDictionary ^^^^^^^^^^^^^^^^^^^^^^^^ .. java:method:: public Page getBatchOutputDictionary(String batchId, TaskQueryParams taskQueryParams) throws Exception :outertype: TaskMonkClient Get the batch output as a dictionary . The output is page of tasks. Each task is a Map with the field and its value. :param batchId: :param taskQueryParams: \ :java:ref:`TaskQueryParams`\ query params for task retrieval :throws Exception: :return: \ :java:ref:`Page`\ A list of tasks with the field and values getBatchStatus ^^^^^^^^^^^^^^ .. java:method:: public BatchStatus getBatchStatus(String batchId) throws Exception :outertype: TaskMonkClient Get the status of the batch :param batchId: - id of the batch :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`BatchStatus`\ - returns the batch status getJobProgress ^^^^^^^^^^^^^^ .. java:method:: public JobProgressResponse getJobProgress(String jobId) throws Exception :outertype: TaskMonkClient Get the progress of a job :param jobId: - job id of the job :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`JobProgressResponse`\ - returns the job progress response getJobProgressBatch ^^^^^^^^^^^^^^^^^^^ .. java:method:: public JobProgressResponse getJobProgressBatch(String batchId) throws Exception :outertype: TaskMonkClient Get the progress of batch :param batchId: - id of the batch :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`JobProgressResponse`\ - returns the job progress response isProcessComplete ^^^^^^^^^^^^^^^^^ .. java:method:: public Boolean isProcessComplete(String batchId) throws Exception :outertype: TaskMonkClient To check if a process is complete :param batchId: - id of the batch :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`Boolean`\ - returns true or false depending on completion of process isUploadComplete ^^^^^^^^^^^^^^^^ .. java:method:: public Boolean isUploadComplete(String batchId) throws Exception :outertype: TaskMonkClient To check if the upload is complete or not :param batchId: - id of the batch :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an intfieldNamesernal server error occurs :return: \ :java:ref:`Boolean`\ - returns true or false depending upon upload status updateBatchState ^^^^^^^^^^^^^^^^ .. java:method:: public ApiResponse updateBatchState(String batchId, BatchState state) throws Exception :outertype: TaskMonkClient update the state for a batch :param batchId: - id of an existing batch :param state: - new state for the String. Allowed - CANCELLED :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`ApiResponse`\ - returns the id of the updated batch uploadTasks ^^^^^^^^^^^ .. java:method:: public TaskImportResponse uploadTasks(String batchName, File file, String projectId) throws Exception :outertype: TaskMonkClient Create a new batch in an existing project and add tasks to it :param batchName: - name of the batch to be created :param file: - file of the tasks to be added :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`TaskImportResponse`\ returns the task import response uploadTasks ^^^^^^^^^^^ .. java:method:: public String uploadTasks(String batchId, List tasks) throws Exception :outertype: TaskMonkClient Add tasks to batch :param batchId: :param tasks: \ :java:ref:`Task`\ list of tasks :throws Exception: :return: Job Id for the import task uploadTasksToBatch ^^^^^^^^^^^^^^^^^^ .. java:method:: public TaskImportResponse uploadTasksToBatch(String batchId, File file) throws Exception :outertype: TaskMonkClient Add tasks to an existing batch :param batchId: - batch id of an existing batch to which the tasks are to be added :param file: - file of the tasks to be added :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`TaskImportResponse`\ - returns the task import response uploadTasksUrl ^^^^^^^^^^^^^^ .. java:method:: public TaskImportResponse uploadTasksUrl(String batchName, String taskUrl, String fileType, String projectId) throws Exception :outertype: TaskMonkClient Create a new batch in an existing project and add tasks to it from an accessible url :param batchName: - name of the batch to be created :param taskUrl: - url of the file from which the tasks will be imported :param fileType: - type of file from which the tasks would be fetched :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`TaskImportResponse`\ - returns the task import response uploadTasksUrlToBatch ^^^^^^^^^^^^^^^^^^^^^ .. java:method:: public TaskImportResponse uploadTasksUrlToBatch(String batchId, String taskUrl, String fileType) throws Exception :outertype: TaskMonkClient Add tasks to an existing batch from an accessible url :param batchId: - batch id of the batch to which the tasks are to be added :param taskUrl: - url of the file from which the tasks would be imported :param fileType: - type of file from which the tasks would be fetched :throws io.taskmonk.clientexceptions.ForbiddenException: if the access is unauthorized :throws io.taskmonk.clientexceptions.NotFoundException: if object not found :throws io.taskmonk.clientexceptions.UnhandledException: if unhandled exception occurs :throws io.taskmonk.clientexceptions.InternalServerError: if an internal server error occurs :return: \ :java:ref:`TaskImportResponse`\ - returns the task import response