Package dk.netarkivet.harvester.harvesting.distribute

Class DoOneCrawlMessage

java.lang.Object

dk.netarkivet.common.distribute.NetarkivetMessage

dk.netarkivet.harvester.distribute.HarvesterMessage

dk.netarkivet.harvester.harvesting.distribute.DoOneCrawlMessage

All Implemented Interfaces:

java.io.Serializable

public class DoOneCrawlMessage
extends HarvesterMessage
implements java.io.Serializable

Container for doOneCrawl request. Contains the crawler job definition.

See Also:

Serialized Form

Field Summary

Fields inherited from class dk.netarkivet.common.distribute.NetarkivetMessage

replyOfId

Constructor Summary

Constructors

Constructor	Description
DoOneCrawlMessage(Job submittedJob, ChannelID to, HarvestDefinitionInfo harvestInfo, java.util.List<MetadataEntry> metadata)	A NetarkivetMessage that contains a Job for Heritrix.

Method Summary

Modifier and Type	Method	Description
void	accept(HarvesterMessageVisitor v)	Should be implemented as a part of the visitor pattern.
Job	getJob()
java.util.List<MetadataEntry>	getMetadata()
HarvestDefinitionInfo	getOrigHarvestInfo()
java.lang.String	toString()	Returns a string containing: : To ReplyTo [:error message].

Methods inherited from class dk.netarkivet.common.distribute.NetarkivetMessage

getErrMsg, getID, getReplyOfId, getReplyTo, getTo, hasBeenSent, isOk, setNotOk, setNotOk

Methods inherited from class java.lang.Object

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

Constructor Detail

DoOneCrawlMessage

public DoOneCrawlMessage(Job submittedJob,
                         ChannelID to,
                         HarvestDefinitionInfo harvestInfo,
                         java.util.List<MetadataEntry> metadata)
                  throws ArgumentNotValid

A NetarkivetMessage that contains a Job for Heritrix.

Parameters:

submittedJob - the Job to crawl

to - the ChannelID for the Server

metadata - A list of job-metadata

Throws:

ArgumentNotValid - when submittedJob is null

Method Detail

getJob

public Job getJob()

Returns:

the Job

getOrigHarvestInfo

public HarvestDefinitionInfo getOrigHarvestInfo()

Returns:

the origHarvestInfo

getMetadata

public java.util.List<MetadataEntry> getMetadata()

Returns:

Returns the metadata.

accept

public void accept(HarvesterMessageVisitor v)

Should be implemented as a part of the visitor pattern. fx.: public void accept(HarvesterMessageVisitor v) { v.visit(this); }

Specified by:

accept in class HarvesterMessage

Parameters:

v - A message visitor

toString

public java.lang.String toString()

Description copied from class: NetarkivetMessage

Returns a string containing: : To ReplyTo [:error message].

Overrides:

toString in class NetarkivetMessage

Returns:

a String that represents the message - only for debugging !