com.marklogic.hub.job

Interface JobManager

All Known Implementing Classes:

JobManagerImpl

public interface JobManager

Handles jobs and their creation, status, and deletion.

Method Summary

Modifier and Type	Method and Description
static JobManager	create(com.marklogic.client.DatabaseClient jobClient, com.marklogic.client.DatabaseClient traceClient) Creates and returns a JobManager object
JobDeleteResponse	deleteJobs(java.lang.String jobIds)
JobExportResponse	exportJobs(java.nio.file.Path exportFilePath, java.lang.String[] jobIds) Export Job documents and their associated Trace documents to a zip file.
void	importJobs(java.nio.file.Path importFilePath) Import Job documents and their associated Trace documents from a zip file.
void	saveJob(Job job) Saves the job to the database
void	saveJob(Job job, com.marklogic.client.Transaction transaction) Saves the job to the database

Method Detail

create

static JobManager create(com.marklogic.client.DatabaseClient jobClient,
                         com.marklogic.client.DatabaseClient traceClient)

Creates and returns a JobManager object

Parameters:

jobClient - the database client that is used to connect to the jobs database

traceClient - the database client that is used to connect to the trace database

Returns:

JobManager object

saveJob

void saveJob(Job job)

Saves the job to the database

Parameters:

job - - the job you want to save

saveJob

void saveJob(Job job,
             com.marklogic.client.Transaction transaction)

Saves the job to the database

Parameters:

job - - the job you want to save

transaction - - the transaction that is to be used to write the job

deleteJobs

JobDeleteResponse deleteJobs(java.lang.String jobIds)

Parameters:

jobIds - comma-separated list of jobIds to delete.

Returns:

comma-separated list of jobIds that were successfully deleted

exportJobs

JobExportResponse exportJobs(java.nio.file.Path exportFilePath,
                             java.lang.String[] jobIds)

Export Job documents and their associated Trace documents to a zip file.

Parameters:

exportFilePath - specifies where the zip file will be written

jobIds - a comma-separated list of jobIds; if null, all will be exported

Returns:

a report of what was exported

importJobs

void importJobs(java.nio.file.Path importFilePath)
         throws java.io.IOException

Import Job documents and their associated Trace documents from a zip file.

Parameters:

importFilePath - specifies where the zip file exists

Throws:

java.io.IOException - if unable to open or read the target input file