com.northconcepts.datapipeline.shopify

Class ShopifyApiReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.internal.lang.IntegrationReader

com.northconcepts.datapipeline.shopify.ShopifyApiReader

Direct Known Subclasses:

ShopifyCustomerReader, ShopifyInventoryItemReader, ShopifyInventoryLevelReader, ShopifyLocationReader, ShopifyOrderReader, ShopifyProductReader

public abstract class ShopifyApiReader
extends IntegrationReader

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
protected ShopifyService	service

Fields inherited from class com.northconcepts.datapipeline.core.DataReader

fieldLineage, recordLineage

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
ShopifyApiReader(String domain, String token)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
int	getBatchSize()
long	getInitialRetryDelay()
int	getMaxRetryCount()
protected String	getNextPageInfo()
protected abstract ArrayValue	getRecordsFromResponse(Record record)
IRetryStrategy	getRetryStrategy()
protected abstract Record	invokeRequest()
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
ShopifyApiReader	setBatchSize(int batchSize)
ShopifyApiReader	setInitialRetryDelay(long initialRetryDelay)
ShopifyApiReader	setMaxRetryCount(int maxRetryCount)
ShopifyApiReader	setRetryStrategy(IRetryStrategy retryStrategy)

Methods inherited from class com.northconcepts.datapipeline.core.DataReader

addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Field Detail

service

protected ShopifyService service

Constructor Detail

ShopifyApiReader

public ShopifyApiReader(String domain,
                        String token)

Method Detail

getBatchSize

public int getBatchSize()

setBatchSize

public ShopifyApiReader setBatchSize(int batchSize)

getRetryStrategy

public IRetryStrategy getRetryStrategy()

setRetryStrategy

public ShopifyApiReader setRetryStrategy(IRetryStrategy retryStrategy)

getMaxRetryCount

public int getMaxRetryCount()

setMaxRetryCount

public ShopifyApiReader setMaxRetryCount(int maxRetryCount)

getInitialRetryDelay

public long getInitialRetryDelay()

setInitialRetryDelay

public ShopifyApiReader setInitialRetryDelay(long initialRetryDelay)

getNextPageInfo

protected String getNextPageInfo()

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class IntegrationReader

Throws:

DataException

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

Throws:

DataException

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable

invokeRequest

protected abstract Record invokeRequest()

getRecordsFromResponse

protected abstract ArrayValue getRecordsFromResponse(Record record)

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class DataReader