FirstSpirit Virus Scan Example Module

This module is an example for a virus scanner using different pluggable scanner engines. Its repository consists of four subprojects:

• service-api: The main service interface visible on the global server-classpath
• service: Actual service implementation on the module-classpath
• clamav-engine: Sample engine using the ClamAV malware detection toolkit
• module: Packages an FSM file containing the artifacts mentioned above

For more information on the module implementation, please see the official documentation.

Usage

After installing the module using the ServerManager, enable the service and verify its configuration. The next time a file is uploaded into a project, it will be scanned using the selected engine.

Developing Custom Scanner Engines

In order to make another scanner engine available on the server, either add it to this module or build a second module containing just the scanner engine as a public component. In the latter case, add the service-api jar to the compile-classpath of the new project.