com.communote.common.virusscan

Interface VirusScanner

All Known Implementing Classes:

ClamAVScanner, CommandlineScanner, NoneVirusScanner

public interface VirusScanner

Virus scanner interface.

Author:

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

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.

Method Detail

init

void init(Properties properties)
   throws InitializeException

Initialize the Scanner

Parameters:

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

Throws:

InitializeException - Thrown when initialization fails

scan

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

Scan a byte array for viruses

Parameters:

bytes - Byte content

Throws:

VirusScannerException - This Exception encapsulate any exception

VirusFoundException - VirusScannerException

scan

void scan(File file)
   throws VirusScannerException,
          VirusFoundException

Scan file for virus

Parameters:

file - Scanning file

Throws:

VirusScannerException - VirusScannerException

VirusFoundException - VirusFoundException

scan

InputStream scan(InputStream stream)
          throws VirusScannerException,
                 VirusFoundException

Scan an input stream for virus.

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