Interface IEntityUploader

All Superinterfaces:

IDisposable, IEntity

All Known Subinterfaces:

ICampaignContactUploader, IConsentUploader, IContactProfileUploader, IServiceContactUploader

public interface IEntityUploader
extends IEntity

Base class to upload entities. The upload procedure has three phases: first the data is uploaded to Altitude uCI Server; then a task is created in the Altitude uCI Server to process the uploaded data; and finally the output can be downloaded.

Method Summary

Modifier and Type	Method	Description
void	cancelEntityUploadTask()	Cancels an entity upload task in the Altitude uCI Server.
void	close()	Dispose this object in the IntegrationServer.
String	getDataFileNameInZip()	Data file name in zip file
boolean	getDataIsZip()	Data content is a zip file
EntityUploadMode	getEntityUploadMode()	Operations that are performed when new entities are uploaded.
IEntityUploadResultDownloader	getEntityUploadResultDownloader(int downloaderId)	Gets a contact import preview result downloader.
IEntityUploadResultDownloader[]	getEntityUploadResultDownloaders()	Gets the open contact import preview result downloaders.
EntityUploadTaskData	getEntityUploadTask()	Gets the entity upload task data, previously created by the StartEntityUploaderTask method.
char	getFieldSeparator()	Data record field separator.
int	getId()	Identifier of the EntityUploaderLoader.
String	getNullField()	String that represents a nullfield.
int	getTaskId()	Returns the identifier of the entity upload task created in the Server.
IEntityUploadResultDownloader	newDataFileDownloader()	Creates a downloader used to access the data file.
IEntityUploadResultDownloader	newMappingFileDownloader()	Creates a downloader used to access the mapping file.
IEntityUploadResultDownloader	newRejectedFileDownloader()	Creates a downloader used to access the rejected file.
void	setDataFileNameInZip(String value)	Data file name in zip file
void	setDataIsZip(boolean value)	Data content is a zip file
void	setEntityUploadMode(EntityUploadMode value)	Operations that are performed when new entities are uploaded.
void	setFieldSeparator(char value)	Data record field separator.
void	setNullField(String value)	String that represents a nullfield.
void	startEntityUploadTask()	Starts an entity upload task in the Altitude uCI Server.
IEntityUploadResultDownloader	tryGetEntityUploadResultDownloader(int downloaderId)	Gets an open contact import preview result downloader, or null if it doesn't exist.
void	uploadDataContentBlock(byte[] contentBlock)	Uploads blocks of the data file.
void	uploadMappingContentBlock(byte[] contentBlock)	Uploads blocks of the mapping file.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

cancelEntityUploadTask

void cancelEntityUploadTask()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Cancels an entity upload task in the Altitude uCI Server.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

close

void close()
    throws Exception,
altitude.integrationServer.exceptions.ISException

Dispose this object in the IntegrationServer. The upload task continues to execute in the Altitude uCI Server if already started. This method should be invoked when the application no longer needs it.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDataFileNameInZip

String getDataFileNameInZip()
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Data file name in zip file

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setDataFileNameInZip

void setDataFileNameInZip(String value)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Data file name in zip file

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDataIsZip

boolean getDataIsZip()
              throws Exception,
altitude.integrationServer.exceptions.ISException

Data content is a zip file

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setDataIsZip

void setDataIsZip(boolean value)
           throws Exception,
altitude.integrationServer.exceptions.ISException

Data content is a zip file

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEntityUploadMode

EntityUploadMode getEntityUploadMode()
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Operations that are performed when new entities are uploaded.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setEntityUploadMode

void setEntityUploadMode(EntityUploadMode value)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Operations that are performed when new entities are uploaded.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEntityUploadResultDownloader

IEntityUploadResultDownloader getEntityUploadResultDownloader(int downloaderId)
                                                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a contact import preview result downloader.

Parameters:

downloaderId - Identifier of the downloader.

Returns:

The IEntityUploadResultDownloader downloader.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEntityUploadResultDownloaders

IEntityUploadResultDownloader[] getEntityUploadResultDownloaders()
                                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the open contact import preview result downloaders.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEntityUploadTask

EntityUploadTaskData getEntityUploadTask()
                                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the entity upload task data, previously created by the StartEntityUploaderTask method.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getFieldSeparator

char getFieldSeparator()
                throws Exception,
altitude.integrationServer.exceptions.ISException

Data record field separator. Default value: |

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setFieldSeparator

void setFieldSeparator(char value)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Data record field separator. Default value: |

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getId

int getId()
   throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the EntityUploaderLoader.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNullField

String getNullField()
             throws Exception,
altitude.integrationServer.exceptions.ISException

String that represents a nullfield. Default value: ""

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setNullField

void setNullField(String value)
           throws Exception,
altitude.integrationServer.exceptions.ISException

String that represents a nullfield. Default value: ""

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTaskId

int getTaskId()
       throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the identifier of the entity upload task created in the Server. The identifier of the task can be persisted in order to handle restart application scenario. After a restart, the application can invoke IInstanceManager.GetEntityUploaderByTaskId. If the task has not already started in the Altitude uCI Server Constants.IntNoValue is returned.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newDataFileDownloader

IEntityUploadResultDownloader newDataFileDownloader()
                                             throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a downloader used to access the data file.

Returns:

The created downloader.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newMappingFileDownloader

IEntityUploadResultDownloader newMappingFileDownloader()
                                                throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a downloader used to access the mapping file.

Returns:

The created downloader.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

newRejectedFileDownloader

IEntityUploadResultDownloader newRejectedFileDownloader()
                                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a downloader used to access the rejected file.

Returns:

The created downloader.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

startEntityUploadTask

void startEntityUploadTask()
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Starts an entity upload task in the Altitude uCI Server.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

tryGetEntityUploadResultDownloader

IEntityUploadResultDownloader tryGetEntityUploadResultDownloader(int downloaderId)
                                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets an open contact import preview result downloader, or null if it doesn't exist.

Parameters:

downloaderId - Identifier of the downloader.

Returns:

The IEntityUploadResultDownloader.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

uploadDataContentBlock

void uploadDataContentBlock(byte[] contentBlock)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Uploads blocks of the data file. This method can be invoked several times until an upload task is created with StartEntityUploaderTask.

Parameters:

contentBlock - Content to upload encoded in UTF-8.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

uploadMappingContentBlock

void uploadMappingContentBlock(byte[] contentBlock)
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Uploads blocks of the mapping file. This method can be invoked several times until an upload task is created with StartEntityUploaderTask.

Parameters:

contentBlock - Content to upload encoded in UTF-8.

Throws:

Exception

altitude.integrationServer.exceptions.ISException