Package com.xwiki.antivirus

Interface AntivirusLog

@Role
public interface AntivirusLog

Logs an Antivirus incident.

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
Map<String,Map<com.xpn.xwiki.doc.XWikiAttachment,Collection<String>>>	getIncidents(Date date)	Retrieves all the logged incidents that happened after a given date.
void	log(com.xpn.xwiki.doc.XWikiAttachment attachment, Collection<String> infections, String action, String detectionContext, String engineHint)	Logs an incident.

Method Details

log

void log(com.xpn.xwiki.doc.XWikiAttachment attachment,
 Collection<String> infections,
 String action,
 String detectionContext,
 String engineHint)
  throws AntivirusException

Logs an incident.

Parameters:

attachment - the affected attachment

infections - the infections detected for the attachment

action - the action that was taken for the attachment (e.g. "blocked", "deleted", "deleteFailed", "scanFailed")

detectionContext - the context in which the infection was detected (e.g. "upload", "scheduledScan")

engineHint - the engine implementation hint used to detect the infections

Throws:

AntivirusException - in case a problem occurs

getIncidents

@Unstable
Map<String,Map<com.xpn.xwiki.doc.XWikiAttachment,Collection<String>>> getIncidents(Date date)
                                                                            throws org.xwiki.query.QueryException,
com.xpn.xwiki.XWikiException

Retrieves all the logged incidents that happened after a given date.

Parameters:

date - the date representing the lower bound of the incidents

Returns:

the incidents that took place after the specified date, grouped by the incident action (e.g. "blocked", "deleted", "deleteFailed", "scanFailed")

Throws:

org.xwiki.query.QueryException

com.xpn.xwiki.XWikiException

Since:

1.5