com.highqsoft.logarchiver

Class CommandLineValues

java.lang.Object

com.highqsoft.logarchiver.CommandLineValues

public class CommandLineValues
extends java.lang.Object

This class manage the passed commandline parameters. Every valid parameter can be requested from this class with a seperate method. For parsing command line, the apache commons cli library is used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandLineValues.Compression
static class	CommandLineValues.FileNameDate
static class	CommandLineValues.ProcessingMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CMD_PAR_CLEANUP_COUNT
static java.lang.String	CMD_PAR_CLEANUP_DAYS
static java.lang.String	CMD_PAR_COMPRESSION
static java.lang.String	CMD_PAR_FILENAME_DATE
static java.lang.String	CMD_PAR_HELP
static java.lang.String	CMD_PAR_PROCESSING_MODE
static java.lang.String	CMD_PAR_SCAN_INTERVAL
static java.lang.String	CMD_PAR_SOURCE_DIRECTORY
static java.lang.String	CMD_PAR_SOURCE_FILE_NAME
static java.lang.String	CMD_PAR_STDERR
static java.lang.String	CMD_PAR_STDOUT
static java.lang.String	CMD_PAR_TARGET_DIRECTORY
static java.lang.String	CMD_PAR_TARGET_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
CommandLineValues()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkHelpParameterPassed() Check if -Help is passed as parameter.
int	getCleanupCounts() Returns the number files to cleanup files in target directory
int	getCleanupDays() Returns the number of days to cleanup files in target directory
CommandLineValues.Compression	getCompression() Returns the compression mode.
CommandLineValues.FileNameDate	getDateSource() Returns the source for the date time for target filename mode.
CommandLineValues.ProcessingMode	getProcessingMode() Returns the processing mode.
int	getScanInterval() Returns the number of seconds for scan interval
java.lang.String	getSourceDirectory() Returns the SourceDirectory parameter, otherwise the current directory
java.lang.String	getSourceFileName() Returns the SourceFileName parameter, otherwise '*.bak'
java.lang.String	getTargetDirectory() Returns the TargetDirectory parameter, otherwise the current directory
java.lang.String	getTargetFileName() Returns the TargetFileName parameter.
void	parseCommandLine(java.lang.String[] commandLineParameter) Parsed the given command line parameter array

Methods inherited from class java.lang.Object

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

Field Detail

CMD_PAR_HELP

public static final java.lang.String CMD_PAR_HELP

See Also:

Constant Field Values

CMD_PAR_STDERR

public static final java.lang.String CMD_PAR_STDERR

See Also:

Constant Field Values

CMD_PAR_STDOUT

public static final java.lang.String CMD_PAR_STDOUT

See Also:

Constant Field Values

CMD_PAR_SOURCE_FILE_NAME

public static final java.lang.String CMD_PAR_SOURCE_FILE_NAME

See Also:

Constant Field Values

CMD_PAR_TARGET_FILE_NAME

public static final java.lang.String CMD_PAR_TARGET_FILE_NAME

See Also:

Constant Field Values

CMD_PAR_SOURCE_DIRECTORY

public static final java.lang.String CMD_PAR_SOURCE_DIRECTORY

See Also:

Constant Field Values

CMD_PAR_TARGET_DIRECTORY

public static final java.lang.String CMD_PAR_TARGET_DIRECTORY

See Also:

Constant Field Values

CMD_PAR_PROCESSING_MODE

public static final java.lang.String CMD_PAR_PROCESSING_MODE

See Also:

Constant Field Values

CMD_PAR_COMPRESSION

public static final java.lang.String CMD_PAR_COMPRESSION

See Also:

Constant Field Values

CMD_PAR_FILENAME_DATE

public static final java.lang.String CMD_PAR_FILENAME_DATE

See Also:

Constant Field Values

CMD_PAR_CLEANUP_DAYS

public static final java.lang.String CMD_PAR_CLEANUP_DAYS

See Also:

Constant Field Values

CMD_PAR_CLEANUP_COUNT

public static final java.lang.String CMD_PAR_CLEANUP_COUNT

See Also:

Constant Field Values

CMD_PAR_SCAN_INTERVAL

public static final java.lang.String CMD_PAR_SCAN_INTERVAL

See Also:

Constant Field Values

Constructor Detail

CommandLineValues

public CommandLineValues()

Method Detail

parseCommandLine

public void parseCommandLine(java.lang.String[] commandLineParameter)
                      throws LogarchiverException

Parsed the given command line parameter array

Throws:

LogarchiverException

checkHelpParameterPassed

public boolean checkHelpParameterPassed()

Check if -Help is passed as parameter. If true the help page is printed. Returns true if help is requested.

getSourceDirectory

public java.lang.String getSourceDirectory()

Returns the SourceDirectory parameter, otherwise the current directory

getTargetDirectory

public java.lang.String getTargetDirectory()

Returns the TargetDirectory parameter, otherwise the current directory

getSourceFileName

public java.lang.String getSourceFileName()

Returns the SourceFileName parameter, otherwise '*.bak'

getTargetFileName

public java.lang.String getTargetFileName()
                                   throws LogarchiverException

Returns the TargetFileName parameter.

Throws:

LogarchiverException

getProcessingMode

public CommandLineValues.ProcessingMode getProcessingMode()
                                                   throws LogarchiverException

Returns the processing mode. If not given on command line, 'move' will be used.

Throws:

LogarchiverException

getCompression

public CommandLineValues.Compression getCompression()
                                             throws LogarchiverException

Returns the compression mode. If not given on command line, 'none' will be used

Throws:

LogarchiverException

getDateSource

public CommandLineValues.FileNameDate getDateSource()
                                             throws LogarchiverException

Returns the source for the date time for target filename mode.

Throws:

LogarchiverException

getCleanupDays

public int getCleanupDays()
                   throws LogarchiverException

Returns the number of days to cleanup files in target directory

Throws:

LogarchiverException

getCleanupCounts

public int getCleanupCounts()
                     throws LogarchiverException

Returns the number files to cleanup files in target directory

Throws:

LogarchiverException

getScanInterval

public int getScanInterval()
                    throws LogarchiverException

Returns the number of seconds for scan interval

Throws:

LogarchiverException