com.nt.udc.ei.node.xml

Class XMLTransport

java.lang.Object

com.nt.udc.ndk.node.EITransport

com.nt.udc.ei.node.xml.XMLTransport

All Implemented Interfaces:

DataProviderIfc, DCTransport, FileDataProviderIfc, java.lang.Runnable

Direct Known Subclasses:

XMLFileTransport

public abstract class XMLTransport
extends EITransport

This is the parent class for transport types used by XML.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigIfc	m_config This field is used to get configuration information.
protected int	m_debugLevel This member is used for debugging.
protected java.io.FilenameFilter	m_iFilenameFilter This member is used to select the files to process.
protected LoggerIfc	m_iLogger This field is used to log errors.
protected IStreamSource	m_iStreamSource This member is used to provide the data input stream.
protected XMLProcessor	m_processor
protected COSARReporter	m_reporter This member is used to send reports to.
protected java.io.File	m_scratchDir

Fields inherited from class com.nt.udc.ndk.node.EITransport

dataReceiver, fdChecked, filedataReceiver, fileduplicateCheck, fileToProcess, inputCount, lockFile, movedFile, node, pollingInterval, processing, processingData, running

Constructor Summary

Constructors

Constructor and Description
XMLTransport(LoggerIfc logger, ConfigIfc config, java.io.File scratchDir) Construct a new XMLTransport to be used within the specified EINode.

Method Summary

Modifier and Type	Method and Description
DCFieldContainer[]	getBulkData() This method is used by the DataReceiver to fetch several DCFieldContainer objects.
DCFieldContainer	getData() This method is used by the DataReceiver to fetch a single DCFieldContainer.
protected void	initFilenameFilter() This function is used to initialize the filename filter
void	initialize() This function is used to create and initialize the Transport's components.
protected abstract void	initStreamSource() This is to be implemented by subclasses for various transportation types.
boolean	isDataAvailable() This method is used by the DataReceiver to ask this provider if data is available.
void	run() This method is used when the EITransport runs within its own thread.
void	setProcessor(XMLProcessor processor)
void	shutdown() Stop the transport.

Methods inherited from class com.nt.udc.ndk.node.EITransport

getCurrArchFile, getData, getDataReceiver, getDubCheckObj, getDupCheckFlag, getFileBulkData, getFileData, getFileDataReceiver, getFileList, getMovedFileStatus, getNode, getPollingInterval, getProcessedArchFile, handleRejectOfFile, incrementIn, incrementIn, isEndOfFile, isFileDataAvailable, isHealthy, isProcessing, isProcessingData, isStartOfFile, moveCurrentFileToBackUp, openInputFile, rejectFile, removeProcessedFile, setCountsSuspect, setDataReceiver, setFileDataReceiver, setFileToProcess, setMovedFileStatus, setNode, setPollingInterval, setProcessedArchFile, setProcessing, signalBatchCompletion, validOIMinorType

Methods inherited from class java.lang.Object

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

Field Detail

m_debugLevel

protected int m_debugLevel

This member is used for debugging.

m_iStreamSource

protected IStreamSource m_iStreamSource

This member is used to provide the data input stream.

m_iFilenameFilter

protected java.io.FilenameFilter m_iFilenameFilter

This member is used to select the files to process.

m_reporter

protected COSARReporter m_reporter

This member is used to send reports to.

m_iLogger

protected LoggerIfc m_iLogger

This field is used to log errors.

m_config

protected ConfigIfc m_config

This field is used to get configuration information.

m_scratchDir

protected java.io.File m_scratchDir

m_processor

protected XMLProcessor m_processor

Constructor Detail

XMLTransport

public XMLTransport(LoggerIfc logger,
                    ConfigIfc config,
                    java.io.File scratchDir)
             throws java.lang.Exception

Construct a new XMLTransport to be used within the specified EINode.

Throws:

java.lang.Exception

Method Detail

isDataAvailable

public boolean isDataAvailable()

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

Specified by:

isDataAvailable in interface DataProviderIfc

Specified by:

isDataAvailable in class EITransport

Returns:

true, if data is available

getData

public DCFieldContainer getData()

This method is used by the DataReceiver to fetch a single DCFieldContainer.

Specified by:

getData in interface DataProviderIfc

Specified by:

getData in class EITransport

Returns:

DCFieldContainer.

getBulkData

public DCFieldContainer[] getBulkData()

This method is used by the DataReceiver to fetch several DCFieldContainer objects.

Specified by:

getBulkData in interface DataProviderIfc

Specified by:

getBulkData in class EITransport

Returns:

DCFieldContainer object array, containing the data that is for processing

setProcessor

public void setProcessor(XMLProcessor processor)

run

public void run()

This method is used when the EITransport runs within its own thread. The method should contain the logic to retrieve the data from the the transport's data source and to generate the DCFieldContainer() objects that will be passed on to the DataReceiver.

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class EITransport

shutdown

public void shutdown()

Stop the transport. To ensure no loss of data, the transport should continue to supply any queued data to its DataReceiver.

Specified by:

shutdown in interface DCTransport

Specified by:

shutdown in class EITransport

initialize

public void initialize()
                throws java.lang.Exception

This function is used to create and initialize the Transport's components.

Throws:

java.lang.Exception

initFilenameFilter

protected void initFilenameFilter()
                           throws java.lang.Exception

This function is used to initialize the filename filter

Throws:

java.lang.Exception

initStreamSource

protected abstract void initStreamSource()
                                  throws java.lang.Exception

This is to be implemented by subclasses for various transportation types.

Throws:

java.lang.Exception