xyz.capybara.clamav

Class ClamavClient

java.lang.Object

xyz.capybara.clamav.ClamavClient

public class ClamavClient
extends Object

Java ClamAV Client

Field Summary

Fields

Modifier and Type	Field and Description
static Platform	DEFAULT_SERVER_PLATFORM
static int	DEFAULT_SERVER_PORT

Constructor Summary

Constructors

Constructor and Description
ClamavClient(InetSocketAddress server) Creates a ClamavClient which will connect to the ClamAV daemon on the given socket address.
ClamavClient(InetSocketAddress server, Platform serverPlatform) Creates a ClamavClient which will connect to the ClamAV daemon on the given socket address running on the given platform.
ClamavClient(String serverHostname) + Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname.
ClamavClient(String serverHostname, int serverPort) Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port.
ClamavClient(String serverHostname, int serverPort, Platform serverPlatform) Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port running on the given platform.
ClamavClient(String serverHostname, Platform serverPlatform) Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname running on the given platform.

Method Summary

Modifier and Type	Method and Description
ScanResult	parallelScan(Path path) Scans a file/directory on the filesystem of the ClamAV daemon and will continue the scan to the end even if a virus has been found.
void	ping() Pings the ClamAV daemon.
void	reloadVirusDatabases() Triggers the virus databases reloading by the ClamAV daemon
ScanResult	scan(InputStream inputStream) Scans an InputStream and sends a response as soon as a virus has been found.
ScanResult	scan(Path path) Scans a file/directory on the filesystem of the ClamAV daemon and sends a response as soon as a virus has been found.
ScanResult	scan(Path path, boolean continueScan) Scans a file/directory on the filesystem of the ClamAV daemon and may continue the scan to the end even if a virus has been found, depending on the continueScan argument.
void	shutdownServer() Immediately shutdowns the ClamAV daemon
String	stats() Requests stats from the ClamAV daemon
String	version() Requests the version of the ClamAV daemon

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SERVER_PORT

public static final int DEFAULT_SERVER_PORT

See Also:

Constant Field Values

DEFAULT_SERVER_PLATFORM

public static final Platform DEFAULT_SERVER_PLATFORM

Constructor Detail

ClamavClient

public ClamavClient(String serverHostname)

+ Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname. Default values:

• Port: 3310
• Platform: the one the JVM is running on

Parameters:

serverHostname - Server hostname

ClamavClient

public ClamavClient(String serverHostname,
                    int serverPort)

Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port. Default values:

• Platform: the one the JVM is running on

Parameters:

serverHostname - Server hostname

serverPort - Server port

ClamavClient

public ClamavClient(String serverHostname,
                    Platform serverPlatform)

Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname running on the given platform. Default values:

• Port: 3310

Parameters:

serverHostname - Server hostname

serverPlatform - Server platform (determines the file path separator to use when launching a file/directory scan on the server filesystem)

ClamavClient

public ClamavClient(String serverHostname,
                    int serverPort,
                    Platform serverPlatform)

Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port running on the given platform.

Parameters:

serverHostname - Server hostname

serverPort - Server port

serverPlatform - Server platform (determines the file path separator to use when launching a file/directory scan on the server filesystem)

ClamavClient

public ClamavClient(InetSocketAddress server)

Creates a ClamavClient which will connect to the ClamAV daemon on the given socket address. Default values:

• Platform: the one the JVM is running on

Parameters:

server - Server socket address (IP address and port or hostname and port)

ClamavClient

public ClamavClient(InetSocketAddress server,
                    Platform serverPlatform)

Creates a ClamavClient which will connect to the ClamAV daemon on the given socket address running on the given platform.

Parameters:

server - Server socket address (IP address and port or hostname and port)

serverPlatform - Server platform (determines the file path separator to use when launching a file/directory scan on the server filesystem)

Method Detail

ping

public void ping()
          throws ClamavException

Pings the ClamAV daemon. If a correct response has been received, the method simply returns. Otherwise, a ClamavException is thrown.

Throws:

ClamavException - Exception holding the real cause of malfunction

version

public String version()
               throws ClamavException

Requests the version of the ClamAV daemon

Returns:

version of the ClamAV daemon

Throws:

ClamavException - Exception holding the real cause of malfunction

stats

public String stats()
             throws ClamavException

Requests stats from the ClamAV daemon

Returns:

multilined String holding various stats given by the ClamAV daemon

Throws:

ClamavException - Exception holding the real cause of malfunction

reloadVirusDatabases

public void reloadVirusDatabases()
                          throws ClamavException

Triggers the virus databases reloading by the ClamAV daemon

Throws:

ClamavException - Exception holding the real cause of malfunction

shutdownServer

public void shutdownServer()
                    throws ClamavException

Immediately shutdowns the ClamAV daemon

Throws:

ClamavException - Exception holding the real cause of malfunction

scan

public ScanResult scan(InputStream inputStream)
                throws ClamavException

Scans an InputStream and sends a response as soon as a virus has been found.

Parameters:

inputStream - inputStream to scan

Returns:

result of the scan

Throws:

ClamavException - Exception holding the real cause of malfunction

scan

public ScanResult scan(Path path)
                throws ClamavException

Scans a file/directory on the filesystem of the ClamAV daemon and sends a response as soon as a virus has been found.

Parameters:

path - absolute path to the file/directory on the filesystem of the ClamAV daemon

Returns:

result of the scan

Throws:

ClamavException - Exception holding the real cause of malfunction

scan

public ScanResult scan(Path path,
                       boolean continueScan)
                throws ClamavException

Scans a file/directory on the filesystem of the ClamAV daemon and may continue the scan to the end even if a virus has been found, depending on the continueScan argument.

Parameters:

path - absolute path to the file/directory on the filesystem of the ClamAV daemon

continueScan - continue the scan to the end even if the virus has been found

Returns:

result of the scan

Throws:

ClamavException - Exception holding the real cause of malfunction

parallelScan

public ScanResult parallelScan(Path path)
                        throws ClamavException

Scans a file/directory on the filesystem of the ClamAV daemon and will continue the scan to the end even if a virus has been found. This method may improve performances on SMP systems by performing a multi-threaded scan.

Parameters:

path - absolute path to the file/directory on the filesystem of the ClamAV daemon

Returns:

result of the scan

Throws:

ClamavException - Exception holding the real cause of malfunction