com.norconex.collector.http.checksum.impl

Class LastModifiedMetadataChecksummer

java.lang.Object

com.norconex.collector.core.checksum.AbstractMetadataChecksummer

com.norconex.collector.http.checksum.impl.LastModifiedMetadataChecksummer

All Implemented Interfaces:

IMetadataChecksummer, IXMLConfigurable

public class LastModifiedMetadataChecksummer
extends AbstractMetadataChecksummer

Default implementation of IMetadataChecksummer for the Norconex HTTP Collector which simply returns the exact value of the "Last-Modified" HTTP header field, or null if not present.

You have the option to keep the checksum as a document metadata field. When AbstractMetadataChecksummer.setKeep(boolean) is true, the checksum will be stored in the target field name specified. If you do not specify any, it stores it under the metadata field name CollectorMetadata.COLLECTOR_CHECKSUM_METADATA.

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

XML configuration usage:

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

Usage example:

The following will store the last modified date used for checksum purposes in a field called "metaChecksum".

  <metadataChecksummer keep="true" targetField="metaChecksum" />
 

Since:

2.2.0

Author:

Pascal Essiembre

See Also:

GenericMetadataChecksummer

Constructor Summary

Constructors

Constructor and Description
LastModifiedMetadataChecksummer()

Method Summary

Modifier and Type	Method and Description
protected String	doCreateMetaChecksum(Properties metadata)
boolean	equals(Object other)
int	hashCode()
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.
String	toString()

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

createMetadataChecksum, getTargetField, isKeep, loadFromXML, saveToXML, setKeep, setTargetField

Methods inherited from class java.lang.Object

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

Constructor Detail

LastModifiedMetadataChecksummer

public LastModifiedMetadataChecksummer()

Method Detail

doCreateMetaChecksum

protected String doCreateMetaChecksum(Properties metadata)

Specified by:

doCreateMetaChecksum in class 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

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

loadChecksummerFromXML

protected void loadChecksummerFromXML(XMLConfiguration xml)

Specified by:

loadChecksummerFromXML in class AbstractMetadataChecksummer

saveChecksummerToXML

protected void saveChecksummerToXML(EnhancedXMLStreamWriter writer)
                             throws XMLStreamException

Specified by:

saveChecksummerToXML in class AbstractMetadataChecksummer

Throws:

XMLStreamException

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractMetadataChecksummer

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMetadataChecksummer

toString

public String toString()

Overrides:

toString in class AbstractMetadataChecksummer