Package com.sforce.async

Class BulkConnection

java.lang.Object

com.sforce.async.BulkConnection

public class BulkConnection
extends Object

BulkConnection

Since:

160

Author:

mcheenath

Field Summary

Fields

Modifier and Type	Field	Description
static final QName	BATCH_LIST_QNAME
static final QName	BATCH_QNAME
static final String	CSV_CONTENT_TYPE
static final QName	ERROR_QNAME
static final QName	JOB_QNAME
static final String	JSON_CONTENT_TYPE
static final String	NAMESPACE
static final String	SESSION_ID
static final TypeMapper	typeMapper
static final String	XML_CONTENT_TYPE
static final String	ZIP_CSV_CONTENT_TYPE
static final String	ZIP_JSON_CONTENT_TYPE
static final String	ZIP_XML_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
BulkConnection(ConnectorConfig config)

Method Summary

Modifier and Type	Method	Description
JobInfo	abortJob(String jobId)
void	addHeader(String headerName, String headerValue)
URL	buildBatchResultURL(String jobId, String batchId)
URL	buildQueryResultURL(String jobId, String batchId, String resultId)
JobInfo	closeJob(String jobId)
BatchRequest	createBatch(JobInfo job)
BatchInfo	createBatchFromDir(JobInfo job, InputStream batchContent, File attachmentDir)
BatchInfo	createBatchFromForeignCsvStream(JobInfo jobInfo, InputStream input, String charSet)
BatchInfo	createBatchFromStream(JobInfo jobInfo, InputStream input)
BatchInfo	createBatchFromZipStream(JobInfo jobInfo, InputStream zipInput)
BatchInfo	createBatchWithFileAttachments(JobInfo jobInfo, InputStream batchContent, File rootDirectory, String... files)
BatchInfo	createBatchWithFileAttachments(JobInfo jobInfo, InputStream batchContent, Map<String,File> attachedFiles)
BatchInfo	createBatchWithInputStreamAttachments(JobInfo jobInfo, InputStream batchContent, Map<String,InputStream> attachments)
CsvBatchRequest	createCsvBatch(JobInfo job)
JobInfo	createJob(JobInfo job)
JobInfo	createJob(JobInfo job, ContentType contentType)
JobInfo	createJob(String object, String operation)
TransformationSpecRequest	createTransformationSpec(JobInfo job)
void	createTransformationSpecFromStream(JobInfo jobInfo, InputStream input)
BatchInfo	getBatchInfo(String jobId, String batchId)
BatchInfo	getBatchInfo(String jobId, String batchId, ContentType contentType)
BatchInfoList	getBatchInfoList(String jobId)
BatchInfoList	getBatchInfoList(String jobId, ContentType contentType)
InputStream	getBatchRequestInputStream(String jobId, String batchId)
BatchResult	getBatchResult(String jobId, String batchId)
BatchResult	getBatchResult(String jobId, String batchId, ContentType contentType)
InputStream	getBatchResultStream(String jobId, String batchId)
ConnectorConfig	getConfig()
JobInfo	getJobStatus(String jobId)
JobInfo	getJobStatus(String jobId, ContentType contentType)
QueryResultList	getQueryResultList(String jobId, String batchId)
QueryResultList	getQueryResultList(String jobId, String batchId, ContentType contentType)
InputStream	getQueryResultStream(String jobId, String batchId, String resultId)
JobInfo	updateJob(JobInfo job)
JobInfo	updateJob(JobInfo job, ContentType contentType)

Methods inherited from class java.lang.Object

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

Field Details

NAMESPACE

public static final String NAMESPACE

See Also:

• Constant Field Values

SESSION_ID

public static final String SESSION_ID

See Also:

• Constant Field Values

XML_CONTENT_TYPE

public static final String XML_CONTENT_TYPE

See Also:

• Constant Field Values

CSV_CONTENT_TYPE

public static final String CSV_CONTENT_TYPE

See Also:

• Constant Field Values

JSON_CONTENT_TYPE

public static final String JSON_CONTENT_TYPE

See Also:

• Constant Field Values

ZIP_XML_CONTENT_TYPE

public static final String ZIP_XML_CONTENT_TYPE

See Also:

• Constant Field Values

ZIP_CSV_CONTENT_TYPE

public static final String ZIP_CSV_CONTENT_TYPE

See Also:

• Constant Field Values

ZIP_JSON_CONTENT_TYPE

public static final String ZIP_JSON_CONTENT_TYPE

See Also:

• Constant Field Values

JOB_QNAME

public static final QName JOB_QNAME

BATCH_QNAME

public static final QName BATCH_QNAME

BATCH_LIST_QNAME

public static final QName BATCH_LIST_QNAME

ERROR_QNAME

public static final QName ERROR_QNAME

typeMapper

public static final TypeMapper typeMapper

Constructor Details

BulkConnection

public BulkConnection(ConnectorConfig config)
               throws AsyncApiException

Throws:

AsyncApiException

Method Details

createJob

public JobInfo createJob(String object,
 String operation)
                  throws AsyncApiException

Throws:

AsyncApiException

createJob

public JobInfo createJob(JobInfo job)
                  throws AsyncApiException

Throws:

AsyncApiException

createJob

public JobInfo createJob(JobInfo job,
 ContentType contentType)
                  throws AsyncApiException

Throws:

AsyncApiException

addHeader

public void addHeader(String headerName,
 String headerValue)

