Home › Packages › antivirus

Package antivirus

This package contains 18 source unit(s) defining 18 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

Antivirus #sleela 2.5 (lib/antivirus/Antivirus.sleela)

Antivirus class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
policySLScanPolicy policyNo description in source.
adapterSLClamAVAdapter adapterNo description in source.
engineSLScannerEngine engineNo description in source.
localScannerSLLocalScanner localScannerNo description in source.
systemScannerSLSystemScanner systemScannerNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configureClamAVDaemonvoid configureClamAVDaemon(String localEndpoint)No description in source.
configureClamAVOneShotvoid configureClamAVOneShot()No description in source.
assemblevoid assemble()No description in source.
scanLocalSLScanResult scanLocal(String path)No description in source.
authorizeSystemScanvoid authorizeSystemScan(boolean authorized)No description in source.
scanSystemRootSLScanResult scanSystemRoot(String approvedRoot)No description in source.

SLClamAVAdapter #sleela 2.5 (lib/antivirus/SLClamAVAdapter.sleela)

SLClamAVAdapter class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
executableString executableNo description in source.
modeString modeNo description in source.
endpointString endpointNo description in source.
connectedboolean connectedNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configureDaemonvoid configureDaemon(String daemonEndpoint)No description in source.
configureOneShotvoid configureOneShot()No description in source.
selectedExecutableString selectedExecutable()No description in source.
selectedModeString selectedMode()No description in source.
stateString state()No description in source.
isReadyboolean isReady()No description in source.
scanStatusString scanStatus(String targetPath)No description in source.

SLControl #sleela 2.5 (lib/antivirus/SLControl.sleela)

SLControl class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
controllerNameString controllerNameNo description in source.
authorizedboolean authorizedNo description in source.
lockedboolean lockedNo description in source.
securedChangesint securedChangesNo description in source.
lastSecuredSubjectString lastSecuredSubjectNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String name)No description in source.
authorizevoid authorize(boolean granted)Grant or withdraw authorization to secure changes. Fail-closed default.
lockvoid lock()No description in source.
unlockvoid unlock()No description in source.
isAuthorizedboolean isAuthorized()No description in source.
secureChangeboolean secureChange(String subject, String reason)No description in source.
describeString describe()No description in source.

SLCreator #sleela 2.5 (lib/antivirus/SLCreator.sleela)

SLCreator class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
creatorNameString creatorNameNo description in source.
originString originNo description in source.
originatedOnString originatedOnNo description in source.
attestedboolean attestedNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String name, String jurisdiction)No description in source.
attestboolean attest(String onDate)No description in source.
isAttestedboolean isAttested()No description in source.
describeString describe()No description in source.

SLDebianAntivirusProfile #sleela 2.5 (lib/antivirus/platforms/GNU/Linux/Debian/SLDebianAntivirusProfile.sleela)

SLDebianAntivirusProfile class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
brandString brand()No description in source.
nameString name()No description in source.
systemConfigPathString systemConfigPath()No description in source.
userConfigPathString userConfigPath()No description in source.
daemonClientString daemonClient()No description in source.
oneShotClientString oneShotClient()No description in source.
endpointPolicyString endpointPolicy()No description in source.
supportsClamOnAccessboolean supportsClamOnAccess()No description in source.

SLFedoraAntivirusProfile #sleela 2.5 (lib/antivirus/platforms/GNU/Linux/Fedora/SLFedoraAntivirusProfile.sleela)

SLFedoraAntivirusProfile class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
brandString brand()No description in source.
nameString name()No description in source.
systemConfigPathString systemConfigPath()No description in source.
userConfigPathString userConfigPath()No description in source.
daemonClientString daemonClient()No description in source.
oneShotClientString oneShotClient()No description in source.
endpointPolicyString endpointPolicy()No description in source.
supportsClamOnAccessboolean supportsClamOnAccess()No description in source.

SLLocalScanner #sleela 2.5 (lib/antivirus/SLLocalScanner.sleela)

SLLocalScanner class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
engineSLScannerEngine engineNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(SLScannerEngine scannerEngine)No description in source.
scanPathSLScanResult scanPath(String path)No description in source.

SLMacOSAntivirusProfile #sleela 2.5 (lib/antivirus/platforms/Apple/macOS/SLMacOSAntivirusProfile.sleela)

SLMacOSAntivirusProfile class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
brandString brand()No description in source.
nameString name()No description in source.
systemConfigPathString systemConfigPath()No description in source.
userConfigPathString userConfigPath()No description in source.
daemonClientString daemonClient()No description in source.
oneShotClientString oneShotClient()No description in source.
endpointPolicyString endpointPolicy()No description in source.
supportsClamOnAccessboolean supportsClamOnAccess()No description in source.

SLMaterialClaim #sleela 2.5 (lib/antivirus/SLMaterialClaim.sleela)

SLMaterialClaim class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
subjectNameString subjectNameNo description in source.
concernString concernNo description in source.
settledboolean settledNo description in source.
sourcePresentboolean sourcePresentNo description in source.
stateLabelString stateLabelNo description in source.
creatorSLCreator creatorNo description in source.
controlSLControl controlNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String name, String materialConcern)No description in source.
normalizeConcernString normalizeConcern(String c)Only the three dimensions of the material set are valid concerns.
attributeTovoid attributeTo(SLCreator originatingCreator)No description in source.
governWithvoid governWith(SLControl changeControl)No description in source.
declareMaterialboolean declareMaterial(String settledState)No description in source.
isMaterialboolean isMaterial()Is the subject currently a settled, present member of the material set?
admitChangeboolean admitChange(String reason)No description in source.
describeString describe()No description in source.

