com.northconcepts.datapipeline.jira

Class JiraReader

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.jira.JiraReader

Direct Known Subclasses:

JiraEpicReader, JiraIssueReader, JiraProjectReader, JiraSprintReader

public abstract class JiraReader
extends IntegrationReader

Nested Class Summary

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

DataEndpoint.State

Field Summary

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
JiraReader(String domain, String username, String apiKey)

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() Indicates the number of items to retrieve per batch.
protected JiraClient	getClient()
long	getMaxItems() Indicates the maximum number of items to return.
int	getPageOffset() Indicates the first offset to start returning.
long	getTotalItems()
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
protected abstract String	readIssuesJson()
protected boolean	readNextBatch()
JiraReader	setBatchSize(int batchSize) Indicates the number of items to retrieve per batch.
protected void	setIssuesJson(String issuesJson)
JiraReader	setMaxItems(long maxItems) Indicates the maximum number of items to return.
protected JiraReader	setPageOffset(int pageOffset) Indicates the first offset to start returning.
protected JiraReader	setTotalItems(long totalItems)

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

addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getReader, 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

Constructor Detail

JiraReader

public JiraReader(String domain,
                  String username,
                  String apiKey)

Method Detail

readIssuesJson

protected abstract String readIssuesJson()

getPageOffset

public int getPageOffset()

Indicates the first offset to start returning.

setPageOffset

protected JiraReader setPageOffset(int pageOffset)

Indicates the first offset to start returning.

getBatchSize

public int getBatchSize()

Indicates the number of items to retrieve per batch.

setBatchSize

public JiraReader setBatchSize(int batchSize)

Indicates the number of items to retrieve per batch.

getTotalItems

public long getTotalItems()

setTotalItems

protected JiraReader setTotalItems(long totalItems)

getMaxItems

public long getMaxItems()

Indicates the maximum number of items to return.

setMaxItems

public JiraReader setMaxItems(long maxItems)

Indicates the maximum number of items to return.

setIssuesJson

protected void setIssuesJson(String issuesJson)

getClient

protected JiraClient getClient()

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()

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

readNextBatch

protected boolean readNextBatch()

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