com.norconex.collector.fs.checksum.impl

Class FileMetadataChecksummer

java.lang.Object

com.norconex.collector.core.checksum.AbstractMetadataChecksummer

com.norconex.collector.fs.checksum.impl.FileMetadataChecksummer

All Implemented Interfaces:

com.norconex.collector.core.checksum.IMetadataChecksummer, IXMLConfigurable

public class FileMetadataChecksummer
extends com.norconex.collector.core.checksum.AbstractMetadataChecksummer

Default implementation of IMetadataChecksummer which by default returns the combined values of FileMetadata.COLLECTOR_LASTMODIFIED and FileMetadata.COLLECTOR_SIZE, separated with an underscore (e.g. "14125443181234_123").

To use different fields (one or several) to constitute a checksum, you can use the GenericMetadataChecksummer.

Since 2.2.0, this implementation can be disabled in your configuration by specifying disabled="true". When disabled, the checksum returned is always null.

XML configuration usage:

  <metadataChecksummer 
      class="com.norconex.collector.fs.checksum.impl.FileMetadataChecksummer"
      disabled="[false|true]"
      keep="[false|true]"
      targetField="(field to store checksum)" />
 

Usage example:

The following will store the generated metadata checksum in a field called "checksum".

  <metadataChecksummer 
      class="com.norconex.collector.fs.checksum.impl.FileMetadataChecksummer"
      keep="true" targetField="checksum" />
 

Author:

Pascal Essiembre

See Also:

GenericMetadataChecksummer

Constructor Summary

Constructors

Constructor and Description
FileMetadataChecksummer()

Method Summary

Modifier and Type	Method and Description
protected String	doCreateMetaChecksum(Properties metadata)
boolean	isDisabled() Whether this checksummer is disabled or not.
protected void	loadChecksummerFromXML(XMLConfiguration xml)
protected void	saveChecksummerToXML(EnhancedXMLStreamWriter writer)
void	setDisabled(boolean disabled) Sets whether this checksummer is disabled or not.

Methods inherited from class com.norconex.collector.core.checksum.AbstractMetadataChecksummer

createMetadataChecksum, equals, getTargetField, hashCode, isKeep, loadFromXML, saveToXML, setKeep, setTargetField, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FileMetadataChecksummer

public FileMetadataChecksummer()

Method Detail

doCreateMetaChecksum

protected String doCreateMetaChecksum(Properties metadata)

Specified by:

doCreateMetaChecksum in class com.norconex.collector.core.checksum.AbstractMetadataChecksummer

isDisabled

public boolean isDisabled()

Whether this checksummer is disabled or not. When disabled, not checksum will be created (the checksum will be null).

Returns:

true if disabled

Since:

2.2.0

setDisabled

public void setDisabled(boolean disabled)

Sets whether this checksummer is disabled or not. When disabled, not checksum will be created (the checksum will be null).

Parameters:

disabled - true if disabled

Since:

2.2.0

loadChecksummerFromXML

protected void loadChecksummerFromXML(XMLConfiguration xml)

Specified by:

loadChecksummerFromXML in class com.norconex.collector.core.checksum.AbstractMetadataChecksummer

saveChecksummerToXML

protected void saveChecksummerToXML(EnhancedXMLStreamWriter writer)
                             throws XMLStreamException

Specified by:

saveChecksummerToXML in class com.norconex.collector.core.checksum.AbstractMetadataChecksummer

Throws:

XMLStreamException