com.nt.udc.ndk.node

Class EITransport

java.lang.Object

com.nt.udc.ndk.node.EITransport

All Implemented Interfaces:

DataProviderIfc, DCTransport, FileDataProviderIfc, java.lang.Runnable

Direct Known Subclasses:

FileEITransport, FileEITransport, FtpEITransport, GenericUdpEITransport, IPDRTransport, JDBCEITransport, OpenFileEITransport, SoapXmlEITransport, Sol42EITransport, TcpEITransport, UdpEITransport, XMLTransport

public abstract class EITransport
extends java.lang.Object
implements DCTransport, DataProviderIfc, FileDataProviderIfc

Field Summary

Fields

Modifier and Type	Field and Description
protected DataReceiverIfc	dataReceiver Reference to the DataReceiver of the transport.
boolean	fdChecked
protected FileDataReceiverIfc	filedataReceiver Reference to the FileDataReceiver of the transport.
FileEIDuplicateCheck	fileduplicateCheck
protected java.io.File	fileToProcess
protected InputStatisticsMonitorIfc	inputCount Input record count object.
java.io.File	lockFile
protected boolean	movedFile
protected DCNode	node Reference to the EINode to which the transport is associated.
protected long	pollingInterval Time interval at which the node will check for data.
protected boolean	processing
protected boolean	processingData
protected boolean	running Indicates whether the transport is running.

Constructor Summary

Constructors

Constructor and Description
EITransport()

Method Summary

Modifier and Type	Method and Description
abstract DCFieldContainer[]	getBulkData() This method is used by the DataReceiver to fetch a set of DCFieldContainer objects.
java.io.File	getCurrArchFile() Allows a DataReceiver to obtain the currently processing .arch file
abstract DCFieldContainer	getData() This method is used by the DataReceiver to fetch a single
DCFieldContainer	getData(java.lang.String batch) Allows a DataReceiver to obtain the available data in a known format.
DataReceiverIfc	getDataReceiver() Gets the object that is retrieving data from this DataProvider
FileEIDuplicateCheck	getDubCheckObj()
boolean	getDupCheckFlag()
DCFieldContainer[]	getFileBulkData() This method is used by the FileDataReceiver to fetch a set of This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.
DCFieldContainer	getFileData() This method is used by the FileDataReceiver to fetch a single This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.
FileDataReceiverIfc	getFileDataReceiver() Gets the object that is retrieving data from this FileDataProvider
static java.util.List<java.io.File>	getFileList(java.io.File dir, java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)
boolean	getMovedFileStatus()
DCNode	getNode() Returns the EINode containing this transport.
long	getPollingInterval() Returns the time interval between polls for available data.
java.lang.String	getProcessedArchFile() Allows a DataReceiver to obtain the last processed .arch file
void	handleRejectOfFile() To handle the remaining input files when there is reject of a file
protected void	incrementIn()
protected void	incrementIn(int count)
abstract boolean	isDataAvailable() This method is used by the DataReceiver to ask this provider if data is available.
boolean	isEndOfFile() Determines if record received is an End of file indication This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.
boolean	isFileDataAvailable() This method is used by the FileDataReceiver to ask this provider if data is available.
boolean	isHealthy() This method is used to check the transport's state of health.
boolean	isProcessing()
boolean	isProcessingData()
boolean	isStartOfFile() Determines if the record received is start of file indication This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.
void	moveCurrentFileToBackUp(java.io.File currentFile, java.lang.String newFilename)
java.lang.String	openInputFile() This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.
boolean	rejectFile() This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.
void	removeProcessedFile(java.io.File currArchFile) Allows a DataReceiver to remove .arch file once processed currArchFile - processed .arch file
abstract void	run() This method is used to control processing for fetching data from the EI's source.
protected void	setCountsSuspect() Set a flag to indicate to the Record Statistics feature that there is something not trusted in the input counts.
void	setDataReceiver(DataReceiverIfc receiver) Sets the object to which this DataProvider will send its data.
void	setFileDataReceiver(FileDataReceiverIfc receiver) Sets the object to which this FileDataProvider will send its data.
void	setFileToProcess(java.io.File filetoProcess)
void	setMovedFileStatus(boolean fileMoved)
void	setNode(DCNode einode) Sets the node within which this EITransport is contained.
void	setPollingInterval(long interval) Sets the time interval between polls for available data.
void	setProcessedArchFile(java.lang.String file) Sets the processed .arch file absolute path
void	setProcessing(boolean isProcessing)
abstract void	shutdown() This method is used to provide a means of shutting down the transport in an orderly fashion.
void	signalBatchCompletion(java.lang.String batch) Allows a DataReceiver to know that the nars under the specified batch are completed and handed over to the Data receiver
boolean	validOIMinorType() Allows a DataReceiver to check if Minor Type supported for disaster recovery