SLPackage #sleela 2.5 (lib/antivirus/SLPackage.sleela)

SLPackage class

Defines the SLeeLa standard-library package for antivirus.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
packageNameString packageNameNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String name)No description in source.
nameString name()No description in source.
availableboolean available()No description in source.

SLQuarantineManager #sleela 2.5 (lib/antivirus/SLQuarantineManager.sleela)

SLQuarantineManager class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
quarantineRootString quarantineRootNo description in source.
enabledboolean enabledNo description in source.
verifyCopyboolean verifyCopyNo description in source.
auditEnabledboolean auditEnabledNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String root)No description in source.
enablevoid enable()No description in source.
disablevoid disable()No description in source.
isReadyboolean isReady()No description in source.
quarantineStatusString quarantineStatus(String targetPath)No description in source.

SLScannerEngine #sleela 2.5 (lib/antivirus/SLScannerEngine.sleela)

SLScannerEngine class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
policySLScanPolicy policyNo description in source.
adapterSLClamAVAdapter adapterNo description in source.
engineNameString engineNameNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(SLScanPolicy scanPolicy, SLClamAVAdapter scannerAdapter)No description in source.
scanSLScanResult scan(SLScanRequest request)No description in source.

SLScanPolicy #sleela 2.5 (lib/antivirus/SLScanPolicy.sleela)

SLScanPolicy class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
allowSystemScopeboolean allowSystemScopeNo description in source.
followSymbolicLinksboolean followSymbolicLinksNo description in source.
quarantineEnabledboolean quarantineEnabledNo description in source.
failClosedOnEngineErrorboolean failClosedOnEngineErrorNo description in source.
maxFileSizeByteslong maxFileSizeBytesNo description in source.
timeoutSecondslong timeoutSecondsNo description in source.
maxDepthlong maxDepthNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configureDefaultsvoid configureDefaults()No description in source.
permitsboolean permits(SLScanRequest request)No description in source.
canQuarantineboolean canQuarantine()No description in source.

SLScanRequest #sleela 2.5 (lib/antivirus/SLScanRequest.sleela)

SLScanRequest class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
targetPathString targetPathNo description in source.
scopeString scopeNo description in source.
recursiveboolean recursiveNo description in source.
followLinksboolean followLinksNo description in source.
maxFileSizeByteslong maxFileSizeBytesNo description in source.
timeoutSecondslong timeoutSecondsNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String path, String requestedScope)No description in source.
hasTargetboolean hasTarget()No description in source.
isLocalboolean isLocal()No description in source.
isSystemboolean isSystem()No description in source.
isValidboolean isValid()No description in source.

SLScanResult #sleela 2.5 (lib/antivirus/SLScanResult.sleela)

SLScanResult class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
targetPathString targetPathNo description in source.
verdictString verdictNo description in source.
engineString engineNo description in source.
detailString detailNo description in source.
filesScannedlong filesScannedNo description in source.
filesSkippedlong filesSkippedNo description in source.
detectionslong detectionsNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String path, String sourceEngine)No description in source.
markCleanvoid markClean(long scanned, long skipped)No description in source.
markDetectedvoid markDetected(long scanned, long skipped, long count)No description in source.
markErrorvoid markError(String reason)No description in source.
isCleanboolean isClean()No description in source.
hasDetectionboolean hasDetection()No description in source.

SLSystemScanner #sleela 2.5 (lib/antivirus/SLSystemScanner.sleela)

SLSystemScanner class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
engineSLScannerEngine engineNo description in source.
administratorAuthorizedboolean administratorAuthorizedNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(SLScannerEngine scannerEngine)No description in source.
authorizeAdministratorvoid authorizeAdministrator(boolean authorized)No description in source.
scanApprovedRootSLScanResult scanApprovedRoot(String path)No description in source.

SLUbuntuAntivirusProfile #sleela 2.5 (lib/antivirus/platforms/GNU/Linux/Ubuntu/SLUbuntuAntivirusProfile.sleela)

SLUbuntuAntivirusProfile class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
brandString brand()No description in source.
nameString name()No description in source.
systemConfigPathString systemConfigPath()No description in source.
userConfigPathString userConfigPath()No description in source.
daemonClientString daemonClient()No description in source.
oneShotClientString oneShotClient()No description in source.
endpointPolicyString endpointPolicy()No description in source.
supportsClamOnAccessboolean supportsClamOnAccess()No description in source.

SLWindowsAntivirusProfile #sleela 2.5 (lib/antivirus/platforms/Microsoft/Windows/SLWindowsAntivirusProfile.sleela)

SLWindowsAntivirusProfile class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
brandString brand()No description in source.
nameString name()No description in source.
systemConfigPathString systemConfigPath()No description in source.
userConfigPathString userConfigPath()No description in source.
daemonClientString daemonClient()No description in source.
oneShotClientString oneShotClient()No description in source.
endpointPolicyString endpointPolicy()No description in source.
supportsClamOnAccessboolean supportsClamOnAccess()No description in source.