com.nt.udc.io

Class CDataSourceSuperTail

java.lang.Object

com.nt.udc.io.CDataSourceSuperTail

All Implemented Interfaces:

IDataSource

public class CDataSourceSuperTail
extends java.lang.Object
implements IDataSource

This class is used as the source of data retrieved from SuperTail.

Since:

JDK1.1.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CDataSourceSuperTail.Delegate

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_bConnectErrorIssued This member represents an error flag set if the connection to SuperTail cannot be established.
protected java.io.File	m_bookmarkFile This member represents the bookmark-file associated to the file currently being processed.
protected java.io.RandomAccessFile	m_bookmarkStream This member represents the bookmark-stream opened on m_bookmarkFile.
protected int	m_connectTimeout
protected java.lang.String	m_crtFile This member represents the name of the file currently being processed.
protected int	m_crtIndexInLine This is the current index in m_crtLine.
protected java.lang.String	m_crtLine This member represents the current line read from SuperTail.
protected int	m_crtLineNumber This member represents the current line number.
protected double	m_daysToKeepCpt This member represents the number of days for preserving check-point files.
protected static int	m_debugLevel
protected CDataSourceSuperTail.Delegate	m_delegate This delegate is used to check if we need to wait or not.
protected java.lang.String	m_fileHead
protected java.io.FilenameFilter	m_filenameFilter This member is used to filter files to process.
protected java.lang.String	m_hostName This member represents the hostname.
protected ILogger	m_iLogger This member is used to report errors and warnings.
protected java.io.BufferedInputStream	m_inputStream This member represents the input stream from SuperTail.
protected java.io.PrintWriter	m_out This member is used to send messages from SuperTail.
protected int	m_port This member represents the port-number.
protected java.io.BufferedReader	m_reader This member is used to read characters from SuperTail.
protected int	m_readTimeout
protected java.lang.String	m_remoteDir This member represents the remote directory on SuperTail's host.
protected COSARReporter	m_reporter This member is used to send reports to.
protected java.lang.String	m_scratchDir This member represents the scratch directory.
protected java.net.Socket	m_socket This member represents the remote socket to access SuperTail.

Fields inherited from interface com.nt.udc.io.IDataSource

EOF

Constructor Summary

Constructors

Constructor and Description
CDataSourceSuperTail(java.net.InetAddress remoteIP, int remotePort, int localPort, java.lang.String remoteDir, java.lang.String scratchDir, ILogger iLogger)
CDataSourceSuperTail(java.net.InetAddress remoteIP, int remotePort, java.lang.String remoteDir, java.lang.String scratchDir, ILogger iLogger)
CDataSourceSuperTail(java.lang.String remoteHost, int remotePort, int localPort, java.lang.String remoteDir, java.lang.String scratchDir, ILogger iLogger)
CDataSourceSuperTail(java.lang.String remoteHost, int remotePort, java.lang.String remoteDir, java.lang.String scratchDir, ILogger iLogger)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	debug(java.lang.String fName, java.lang.String msg)
boolean	end() This function is called to end reading.
protected void	error(java.lang.String fName, java.lang.String msg)
protected java.lang.String	getBookmarkFileName(java.lang.String inputFile)
int	getConnectTimeout()
double	getDaysToKeepCpt()
static int	getDebugLevel()
java.io.FilenameFilter	getFilenameFilter()
int	getLocalPort()
int	getReadTimeout()
java.lang.String	getRemoteDir()
java.net.InetAddress	getRemoteInetAddress()
int	getRemotePort()
COSARReporter	getReporter()
java.lang.String	getScratchDir()
java.lang.String	getSourceName()
boolean	hasMoreData()
boolean	initialize() This function is called to initiate the communication protocol with SuperTail.
boolean	isHealthy()
char	nextChar() Function used to read a character from the input medium
protected void	purgeCheckpointFiles() This function is used to purge the checkpoint files that are older than one week.
int	read(char[] buf, int len) This function reads a given number of characters from the source.
java.lang.String	recv()
boolean	send(java.lang.String msg)
boolean	setBookmark(int lineNo) Function used to mark a position in the input medium
void	setConnectTimeout(int connectTimeout)
void	setDaysToKeepCpt(double daysToKeepCpt)
static void	setDebugLevel(int debugLevel)
void	setDelegate(CDataSourceSuperTail.Delegate delegate)
void	setFilenameFilter(java.io.FilenameFilter filenameFilter)
void	setReadTimeout(int readTimeout)
void	setReporter(COSARReporter reporter)
boolean	start() This function is called to start reading.
boolean	start1() This function is called to start reading.
boolean	terminate() Function used to end communication with SuperTail

