com.boomi.connector.testutil

Class SimpleTrackedData

java.lang.Object

com.boomi.connector.testutil.SimpleTrackedData

All Implemented Interfaces:

FilterData, ObjectData, ObjectIdData, TrackedData

public class SimpleTrackedData
extends Object
implements TrackedData, ObjectData, ObjectIdData, FilterData

Simple implementation of TrackedData for all necessary data types.

Constructor Summary

Constructors

Constructor and Description
SimpleTrackedData(int id, Object data)
SimpleTrackedData(int id, Object data, Map<String,String> userDefProps)
SimpleTrackedData(int id, Object data, Map<String,String> userDefProps, Map<String,String> dynamicProps)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
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.
Map<String,String>	getDynamicProperties() Returns any dynamic connector properties for this tracked data (always non-null).
QueryFilter	getFilter() Returns a query filter describing the object to be retrieved.
Logger	getLogger() Returns a logger which should be used to log information specific to this tracked data.
String	getObjectId() Returns a non-null object id.
Object	getTrackingId() Returns a "tracking" id for this tracked data.
Object	getUniqueId() Returns a unique id for this tracked data.
Map<String,String>	getUserDefinedProperties() Returns any user-defined properties for this tracked data (always non-null).
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleTrackedData

public SimpleTrackedData(int id,
                         Object data)

SimpleTrackedData

public SimpleTrackedData(int id,
                         Object data,
                         Map<String,String> userDefProps)

SimpleTrackedData

public SimpleTrackedData(int id,
                         Object data,
                         Map<String,String> userDefProps,
                         Map<String,String> dynamicProps)

Method Detail

getUniqueId

public Object getUniqueId()

Description copied from interface: TrackedData

Returns a unique id for this tracked data. The returned object will have valid Object.toString(), Object.hashCode(), and Object.equals(java.lang.Object) method implementations and may therefore be used for things like log statements or Map keys during an operation execution, but may not otherwise be relied upon (the implementations are free to change in future atom implementations).

Specified by:

getUniqueId in interface TrackedData

getTrackingId

public Object getTrackingId()

Description copied from interface: TrackedData

Returns a "tracking" id for this tracked data. This id links this data to data being tracked by the atom (multiple TrackedData instances may be linked to the same tracked document). This value does not uniquely identify this data, and should only be used for things like log statements, and may not otherwise be relied upon (the implementation is free to change in future atom implementations).

Specified by:

getTrackingId in interface TrackedData

getUserDefinedProperties

public Map<String,String> getUserDefinedProperties()

Description copied from interface: TrackedData

Returns any user-defined properties for this tracked data (always non-null). User-defined properties may be set dynamically for each tracked data during process execution.

Specified by:

getUserDefinedProperties in interface TrackedData

getDynamicProperties

public Map<String,String> getDynamicProperties()

Description copied from interface: TrackedData

Returns any dynamic connector properties for this tracked data (always non-null). Dynamic connector properties may be set dynamically for each tracked data during process execution.

Specified by:

getDynamicProperties in interface TrackedData

getLogger

public Logger getLogger()

Description copied from interface: TrackedData

Returns a logger which should be used to log information specific to this tracked data.

Specified by:

getLogger in interface TrackedData

getFilter

public QueryFilter getFilter()

Description copied from interface: FilterData

Returns a query filter describing the object to be retrieved. This may be null (generally in start shapes), indicating that all objects of the relevant request type should be retrieved.

Specified by:

getFilter in interface FilterData

getDataSize

public long getDataSize()
                 throws IOException

Description copied from interface: ObjectData

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

Specified by:

getDataSize in interface ObjectData

Throws:

IOException

getData

public InputStream getData()

Description copied from interface: ObjectData

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.

Specified by:

getData in interface ObjectData

getObjectId

public String getObjectId()

Description copied from interface: ObjectIdData

Returns a non-null object id.

Specified by:

getObjectId in interface ObjectIdData

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object