xyz.capybara.clamav

Class ClamavClient

xyz.capybara.clamav.ClamavClient

public class ClamavClient

Kotlin ClamAV client

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClamavClient.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static ClamavClient.Companion	Companion
static Platform	DEFAULT_SERVER_PLATFORM
static int	DEFAULT_SERVER_PORT

Constructor Summary

Constructors

Constructor and Description
ClamavClient(java.net.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(java.net.InetSocketAddress server) Creates a ClamavClient which will connect to the ClamAV daemon on the given socket address running on the given platform.
ClamavClient(java.lang.String serverHostname, Platform serverPlatform) Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname running on the given platform.
ClamavClient(java.lang.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(java.lang.String serverHostname, int serverPort) Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port running on the given platform.
ClamavClient(java.lang.String serverHostname) Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port running on the given platform.

Method Summary

Modifier and Type	Method and Description
java.net.InetSocketAddress	getServer() Server socket address
Platform	getServerPlatform() Server platform
ScanResult	parallelScan(java.nio.file.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. This method may improve performances on SMP systems by performing a multi-threaded scan.
void	ping() Pings the ClamAV daemon. If a correct response has been received, the method simply returns. Otherwise, a exception ClamavException is thrown.
void	reloadVirusDatabases() Triggers the virus databases reloading by the ClamAV daemon
ScanResult	scan(java.io.InputStream inputStream) Scans an InputStream and sends a response as soon as a virus has been found.
ScanResult	scan(java.nio.file.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.
ScanResult	scan(java.nio.file.Path path) 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
java.lang.String	stats() Requests stats from the ClamAV daemon
java.lang.String	version() Requests the version of the ClamAV daemon

Field Detail

DEFAULT_SERVER_PORT

public static int DEFAULT_SERVER_PORT

DEFAULT_SERVER_PLATFORM

public static Platform DEFAULT_SERVER_PLATFORM

Companion

public static ClamavClient.Companion Companion

Constructor Detail

ClamavClient

public ClamavClient(java.net.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)

ClamavClient

public ClamavClient(java.net.InetSocketAddress server)

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)

ClamavClient

public ClamavClient(java.lang.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(java.lang.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(java.lang.String serverHostname,
                    int serverPort)

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

ClamavClient

public ClamavClient(java.lang.String serverHostname)

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

Method Detail

ping

public void ping()

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

Throws:

- Exception holding the real cause of malfunction

See Also:

exception ClamavException

version

public java.lang.String version()

Requests the version of the ClamAV daemon

Returns:

version of the ClamAV daemon

Throws:

- Exception holding the real cause of malfunction

stats

public java.lang.String stats()

Requests stats from the ClamAV daemon

Returns:

multilined String holding various stats given by the ClamAV daemon

Throws:

- Exception holding the real cause of malfunction

reloadVirusDatabases

public void reloadVirusDatabases()

Triggers the virus databases reloading by the ClamAV daemon

Throws:

- Exception holding the real cause of malfunction

shutdownServer

public void shutdownServer()

Immediately shutdowns the ClamAV daemon

Throws:

- Exception holding the real cause of malfunction

scan

public ScanResult scan(java.io.InputStream inputStream)

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:

- Exception holding the real cause of malfunction

scan

public ScanResult scan(java.nio.file.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.

Parameters:

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

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

Returns:

result of the scan

Throws:

- Exception holding the real cause of malfunction

scan

public ScanResult scan(java.nio.file.Path path)

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

Returns:

result of the scan

Throws:

- Exception holding the real cause of malfunction

parallelScan

public ScanResult parallelScan(java.nio.file.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. 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:

- Exception holding the real cause of malfunction

getServer

public java.net.InetSocketAddress getServer()

Server socket address

(IP address and port or hostname and port)

getServerPlatform

public Platform getServerPlatform()

Server platform

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