gov.nasa.pds.report.processing

Class NcftpReformatProcessor

java.lang.Object

gov.nasa.pds.report.processing.LogReformatProcessor

gov.nasa.pds.report.processing.NcftpReformatProcessor

All Implemented Interfaces:

Processor

public class NcftpReformatProcessor
extends LogReformatProcessor

This class is used to reformat logs created by an NcFTP server. As such, it uses an input line specification determined by the version of NcFTP that created the logs. The version is specified using the ncftp_version property. The class also requires an output line specification that uses the usual format parsed by the LogReformatProcessor, allowing flags. The output line specification can use the following log details: date_time (must have the date-time flag) child_process operation requested_resource bytes_transfered bytes_received time_taken transfer_rate username email client_ip suffix transfer_status transfer_protocol transfer_notes transfer_start_time session_id file_size offset wildcard_pattern recursion file_mode symlink_target new_filename You can find more information about the NcFTP log format and the details that NcFTP logs contain at http://www.ncftp.com/ncftpd/doc/xferlog.html.

Author:

resneck

Field Summary

Fields

Modifier and Type	Field and Description
static String	OUTPUT_DIR_NAME

Fields inherited from class gov.nasa.pds.report.processing.LogReformatProcessor

DEFAULT_ERRORS_ALLOWED, errorLinesAllowed, inputDetailMap, outputDetailMap, segmentedInput, segmentedOutput

Constructor Summary

Constructors

Constructor and Description
NcftpReformatProcessor()

Method Summary

Modifier and Type	Method and Description
void	configure(Properties props) Configure the Processor, providing the details needed to process logs.
String	getDirName() Get the name of the directory where the output of the processor is placed.
String	getOutputFileName(String inputFileName) Get the name that will be assigned to an output file, given the input file name.
protected void	parseInputLine(String line) Parse a line from an input file and extract the values for presented details (e.g.
void	process(File in, File out) Read in a log file, reformat it as per configured, and place the output in the given directory.
void	process(List<File> in, File out) Reformat all of the NcFTP logs in the given list and place them in the given output directory.
boolean	verifyConfiguration() Verify that the Processor has been properly configured.

Methods inherited from class gov.nasa.pds.report.processing.LogReformatProcessor

configure, determineErrorTolerance, formatOutputLine, parseInputSpec, parseOutputSpec, processFile, processFileList, processLine, resetDetailMaps, validateLineSpecs

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_DIR_NAME

public static final String OUTPUT_DIR_NAME

See Also:

Constant Field Values

Constructor Detail

NcftpReformatProcessor

public NcftpReformatProcessor()

Method Detail

process

public void process(File in,
                    File out)
             throws ProcessingException

Description copied from class: LogReformatProcessor

Read in a log file, reformat it as per configured, and place the output in the given directory.

Specified by:

process in interface Processor

Overrides:

process in class LogReformatProcessor

Parameters:

in - The File that will be reformatted.

out - The directory where output will be placed, represented as a File.

Throws:

ProcessingException - If any parameters are null or invalid, if the processor hasn't been configured, or if an error occurs during processing.

process

public void process(List<File> in,
                    File out)
             throws ProcessingException

Reformat all of the NcFTP logs in the given list and place them in the given output directory.

Specified by:

process in interface Processor

Overrides:

process in class LogReformatProcessor

Parameters:

in - A List of Files, representing the logs to be reformatted.

out - The directory where output is placed, given as a File.

Throws:

ProcessingException - If the Processor has not been properly configured or if an error occurs during processing.

getDirName

public String getDirName()

Description copied from interface: Processor

Get the name of the directory where the output of the processor is placed.

Returns:

The name of the directory created by the Processor.

configure

public void configure(Properties props)
               throws ProcessingException

Description copied from interface: Processor

Configure the Processor, providing the details needed to process logs.

Parameters:

props - A Properties containing the needed configuration values.

Throws:

ProcessingException - If the provided Properties do not contain the needed configuration values.

getOutputFileName

public String getOutputFileName(String inputFileName)

Description copied from interface: Processor

Get the name that will be assigned to an output file, given the input file name.

Parameters:

inputFileName - The name of the input file

Returns:

The name that will be assigned to the output file created from the input file

See Also:

gov.nasa.pds.report.processing.LogReformatProcessor.getOutputFileName()

verifyConfiguration

public boolean verifyConfiguration()

Description copied from interface: Processor

Verify that the Processor has been properly configured. This method should be invoked at the beginning or both process() methods.

Specified by:

verifyConfiguration in interface Processor

Overrides:

verifyConfiguration in class LogReformatProcessor

Returns:

True if the Processor has been properly configured, otherwise false.

See Also:

gov.nasa.pds.report.processing.Processor.verifyConfiguration()

parseInputLine

protected void parseInputLine(String line)
                       throws ProcessingException

Description copied from class: LogReformatProcessor

Parse a line from an input file and extract the values for presented details (e.g. date-time).

Specified by:

parseInputLine in class LogReformatProcessor

Parameters:

line - The input line, presented as a String.

Throws:

ProcessingException - If a required detail is not defined, or if the line cannot be properly parsed using the pattern provided during configuration.

See Also:

gov.nasa.pds.report.processing.LogReformatProcessor.parseInputLine()