createBatchFromStream

public BatchInfo createBatchFromStream(JobInfo jobInfo,
 InputStream input)
                                throws AsyncApiException

Throws:

AsyncApiException

createBatchFromZipStream

public BatchInfo createBatchFromZipStream(JobInfo jobInfo,
 InputStream zipInput)
                                   throws AsyncApiException

Throws:

AsyncApiException

createBatchFromDir

public BatchInfo createBatchFromDir(JobInfo job,
 InputStream batchContent,
 File attachmentDir)
                             throws AsyncApiException

Throws:

AsyncApiException

createBatchWithFileAttachments

public BatchInfo createBatchWithFileAttachments(JobInfo jobInfo,
 InputStream batchContent,
 File rootDirectory,
 String... files)
                                         throws AsyncApiException

Throws:

AsyncApiException

createBatchWithFileAttachments

public BatchInfo createBatchWithFileAttachments(JobInfo jobInfo,
 InputStream batchContent,
 Map<String,File> attachedFiles)
                                         throws AsyncApiException

Throws:

AsyncApiException

createBatchWithInputStreamAttachments

public BatchInfo createBatchWithInputStreamAttachments(JobInfo jobInfo,
 InputStream batchContent,
 Map<String,InputStream> attachments)
                                                throws AsyncApiException

Parameters:

jobInfo - Parent job for new batch.

batchContent - InputStream containing the xml or csv content of the batch, or null only if request.txt is contained in attachments map

attachments - Map of attachments where the key is the filename to be used in the zip file and the value is the InputStream representing that file.

Returns:

BatchInfo of uploaded batch.

Throws:

AsyncApiException

createBatchFromForeignCsvStream

public BatchInfo createBatchFromForeignCsvStream(JobInfo jobInfo,
 InputStream input,
 String charSet)
                                          throws AsyncApiException

Throws:

AsyncApiException

createTransformationSpecFromStream

public void createTransformationSpecFromStream(JobInfo jobInfo,
 InputStream input)
                                        throws AsyncApiException

Throws:

AsyncApiException

createBatch

public BatchRequest createBatch(JobInfo job)
                         throws AsyncApiException

Throws:

AsyncApiException

createCsvBatch

public CsvBatchRequest createCsvBatch(JobInfo job)
                               throws AsyncApiException

Throws:

AsyncApiException

createTransformationSpec

public TransformationSpecRequest createTransformationSpec(JobInfo job)
                                                   throws AsyncApiException

Throws:

AsyncApiException

getBatchInfoList

public BatchInfoList getBatchInfoList(String jobId)
                               throws AsyncApiException

Throws:

AsyncApiException

getBatchInfoList

public BatchInfoList getBatchInfoList(String jobId,
 ContentType contentType)
                               throws AsyncApiException

Throws:

AsyncApiException

getBatchInfo

public BatchInfo getBatchInfo(String jobId,
 String batchId)
                       throws AsyncApiException

Throws:

AsyncApiException

getBatchInfo

public BatchInfo getBatchInfo(String jobId,
 String batchId,
 ContentType contentType)
                       throws AsyncApiException

Throws:

AsyncApiException

getBatchResult

public BatchResult getBatchResult(String jobId,
 String batchId)
                           throws AsyncApiException

Throws:

AsyncApiException

getBatchResult

public BatchResult getBatchResult(String jobId,
 String batchId,
 ContentType contentType)
                           throws AsyncApiException

Throws:

AsyncApiException

getBatchResultStream

public InputStream getBatchResultStream(String jobId,
 String batchId)
                                 throws AsyncApiException

Throws:

AsyncApiException

buildBatchResultURL

public URL buildBatchResultURL(String jobId,
 String batchId)
                        throws AsyncApiException

Throws:

AsyncApiException

getBatchRequestInputStream

public InputStream getBatchRequestInputStream(String jobId,
 String batchId)
                                       throws AsyncApiException

Throws:

AsyncApiException

getQueryResultList

public QueryResultList getQueryResultList(String jobId,
 String batchId)
                                   throws AsyncApiException

Throws:

AsyncApiException

getQueryResultList

public QueryResultList getQueryResultList(String jobId,
 String batchId,
 ContentType contentType)
                                   throws AsyncApiException

Throws:

AsyncApiException

getQueryResultStream

public InputStream getQueryResultStream(String jobId,
 String batchId,
 String resultId)
                                 throws AsyncApiException

Throws:

AsyncApiException

buildQueryResultURL

public URL buildQueryResultURL(String jobId,
 String batchId,
 String resultId)
                        throws AsyncApiException

Throws:

AsyncApiException

getJobStatus

public JobInfo getJobStatus(String jobId)
                     throws AsyncApiException

Throws:

AsyncApiException

getJobStatus

public JobInfo getJobStatus(String jobId,
 ContentType contentType)
                     throws AsyncApiException

Throws:

AsyncApiException

abortJob

public JobInfo abortJob(String jobId)
                 throws AsyncApiException

Throws:

AsyncApiException

closeJob

public JobInfo closeJob(String jobId)
                 throws AsyncApiException

Throws:

AsyncApiException

updateJob

public JobInfo updateJob(JobInfo job)
                  throws AsyncApiException

Throws:

AsyncApiException

updateJob

public JobInfo updateJob(JobInfo job,
 ContentType contentType)
                  throws AsyncApiException

Throws:

AsyncApiException

getConfig

public ConnectorConfig getConfig()