gov.nasa.pds.report.processing

Class ProxyFilterProcessor

java.lang.Object

gov.nasa.pds.report.processing.ProxyFilterProcessor

All Implemented Interfaces:

Processor

public class ProxyFilterProcessor
extends Object
implements Processor

This processor filters Apache/Combined logs to remove proxies from the client IP details.

Author:

resneck

Field Summary

Fields

Modifier and Type	Field and Description
static String	OUTPUT_DIR_NAME

Constructor Summary

Constructors

Constructor and Description
ProxyFilterProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Properties props) This particular Processor doesn't require any configuration since its purpose is so specific.
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.
void	process(File in, File out) Process the files in the input directory and place them in the output directory.
void	process(List<File> in, File out) Process the files in the given list and place them in the output directory.
protected void	processFile(File in, File outputDir) Process a given File, placing the filtered version inside a given directory.
protected void	processFileList(List<File> files, File out) Process the provided List of Files.
protected boolean	processLine(ReadWriter rw) Use the provided reader to read in a line, strip away any proxy IPs from the client details, and then write it to output using the provided writer.
boolean	verifyConfiguration() This particular Processor doesn't require any configuration since its purpose is so specific.

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

ProxyFilterProcessor

public ProxyFilterProcessor()

Method Detail

process

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

Description copied from interface: Processor

Process the files in the input directory and place them in the output directory. The process performed will vary based on the implementation and the output will be placed in a sibling directory. The name of that directory will vary based upon the implementation being used.

Specified by:

process in interface Processor

Parameters:

in - The directory containing the input files

out - The directory where output is placed

Throws:

ProcessingException - If an error occurs.

See Also:

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

process

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

Description copied from interface: Processor

Process the files in the given list and place them in the output directory. The process performed will vary based on the implementation and the output will be placed in a sibling directory. The name of that directory will vary based upon the implementation being used.

Specified by:

process in interface Processor

Parameters:

in - A List of File objects pointing to files that will be processed

out - The directory where output is placed

Throws:

ProcessingException - If an error occurs.

See Also:

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

getDirName

public String getDirName()

Description copied from interface: Processor

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

Specified by:

getDirName in interface Processor

Returns:

The name of the directory created by the Processor.

See Also:

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

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.

Specified by:

getOutputFileName in interface Processor

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.Processor.getOutputFileName()

configure

public void configure(Properties props)
               throws ProcessingException

This particular Processor doesn't require any configuration since its purpose is so specific.

Specified by:

configure in interface Processor

Parameters:

props - A Properties containing the needed configuration values.

Throws:

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

See Also:

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

verifyConfiguration

public boolean verifyConfiguration()

This particular Processor doesn't require any configuration since its purpose is so specific.

Specified by:

verifyConfiguration in interface Processor

Returns:

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

See Also:

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

processFileList

protected void processFileList(List<File> files,
                   File out)
                        throws ProcessingException

Process the provided List of Files.

Parameters:

files - A list of File objects pointing to log files to be processed.

out - A File object pointing to the directory where output will be placed.

Throws:

ProcessingException - If an error occurs.

processFile

protected void processFile(File in,
               File outputDir)
                    throws ProcessingException

Process a given File, placing the filtered version inside a given directory.

Parameters:

in - The File that will be processed.

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

Throws:

ProcessingException - If an error occurs while parsing the input file or while writing output.

processLine

protected boolean processLine(ReadWriter rw)
                       throws ProcessingException

Use the provided reader to read in a line, strip away any proxy IPs from the client details, and then write it to output using the provided writer.

Parameters:

rw - A ReadWriter that is already initialized to read and write from the input and output files.

Returns:

True if a line was read from the input file, otherwise false (indicating EOF).

Throws:

ProcessingException - If an error occurs.