com.communote.common.virusscan.impl

Class ClamAVScanner

java.lang.Object

com.communote.common.virusscan.impl.ClamAVScanner

All Implemented Interfaces:

VirusScanner

public class ClamAVScanner
extends Object
implements VirusScanner

This class represents an anti virus scanner. The input stream or byte content will be scanned by a clamav daemon(TCP/IP).

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_TIMEOUT_PROP TCP / IP Connection time out
static String	HOST_PROP Host where the clamav daemon is listening
static String	PORT_PROP Port where daemon is listening
static String	TEMP_DIR_PROP Directory for temporary files

Constructor Summary

Constructors

Constructor and Description
ClamAVScanner() This constructor is necessary for reflection else you will get an ClassNotFoundException by the VirusScannerFactory

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

TEMP_DIR_PROP

public static final String TEMP_DIR_PROP

Directory for temporary files

See Also:

Constant Field Values

HOST_PROP

public static final String HOST_PROP

Host where the clamav daemon is listening

See Also:

Constant Field Values

PORT_PROP

public static final String PORT_PROP

Port where daemon is listening

See Also:

Constant Field Values

CONNECTION_TIMEOUT_PROP

public static final String CONNECTION_TIMEOUT_PROP

TCP / IP Connection time out

See Also:

Constant Field Values

Constructor Detail

ClamAVScanner

public ClamAVScanner()

This constructor is necessary for reflection else you will get an ClassNotFoundException by the VirusScannerFactory

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