Skip navigation links
C D E G H I P R S T U V X 

C

ClamavClient - Class in xyz.capybara.clamav
Kotlin ClamAV client
ClamavClient(server, serverPlatform) - Constructor for class xyz.capybara.clamav.ClamavClient
Creates a ClamavClient which will connect to the ClamAV daemon on the given socket address running on the given platform.
ClamavClient(server) - Constructor for class xyz.capybara.clamav.ClamavClient
Creates a ClamavClient which will connect to the ClamAV daemon on the given socket address running on the given platform.
ClamavClient(serverHostname, serverPlatform) - Constructor for class xyz.capybara.clamav.ClamavClient
Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname running on the given platform.
ClamavClient(serverHostname, serverPort, serverPlatform) - Constructor for class xyz.capybara.clamav.ClamavClient
Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port running on the given platform.
ClamavClient(serverHostname, serverPort) - Constructor for class xyz.capybara.clamav.ClamavClient
Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port running on the given platform.
ClamavClient(serverHostname) - Constructor for class xyz.capybara.clamav.ClamavClient
Creates a ClamavClient which will connect to the ClamAV daemon on the given hostname and port running on the given platform.
ClamavClient.Companion - Class in xyz.capybara.clamav
 
ClamavException - Exception in xyz.capybara.clamav
 
ClamavException(cause) - Constructor for exception xyz.capybara.clamav.ClamavException
 
CommunicationException - Exception in xyz.capybara.clamav
 
CommunicationException(cause) - Constructor for exception xyz.capybara.clamav.CommunicationException
 
Companion - Static variable in class xyz.capybara.clamav.ClamavClient
 
component1() - Method in class xyz.capybara.clamav.commands.scan.result.ScanResult.VirusFound
 
copy(foundViruses) - Method in class xyz.capybara.clamav.commands.scan.result.ScanResult.VirusFound
 

D

DEFAULT_SERVER_PLATFORM - Static variable in class xyz.capybara.clamav.ClamavClient
 
DEFAULT_SERVER_PORT - Static variable in class xyz.capybara.clamav.ClamavClient
 

E

equals(p) - Method in class xyz.capybara.clamav.commands.scan.result.ScanResult.VirusFound
 

G

getFoundViruses() - Method in class xyz.capybara.clamav.commands.scan.result.ScanResult.VirusFound
 
getServer() - Method in class xyz.capybara.clamav.ClamavClient
Server socket address
getServerPlatform() - Method in class xyz.capybara.clamav.ClamavClient
Server platform

H

hashCode() - Method in class xyz.capybara.clamav.commands.scan.result.ScanResult.VirusFound
 

I

INSTANCE - Static variable in class xyz.capybara.clamav.commands.scan.result.ScanResult.OK
 
InvalidResponseException - Exception in xyz.capybara.clamav
 
InvalidResponseException(responseString) - Constructor for exception xyz.capybara.clamav.InvalidResponseException
 

P

parallelScan(path) - Method in class xyz.capybara.clamav.ClamavClient
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.
ping() - Method in class xyz.capybara.clamav.ClamavClient
Pings the ClamAV daemon. If a correct response has been received, the method simply returns. Otherwise, a exception ClamavException is thrown.
Platform - Enum in xyz.capybara.clamav
This enum is used to determine the file separator char which will be used when building the path to the file/directory to scan on the server filesystem. The possible values are:
Platform(separator) - Constructor for enum xyz.capybara.clamav.Platform
This enum is used to determine the file separator char which will be used when building the path to the file/directory to scan on the server filesystem. The possible values are:
Platform.JVM_PLATFORM - Class in xyz.capybara.clamav
 
Platform.UNIX - Class in xyz.capybara.clamav
 
Platform.WINDOWS - Class in xyz.capybara.clamav
 

R

reloadVirusDatabases() - Method in class xyz.capybara.clamav.ClamavClient
Triggers the virus databases reloading by the ClamAV daemon

S

scan(inputStream) - Method in class xyz.capybara.clamav.ClamavClient
Scans an InputStream and sends a response as soon as a virus has been found.
scan(path, continueScan) - Method in class xyz.capybara.clamav.ClamavClient
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.
scan(path) - Method in class xyz.capybara.clamav.ClamavClient
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.
ScanFailureException - Exception in xyz.capybara.clamav
 
ScanFailureException(responseString) - Constructor for exception xyz.capybara.clamav.ScanFailureException
 
ScanResult - Class in xyz.capybara.clamav.commands.scan.result
This class holds the result of an antivirus scan. It contains a status and a map filled as following:
ScanResult.OK - Class in xyz.capybara.clamav.commands.scan.result
 
ScanResult.VirusFound - Class in xyz.capybara.clamav.commands.scan.result
 
shutdownServer() - Method in class xyz.capybara.clamav.ClamavClient
Immediately shutdowns the ClamAV daemon
stats() - Method in class xyz.capybara.clamav.ClamavClient
Requests stats from the ClamAV daemon

T

toServerPath(path) - Method in class xyz.capybara.clamav.Platform.JVM_PLATFORM
 
toServerPath(path) - Method in enum xyz.capybara.clamav.Platform
 
toServerPath(path) - Method in class xyz.capybara.clamav.Platform.UNIX
 
toServerPath(path) - Method in class xyz.capybara.clamav.Platform.WINDOWS
 
toString() - Method in class xyz.capybara.clamav.commands.scan.result.ScanResult.VirusFound
 

U

UnknownCommandException - Exception in xyz.capybara.clamav
 
UnknownCommandException(command) - Constructor for exception xyz.capybara.clamav.UnknownCommandException
 
UnsupportedCommandException - Exception in xyz.capybara.clamav
 
UnsupportedCommandException(command) - Constructor for exception xyz.capybara.clamav.UnsupportedCommandException
 

V

version() - Method in class xyz.capybara.clamav.ClamavClient
Requests the version of the ClamAV daemon
VirusFound(foundViruses) - Constructor for class xyz.capybara.clamav.commands.scan.result.ScanResult.VirusFound
 

X

xyz.capybara.clamav - package xyz.capybara.clamav
 
xyz.capybara.clamav.commands.scan.result - package xyz.capybara.clamav.commands.scan.result
 
C D E G H I P R S T U V X 
Skip navigation links