Package io.debezium.ibmi.db2.journal.retrieve

Class RetrieveJournal

java.lang.Object

io.debezium.ibmi.db2.journal.retrieve.RetrieveJournal

public class RetrieveJournal
extends Object

based on the work of Stanley Vong see https://www.ibm.com/docs/en/i/7.5?topic=ssw_ibm_i_75/apis/QJORJRNE.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RetrieveJournal.RetrieveJournalException

Field Summary

Fields

Modifier and Type	Field	Description
private final ParameterListBuilder	builder
(package private) RetrieveConfig	config
private final SimpleDateFormat	dateFormatter
private EntryHeader	entryHeader
private static final EntryHeaderDecoder	entryHeaderDecoder
private static final FirstHeaderDecoder	firstHeaderDecoder
private FirstHeader	header
private final ReceiverPagination	journalReceivers
private static final org.slf4j.Logger	log
private int	offset
private byte[]	outputData
private JournalProcessedPosition	position
private static final RetrievalCriteria.JournalCode[]	REQUIRED_JOURNAL_CODES
private static final RetrievalCriteria.JournalEntryType[]	REQURED_ENTRY_TYPES
private long	totalTransferred

Constructor Summary

Constructors

Constructor	Description
RetrieveJournal(RetrieveConfig config, JournalInfoRetrieval journalRetrieval)

Method Summary

Modifier and Type	Method	Description
private static boolean	alreadyProcessed(JournalProcessedPosition position, EntryHeader entryHeader)
<T> T	decode(JournalEntryDeocder<T> decoder)
void	dumpEntry()
void	dumpEntryToFile(File path)
boolean	futureDataAvailable()
EntryHeader	getEntryHeader()
FirstHeader	getFirstHeader()
private String	getFullAS400MessageText(AS400Message message)
int	getOffset()
JournalProcessedPosition	getPosition()
long	getTotalTransferred()
boolean	hasData()
boolean	nextEntry()
private boolean	reThrowIfFatal(JournalProcessedPosition retrievePosition, ServiceProgramCall spc, JournalProcessedPosition latestJournalPosition, ParameterListBuilder builder)
boolean	retrieveJournal(JournalProcessedPosition previousPosition)	retrieves a block of journal data
boolean	retrieveJournal(JournalProcessedPosition previousPosition, PositionRange range)
void	setOutputData(byte[] b, FirstHeader header, JournalProcessedPosition position)
(package private) boolean	shouldLimitRange()
private void	updateOffsetFromContinuation()
private static void	updatePosition(JournalProcessedPosition p, EntryHeader entryHeader)

Methods inherited from class java.lang.Object

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

Field Details

log

private static final org.slf4j.Logger log

REQUIRED_JOURNAL_CODES

private static final RetrievalCriteria.JournalCode[] REQUIRED_JOURNAL_CODES

REQURED_ENTRY_TYPES

private static final RetrievalCriteria.JournalEntryType[] REQURED_ENTRY_TYPES

firstHeaderDecoder

private static final FirstHeaderDecoder firstHeaderDecoder

entryHeaderDecoder

private static final EntryHeaderDecoder entryHeaderDecoder

dateFormatter

private final SimpleDateFormat dateFormatter

journalReceivers

private final ReceiverPagination journalReceivers

builder

private final ParameterListBuilder builder

config

RetrieveConfig config

outputData

private byte[] outputData

header

private FirstHeader header

entryHeader

private EntryHeader entryHeader

offset

private int offset

position

private JournalProcessedPosition position

totalTransferred

private long totalTransferred

Constructor Details

RetrieveJournal

public RetrieveJournal(RetrieveConfig config,
 JournalInfoRetrieval journalRetrieval)

Method Details

retrieveJournal

public boolean retrieveJournal(JournalProcessedPosition previousPosition)
                        throws Exception

retrieves a block of journal data

Parameters:

previousPosition -

Returns:

true if the journal was read successfully false if there was some problem reading the journal

Throws:

Exception - CURAVLCHN - returns only available journals CURCHAIN will work though journals that have happened but may no longer be available if the journal is no longer available we need to capture this and log an error as we may have missed data

retrieveJournal

public boolean retrieveJournal(JournalProcessedPosition previousPosition,
 PositionRange range)
                        throws Exception

Throws:

Exception

reThrowIfFatal

private boolean reThrowIfFatal(JournalProcessedPosition retrievePosition,
 ServiceProgramCall spc,
 JournalProcessedPosition latestJournalPosition,
 ParameterListBuilder builder)
                        throws InvalidPositionException,
InvalidJournalFilterException,
RetrieveJournal.RetrieveJournalException

Throws:

InvalidPositionException

InvalidJournalFilterException

RetrieveJournal.RetrieveJournalException

shouldLimitRange

boolean shouldLimitRange()

getFullAS400MessageText

private String getFullAS400MessageText(AS400Message message)

getPosition

public JournalProcessedPosition getPosition()

Returns:

the current position or the next offset for fetching data when the end of data is reached

setOutputData

public void setOutputData(byte[] b,
 FirstHeader header,
 JournalProcessedPosition position)

hasData

public boolean hasData()

futureDataAvailable

public boolean futureDataAvailable()

nextEntry

public boolean nextEntry()

updateOffsetFromContinuation

private void updateOffsetFromContinuation()

alreadyProcessed

private static boolean alreadyProcessed(JournalProcessedPosition position,
 EntryHeader entryHeader)

updatePosition

private static void updatePosition(JournalProcessedPosition p,
 EntryHeader entryHeader)

getEntryHeader

public EntryHeader getEntryHeader()

dumpEntry

public void dumpEntry()

getOffset

public int getOffset()

decode

public <T> T decode(JournalEntryDeocder<T> decoder)
             throws Exception

Throws:

Exception

dumpEntryToFile

public void dumpEntryToFile(File path)

getFirstHeader

public FirstHeader getFirstHeader()

getTotalTransferred

public long getTotalTransferred()