Methods inherited from class java.lang.Object

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

Field Detail

m_fileHead

protected final java.lang.String m_fileHead

See Also:

Constant Field Values

m_debugLevel

protected static int m_debugLevel

m_iLogger

protected ILogger m_iLogger

This member is used to report errors and warnings.

m_hostName

protected java.lang.String m_hostName

This member represents the hostname.

m_port

protected int m_port

This member represents the port-number.

m_socket

protected java.net.Socket m_socket

This member represents the remote socket to access SuperTail.

m_remoteDir

protected java.lang.String m_remoteDir

This member represents the remote directory on SuperTail's host.

m_scratchDir

protected java.lang.String m_scratchDir

This member represents the scratch directory.

m_daysToKeepCpt

protected double m_daysToKeepCpt

This member represents the number of days for preserving check-point files.

m_inputStream

protected java.io.BufferedInputStream m_inputStream

This member represents the input stream from SuperTail.

m_reader

protected java.io.BufferedReader m_reader

This member is used to read characters from SuperTail. It is opened on the socket's input stream.

m_out

protected java.io.PrintWriter m_out

This member is used to send messages from SuperTail. It is opened on the socket's output stream.

m_crtLine

protected java.lang.String m_crtLine

This member represents the current line read from SuperTail.

m_crtIndexInLine

protected int m_crtIndexInLine

This is the current index in m_crtLine.

m_crtLineNumber

protected int m_crtLineNumber

This member represents the current line number. It is used for bookmarking purposes.

m_crtFile

protected java.lang.String m_crtFile

This member represents the name of the file currently being processed.

m_bookmarkFile

protected java.io.File m_bookmarkFile

This member represents the bookmark-file associated to the file currently being processed.

m_bookmarkStream

protected java.io.RandomAccessFile m_bookmarkStream

This member represents the bookmark-stream opened on m_bookmarkFile.

m_bConnectErrorIssued

protected boolean m_bConnectErrorIssued

This member represents an error flag set if the connection to SuperTail cannot be established.

m_reporter

protected COSARReporter m_reporter

This member is used to send reports to. Example: startFile, endFile.

m_filenameFilter

protected java.io.FilenameFilter m_filenameFilter

This member is used to filter files to process.

m_delegate

protected CDataSourceSuperTail.Delegate m_delegate

This delegate is used to check if we need to wait or not.

m_connectTimeout

protected int m_connectTimeout

m_readTimeout

protected int m_readTimeout

Constructor Detail

CDataSourceSuperTail

public CDataSourceSuperTail(java.net.InetAddress remoteIP,
                    int remotePort,
                    java.lang.String remoteDir,
                    java.lang.String scratchDir,
                    ILogger iLogger)
                     throws java.lang.Exception

Parameters:

remoteIP - IP of the host to connect to

remotePort - Port number to connect to

remoteDir - Remote directory to get data from

scratchDir - Work-directory

iLogger - Interface used for logging messages

Throws:

java.lang.Exception

CDataSourceSuperTail

public CDataSourceSuperTail(java.lang.String remoteHost,
                    int remotePort,
                    java.lang.String remoteDir,
                    java.lang.String scratchDir,
                    ILogger iLogger)
                     throws java.lang.Exception

Parameters:

remoteHost - Name of host to connect to

remotePort - Port number to connect to

remoteDir - Remote directory to get data from

scratchDir - Work-directory

iLogger - Interface used for logging messages

Throws:

java.lang.Exception

CDataSourceSuperTail

public CDataSourceSuperTail(java.net.InetAddress remoteIP,
                    int remotePort,
                    int localPort,
                    java.lang.String remoteDir,
                    java.lang.String scratchDir,
                    ILogger iLogger)
                     throws java.lang.Exception

Parameters:

remoteIP - IP of the host to connect to

remotePort - Port number to connect to

localPort - Local port number to use when connecting

remoteDir - Remote directory to get data from

scratchDir - Work-directory

iLogger - Interface used for logging messages

Throws:

java.lang.Exception

CDataSourceSuperTail

public CDataSourceSuperTail(java.lang.String remoteHost,
                    int remotePort,
                    int localPort,
                    java.lang.String remoteDir,
                    java.lang.String scratchDir,
                    ILogger iLogger)
                     throws java.lang.Exception

Parameters:

remoteHost - Name of host to connect to

remotePort - Port number to connect to

localPort - Local port number to use when connecting

remoteDir - Remote directory to get data from

scratchDir - Work-directory

iLogger - Interface used for logging messages

Throws:

java.lang.Exception

Method Detail

getDebugLevel

public static int getDebugLevel()

getRemoteInetAddress

public java.net.InetAddress getRemoteInetAddress()

getRemotePort

public int getRemotePort()

getLocalPort

public int getLocalPort()

getRemoteDir

public java.lang.String getRemoteDir()

getScratchDir

public java.lang.String getScratchDir()

getDaysToKeepCpt

public double getDaysToKeepCpt()

getFilenameFilter

public java.io.FilenameFilter getFilenameFilter()

getReporter

public COSARReporter getReporter()

getReadTimeout

public int getReadTimeout()

getConnectTimeout

public int getConnectTimeout()

setDaysToKeepCpt

public void setDaysToKeepCpt(double daysToKeepCpt)

setFilenameFilter

public void setFilenameFilter(java.io.FilenameFilter filenameFilter)

setDebugLevel

public static void setDebugLevel(int debugLevel)

setReporter

public void setReporter(COSARReporter reporter)

setDelegate

public final void setDelegate(CDataSourceSuperTail.Delegate delegate)

setReadTimeout

public void setReadTimeout(int readTimeout)

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

getSourceName

public java.lang.String getSourceName()

Specified by:

getSourceName in interface IDataSource

Returns:

The name of the current file

hasMoreData

public boolean hasMoreData()

Specified by:

hasMoreData in interface IDataSource

Returns:

true if data is available, false otherwise

nextChar

public char nextChar()
              throws java.lang.Exception

Function used to read a character from the input medium

If there is a current file to process, the character is retrieved from this file, otherwise the next file is selected for processing

Specified by:

nextChar in interface IDataSource

Returns:

A valid character if successful, IDataSource.EOF if the end-of-file was reached or if unsuccessful

Throws:

java.lang.Exception

read

public int read(char[] buf,
       int len)
         throws java.lang.Exception

Description copied from interface: IDataSource

This function reads a given number of characters from the source.

Specified by:

read in interface IDataSource

Returns:

The number of characters actually read.

Throws:

java.lang.Exception

start1

public boolean start1()

This function is called to start reading.

start

public boolean start()

Description copied from interface: IDataSource

This function is called to start reading. Classes implementing IDataSource may use it for initialization.

Specified by:

start in interface IDataSource

Returns:

true if successful, false otherwise

end

public boolean end()

This function is called to end reading.

Specified by:

end in interface IDataSource

Returns:

true if successful, false otherwise

initialize

public boolean initialize()

This function is called to initiate the communication protocol with SuperTail.

The input and output streams are initialized. The initialization of communication with SuperTail requires following protocol on the part of CDataSourceSupertail:

• ignore the prompt "filemon> "
• send "cd \n"
• ignore SuperTail's output for ls
• send "start\n"

Specified by:

initialize in interface IDataSource

Returns:

true if successful, false otherwise

terminate

public boolean terminate()

Function used to end communication with SuperTail

Specified by:

terminate in interface IDataSource

Returns:

true if successful, false otherwise

setBookmark

public boolean setBookmark(int lineNo)

Function used to mark a position in the input medium

Specified by:

setBookmark in interface IDataSource

Returns:

true if successful, false otherwise

send

public boolean send(java.lang.String msg)

recv

public java.lang.String recv()

isHealthy

public boolean isHealthy()

Specified by:

isHealthy in interface IDataSource

Returns:

true if the data-source is functional, false otherwise

purgeCheckpointFiles

protected void purgeCheckpointFiles()

This function is used to purge the checkpoint files that are older than one week.

getBookmarkFileName

protected java.lang.String getBookmarkFileName(java.lang.String inputFile)

error

protected void error(java.lang.String fName,
         java.lang.String msg)

debug

protected void debug(java.lang.String fName,
         java.lang.String msg)