com.boomi.connector.api

Interface ObjectData

All Superinterfaces:

TrackedData

All Known Implementing Classes:

SimpleTrackedData

public interface ObjectData
extends TrackedData

TrackedData instance used by operations that accept input documents. Specifically, operations that accept an UpdateRequest. Connector developers should NOT attempt to implement this interface. The implementation is provided by the atom.

Method Summary

Modifier and Type	Method and Description
InputStream	getData() Returns a non-null stream containing the document data passed into the connector shape.
long	getDataSize() Returns the size of the stream containing the document data passed into the connector shape.

Methods inherited from interface com.boomi.connector.api.TrackedData

getDynamicOperationProperties, getDynamicProperties, getLogger, getTrackingId, getUniqueId, getUserDefinedProperties

Method Detail

getData

InputStream getData()

Returns a non-null stream containing the document data passed into the connector shape. This stream MUST be closed by the consumer. Since this stream contains the actual data, it can be very large and should NOT be loaded directly into memory without putting any safeguards in place to limit the amount of memory that can be consumed. This stream can be reset to the beginning if the data needs to be replayed.

getDataSize

long getDataSize()
          throws IOException

Returns the size of the stream containing the document data passed into the connector shape.

Throws:

IOException