com.communote.common.virusscan.impl

Class CommandlineScanner

java.lang.Object

com.communote.common.virusscan.impl.CommandlineScanner

All Implemented Interfaces:

VirusScanner

public class CommandlineScanner
extends Object
implements VirusScanner

This class use the command line for scanning content.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_LINE_PROCESS_TIMEOUT_PROP Timeout of scan process
static String	COMMAND_LINE_PROP Command line string which will execute
static String	EXIT_CODE_PROP Exit code of the scan process
static String	TEMP_DIR_PROP Directory for temporary files
static String	TEMP_FILE_PREFIX_PROP Name prefix for files
static String	TEMP_FILE_SUFFIX_PROP Name suffix for files

Constructor Summary

Constructors

Constructor and Description
CommandlineScanner() This is just necessary for java reflection

Method Summary

Modifier and Type	Method and Description
void	init(Properties properties) Initialize the Scanner
void	scan(byte[] bytes) Scan a byte array for viruses
void	scan(File file) Scan file for virus
InputStream	scan(InputStream stream) Scan an input stream for virus.

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_LINE_PROP

public static final String COMMAND_LINE_PROP

Command line string which will execute

See Also:

Constant Field Values

COMMAND_LINE_PROCESS_TIMEOUT_PROP

public static final String COMMAND_LINE_PROCESS_TIMEOUT_PROP

Timeout of scan process

See Also:

Constant Field Values

EXIT_CODE_PROP

public static final String EXIT_CODE_PROP

Exit code of the scan process

See Also:

Constant Field Values

TEMP_DIR_PROP

public static final String TEMP_DIR_PROP

Directory for temporary files

See Also:

Constant Field Values

TEMP_FILE_PREFIX_PROP

public static final String TEMP_FILE_PREFIX_PROP

Name prefix for files

See Also:

Constant Field Values

TEMP_FILE_SUFFIX_PROP

public static final String TEMP_FILE_SUFFIX_PROP

Name suffix for files

See Also:

Constant Field Values

Constructor Detail

CommandlineScanner

public CommandlineScanner()

This is just necessary for java reflection

Method Detail

init

public void init(Properties properties)
          throws InitializeException

Initialize the Scanner

Specified by:

init in interface VirusScanner

Parameters:

properties - Init Properties. This will be used for individual settings.

Throws:

InitializeException - Thrown when initialization fails

scan

public void scan(byte[] bytes)
          throws VirusScannerException,
                 VirusFoundException

Scan a byte array for viruses

Specified by:

scan in interface VirusScanner

Parameters:

bytes - Byte content

Throws:

VirusScannerException - This Exception encapsulate any exception

VirusFoundException - VirusScannerException

scan

public void scan(File file)
          throws VirusScannerException,
                 VirusFoundException

Scan file for virus

Specified by:

scan in interface VirusScanner

Parameters:

file - Scanning file

Throws:

VirusScannerException - VirusScannerException

VirusFoundException - VirusFoundException

scan

public InputStream scan(InputStream stream)
                 throws VirusScannerException,
                        VirusFoundException

Scan an input stream for virus.

Specified by:

scan in interface VirusScanner

Parameters:

stream - Data stream

Returns:

Return true if a virus was detected else false, when no virus was detected

Throws:

VirusScannerException - This Exception encapsulate any exception

VirusFoundException - This only thrown when a virus was found