Methods inherited from class java.lang.Object

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

Field Detail

node

protected DCNode node

Reference to the EINode to which the transport is associated.

dataReceiver

protected DataReceiverIfc dataReceiver

Reference to the DataReceiver of the transport.

filedataReceiver

protected FileDataReceiverIfc filedataReceiver

Reference to the FileDataReceiver of the transport.

running

protected boolean running

Indicates whether the transport is running.

processing

protected boolean processing

movedFile

protected boolean movedFile

pollingInterval

protected long pollingInterval

Time interval at which the node will check for data. Default is 20 seconds.

inputCount

protected InputStatisticsMonitorIfc inputCount

Input record count object. Although initialized to a do-nothing object, subclasses should set its value to the result of the call DCNode.getInputStatsProcessor(). this.setNode() will also set this object.

processingData

protected boolean processingData

fileToProcess

protected java.io.File fileToProcess

lockFile

public java.io.File lockFile

fdChecked

public boolean fdChecked

fileduplicateCheck

public FileEIDuplicateCheck fileduplicateCheck

Constructor Detail

EITransport

public EITransport()

Method Detail

setDataReceiver

public void setDataReceiver(DataReceiverIfc receiver)

Sets the object to which this DataProvider will send its data.

Specified by:

setDataReceiver in interface DataProviderIfc

Parameters:

receiver - Object which needs data sent to it.

setFileDataReceiver

public void setFileDataReceiver(FileDataReceiverIfc receiver)

Sets the object to which this FileDataProvider will send its data.

Specified by:

setFileDataReceiver in interface FileDataProviderIfc

Parameters:

receiver - Object which needs data sent to it.

getDataReceiver

public DataReceiverIfc getDataReceiver()

Description copied from interface: DataProviderIfc

Gets the object that is retrieving data from this DataProvider

Specified by:

getDataReceiver in interface DataProviderIfc

Returns:

Returns the object to which this DataProvider will send data.

getFileDataReceiver

public FileDataReceiverIfc getFileDataReceiver()

Description copied from interface: FileDataProviderIfc

Gets the object that is retrieving data from this FileDataProvider

Specified by:

getFileDataReceiver in interface FileDataProviderIfc

Returns:

Returns the object to which this DataProvider will send data.

isDataAvailable

public abstract boolean isDataAvailable()

This method is used by the DataReceiver to ask this provider if data is available.

Specified by:

isDataAvailable in interface DataProviderIfc

Returns:

true, if data is available

isFileDataAvailable

public boolean isFileDataAvailable()

This method is used by the FileDataReceiver to ask this provider if data is available. This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.

Specified by:

isFileDataAvailable in interface FileDataProviderIfc

Returns:

true, if data is available

getData

public abstract DCFieldContainer getData()

This method is used by the DataReceiver to fetch a single

Specified by:

getData in interface DataProviderIfc

Returns:

DCFieldContainer.

getData

public DCFieldContainer getData(java.lang.String batch)

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the available data in a known format. batch - The nars read will be grouped under the specified batch

Specified by:

getData in interface DataProviderIfc

Returns:

DCFieldContainer object containing the data that is available for processing

signalBatchCompletion

public void signalBatchCompletion(java.lang.String batch)

Description copied from interface: DataProviderIfc

Allows a DataReceiver to know that the nars under the specified batch are completed and handed over to the Data receiver

Specified by:

signalBatchCompletion in interface DataProviderIfc

removeProcessedFile

public void removeProcessedFile(java.io.File currArchFile)

Description copied from interface: DataProviderIfc

Allows a DataReceiver to remove .arch file once processed currArchFile - processed .arch file

Specified by:

removeProcessedFile in interface DataProviderIfc

getCurrArchFile

public java.io.File getCurrArchFile()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the currently processing .arch file

Specified by:

getCurrArchFile in interface DataProviderIfc

Returns:

currently processing .arch file

getProcessedArchFile

public java.lang.String getProcessedArchFile()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to obtain the last processed .arch file

Specified by:

getProcessedArchFile in interface DataProviderIfc

Returns:

currently processing .arch file absolute path

validOIMinorType

public boolean validOIMinorType()

Description copied from interface: DataProviderIfc

