com.northconcepts.datapipeline.jira.JiraProjectReader

public class JiraProjectReader extends JiraReader

Reads Jira projects from based on the API user's permission.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

JiraProjectReader.OrderByField

The fields a JiraProjectReader can order projects by.

static enum

JiraProjectReader.SortDirection

The direction a JiraProjectReader sorts projects in; DEFAULT adds no direction prefix.

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

Description

JiraProjectReader(String domain, String username, String apiKey)

Creates a reader for the projects of the Jira site at the domain base URL.
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

protected Record

getIssuesRecord()

Fetches the next page as a record with an isLast flag and the item array (named values unless changed by JiraReader.setRecordsFieldName(String)), or returns null to end the read.

JiraProjectReader.OrderByField

getOrderByField()

Indicates the returned issue sort order.

String

getQuery()

Indicates the case-insensitive search filter.

JiraProjectReader.SortDirection

getSortDirection()

Returns the direction applied to the order-by field (defaults to JiraProjectReader.SortDirection.DEFAULT).

JiraProjectReader

setOrderByField(JiraProjectReader.OrderByField orderByField)

Indicates the returned issue sort order.

JiraProjectReader

setQuery(String query)

Indicates the case-insensitive search filter.

JiraProjectReader

setSortDirection(JiraProjectReader.SortDirection sortDirection)

Sets the direction applied to the order-by field; null means JiraProjectReader.SortDirection.DEFAULT.

Methods inherited from class com.northconcepts.datapipeline.jira.JiraReader
close, getBatchSize, getClient, getMaxItems, getPageOffset, getTotalItems, open, readImpl, readNextBatch, setBatchSize, setIssuesRecord, 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 Details
- JiraProjectReader
  
  public JiraProjectReader(String domain, String username, String apiKey)
  
  Creates a reader for the projects of the Jira site at the domain base URL.
Method Details
- getOrderByField
  
  public JiraProjectReader.OrderByField getOrderByField()
  
  Indicates the returned issue sort order.
- setOrderByField
  
  public JiraProjectReader setOrderByField(JiraProjectReader.OrderByField orderByField)
  
  Indicates the returned issue sort order.
- getSortDirection
  
  public JiraProjectReader.SortDirection getSortDirection()
  
  Returns the direction applied to the order-by field (defaults to JiraProjectReader.SortDirection.DEFAULT).
- setSortDirection
  
  public JiraProjectReader setSortDirection(JiraProjectReader.SortDirection sortDirection)
  
  Sets the direction applied to the order-by field; null means JiraProjectReader.SortDirection.DEFAULT.
- getQuery
  
  public String getQuery()
  
  Indicates the case-insensitive search filter.
- setQuery
  
  public JiraProjectReader setQuery(String query)
  
  Indicates the case-insensitive search filter.
- getIssuesRecord
  
  protected Record getIssuesRecord()
  
  Description copied from class: JiraReader
  
  Fetches the next page as a record with an isLast flag and the item array (named values unless changed by JiraReader.setRecordsFieldName(String)), or returns null to end the read.
  
  Specified by:
  
  getIssuesRecord 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

Class JiraProjectReader

Nested Class Summary

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

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

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

Methods inherited from class java.lang.Object

Constructor Details

JiraProjectReader

Method Details

getOrderByField

setOrderByField

getSortDirection

setSortDirection

getQuery

setQuery

getIssuesRecord

addExceptionProperties