com.northconcepts.datapipeline.jira

Class JiraSprintReader

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

com.northconcepts.datapipeline.jira.JiraSprintReader

public class JiraSprintReader
extends JiraReader

Reads Jira sprints from a board based on the API user's permission.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JiraSprintReader.SprintState

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
JiraSprintReader(String domain, String username, String apiKey, int boardId)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
JiraSprintReader.SprintState	getSprintState() Indicates the state to filter sprints on (default is ACTIVE).
protected String	readIssuesJson()
JiraSprintReader	setSprintState(JiraSprintReader.SprintState sprintState) Indicates the state to filter sprints on (default is ACTIVE).

Methods inherited from class com.northconcepts.datapipeline.jira.JiraReader

close, getBatchSize, getClient, getMaxItems, getPageOffset, getTotalItems, open, readImpl, readNextBatch, setBatchSize, setIssuesJson, setMaxItems, setPageOffset, setRecordsFieldName, setTotalItems

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

JiraSprintReader

public JiraSprintReader(String domain,
                        String username,
                        String apiKey,
                        int boardId)

Method Detail

getSprintState

public JiraSprintReader.SprintState getSprintState()

Indicates the state to filter sprints on (default is ACTIVE).

setSprintState

public JiraSprintReader setSprintState(JiraSprintReader.SprintState sprintState)

Indicates the state to filter sprints on (default is ACTIVE).

readIssuesJson

protected String readIssuesJson()

Specified by:

readIssuesJson in class JiraReader

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 JiraReader