Allows a DataReceiver to check if Minor Type supported for disaster recovery

Specified by:

validOIMinorType in interface DataProviderIfc

Returns:

true if valid

setProcessedArchFile

public void setProcessedArchFile(java.lang.String file)

Description copied from interface: DataProviderIfc

Sets the processed .arch file absolute path

Specified by:

setProcessedArchFile in interface DataProviderIfc

Parameters:

file - absolute path of processed .arch file

getFileData

public DCFieldContainer getFileData()

This method is used by the FileDataReceiver to fetch a single This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.

Specified by:

getFileData in interface FileDataProviderIfc

Returns:

DCFieldContainer.

isEndOfFile

public boolean isEndOfFile()

Determines if record received is an End of file indication This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.

Specified by:

isEndOfFile in interface FileDataProviderIfc

Returns:

true, if data is available

isStartOfFile

public boolean isStartOfFile()

Determines if the record received is start of file indication This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.

Specified by:

isStartOfFile in interface FileDataProviderIfc

Returns:

getBulkData

public abstract DCFieldContainer[] getBulkData()

This method is used by the DataReceiver to fetch a set of DCFieldContainer objects.

Specified by:

getBulkData in interface DataProviderIfc

Returns:

DCFieldContainer object array, containing the data that is for processing

getFileBulkData

public DCFieldContainer[] getFileBulkData()

This method is used by the FileDataReceiver to fetch a set of This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.

Specified by:

getFileBulkData in interface FileDataProviderIfc

Returns:

DCFieldContainer objects.

run

public abstract void run()

This method is used to control processing for fetching data from the EI's source.

Specified by:

run in interface java.lang.Runnable

shutdown

public abstract void shutdown()

This method is used to provide a means of shutting down the transport in an orderly fashion.

Specified by:

shutdown in interface DCTransport

setNode

public void setNode(DCNode einode)

Sets the node within which this EITransport is contained.

Parameters:

einode - The EINode which contains this transport.

getNode

public DCNode getNode()

Returns the EINode containing this transport.

Returns:

Returns the EINode of this transport.

setPollingInterval

public void setPollingInterval(long interval)

Sets the time interval between polls for available data.

Parameters:

interval - Number of milliseconds to wait.

getPollingInterval

public long getPollingInterval()

Returns the time interval between polls for available data.

Returns:

Returns the polling interval.

isHealthy

public boolean isHealthy()

This method is used to check the transport's state of health. By default it returns true. It is to be overridden by subclasses.

Specified by:

isHealthy in interface DCTransport

Returns:

true if the transport is healthy, false otherwise

incrementIn

protected void incrementIn()

incrementIn

protected void incrementIn(int count)

setCountsSuspect

protected void setCountsSuspect()

Set a flag to indicate to the Record Statistics feature that there is something not trusted in the input counts. Usual example is if the file parser chokes on a record in the middle of a file.

isProcessingData

public boolean isProcessingData()

setFileToProcess

public void setFileToProcess(java.io.File filetoProcess)

isProcessing

public boolean isProcessing()

setProcessing

public void setProcessing(boolean isProcessing)

getMovedFileStatus

public boolean getMovedFileStatus()

setMovedFileStatus

public void setMovedFileStatus(boolean fileMoved)

openInputFile

public java.lang.String openInputFile()
                               throws java.lang.Exception

This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior.

Specified by:

openInputFile in interface FileDataProviderIfc

Returns:

Throws:

java.lang.Exception

rejectFile

public boolean rejectFile()
                   throws java.lang.Exception

This is just a dummy implementation, any transport needing the file level transaction behavior should override this method and implement correct behavior. Indicates data provider to stop reading from the input file and reject it

Specified by:

rejectFile in interface FileDataProviderIfc

Returns:

true for successful rejection of input file

Throws:

java.lang.Exception

handleRejectOfFile

public void handleRejectOfFile()

Description copied from interface: FileDataProviderIfc

To handle the remaining input files when there is reject of a file

Specified by:

handleRejectOfFile in interface FileDataProviderIfc

getDupCheckFlag

public boolean getDupCheckFlag()

getDubCheckObj

public FileEIDuplicateCheck getDubCheckObj()

getFileList

public static java.util.List<java.io.File> getFileList(java.io.File dir,
                                                       java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)
                                                throws java.lang.Exception

Throws:

java.lang.Exception

moveCurrentFileToBackUp

public void moveCurrentFileToBackUp(java.io.File currentFile,
                                    java.lang.String newFilename)
                             throws java.io.IOException

Throws:

java.io.IOException