Package org.dspace.ctask.general

Class ClamScan

java.lang.Object

org.dspace.curate.AbstractCurationTask

org.dspace.ctask.general.ClamScan

All Implemented Interfaces:

CurationTask

@Suspendable(invoked=INTERACTIVE)
public class ClamScan
extends AbstractCurationTask

ClamScan.java A set of methods to scan using the clamav daemon. TODO: add a check for the inputstream size limit

Author:

wbossons

Field Summary

Fields

Modifier and Type	Field	Description
protected BitstreamService	bitstreamService
protected final String	CLEAN_MESSAGE
protected final String	CONNECT_FAIL_MESSAGE
protected DataOutputStream	dataOutputStream
protected final int	DEFAULT_CHUNK_SIZE
protected final byte[]	END
protected boolean	failfast
protected String	host
protected final byte[]	IDSESSION
protected final String	INFECTED_MESSAGE
protected final byte[]	INSTREAM
protected final String	NEW_ITEM_HANDLE
protected final byte[]	PING
protected final String	PLUGIN_PREFIX
protected int	port
protected List<String>	results
protected final String	SCAN_FAIL_MESSAGE
protected Socket	socket
protected final byte[]	STATS
protected int	status
protected int	timeout

Fields inherited from class org.dspace.curate.AbstractCurationTask

communityService, configurationService, curator, handleService, itemService, taskId

Constructor Summary

Constructors

Constructor	Description
ClamScan()

Method Summary

Modifier and Type	Method	Description
protected void	closeSession()	closeSession Close the IDSESSION in CLAMD
protected void	formatResults(Item item)
protected String	getItemHandle(Item item)
void	init(Curator curator, String taskId)	Initialize task - parameters inform the task of it's invoking curator.
protected void	logDebugMessage(String message)
protected void	openSession()	openSession This method opens a session.
int	perform(DSpaceObject dso)	Perform the curation task upon passed DSO
protected int	scan(Bitstream bitstream, InputStream inputstream, String itemHandle)	Issue the INSTREAM command and return the response to and from the clamav daemon.

Methods inherited from class org.dspace.curate.AbstractCurationTask

dereference, distribute, perform, performItem, performObject, report, setResult, taskArrayProperty, taskBooleanProperty, taskIntProperty, taskLongProperty, taskProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CHUNK_SIZE

protected final int DEFAULT_CHUNK_SIZE

See Also:

• Constant Field Values

INSTREAM

protected final byte[] INSTREAM

PING

protected final byte[] PING

STATS

protected final byte[] STATS

IDSESSION

protected final byte[] IDSESSION

END

protected final byte[] END

PLUGIN_PREFIX

protected final String PLUGIN_PREFIX

See Also:

• Constant Field Values

INFECTED_MESSAGE

protected final String INFECTED_MESSAGE

See Also:

• Constant Field Values

CLEAN_MESSAGE

protected final String CLEAN_MESSAGE

See Also:

• Constant Field Values

CONNECT_FAIL_MESSAGE

protected final String CONNECT_FAIL_MESSAGE

See Also:

• Constant Field Values

SCAN_FAIL_MESSAGE

protected final String SCAN_FAIL_MESSAGE

See Also:

• Constant Field Values

NEW_ITEM_HANDLE

protected final String NEW_ITEM_HANDLE

See Also:

• Constant Field Values

host

protected String host

port

protected int port

timeout

protected int timeout

failfast

protected boolean failfast

status

protected int status

results

protected List<String> results

socket

protected Socket socket

dataOutputStream

protected DataOutputStream dataOutputStream

bitstreamService

protected BitstreamService bitstreamService

Constructor Details

ClamScan

public ClamScan()

Method Details

init

public void init(Curator curator,
 String taskId)
          throws IOException

Description copied from interface: CurationTask

Initialize task - parameters inform the task of it's invoking curator. Since the curator can provide services to the task, this represents curation DI.

Specified by:

init in interface CurationTask

Overrides:

init in class AbstractCurationTask

Parameters:

curator - the Curator controlling this task

taskId - identifier task should use in invoking services

Throws:

IOException - if error

perform

public int perform(DSpaceObject dso)
            throws IOException

Description copied from interface: CurationTask

Perform the curation task upon passed DSO

Specified by:

perform in interface CurationTask

Specified by:

perform in class AbstractCurationTask

Parameters:

dso - the DSpace object

Returns:

status code

Throws:

IOException - if error

openSession

protected void openSession()
                    throws IOException

openSession This method opens a session.

Throws:

IOException - A general class of exceptions produced by failed or interrupted I/O operations.

closeSession

protected void closeSession()

closeSession Close the IDSESSION in CLAMD

scan

protected int scan(Bitstream bitstream,
 InputStream inputstream,
 String itemHandle)

Issue the INSTREAM command and return the response to and from the clamav daemon.

Parameters:

bitstream - the bitstream for reporting results

inputstream - the InputStream to read

itemHandle - the item handle for reporting results

Returns:

a ScanResult representing the server response

formatResults

protected void formatResults(Item item)
                      throws IOException

Throws:

IOException

getItemHandle

protected String getItemHandle(Item item)

logDebugMessage

protected void logDebugMessage(String message)