HarvesterReadyMessage (NetarchiveSuite 7.1 API)

java.lang.Object
- dk.netarkivet.common.distribute.NetarkivetMessage
- - dk.netarkivet.harvester.distribute.HarvesterMessage
  - - dk.netarkivet.harvester.harvesting.distribute.HarvesterReadyMessage

All Implemented Interfaces:

Serializable
```
public class HarvesterReadyMessage
extends HarvesterMessage
implements Serializable
```
The HarvestControllerServer periodically sends HarvesterReadyMessages to the JobDispatcher to notify it whether it is available for processing a job or already processing one.

See Also:

Serialized Form

Field Summary
- Fields inherited from class dk.netarkivet.common.distribute.NetarkivetMessage
  replyOfId

Constructor Summary

Constructors
Constructor Description

HarvesterReadyMessage(String applicationInstanceId, String harvestChannelName)
Builds a new message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(HarvesterMessageVisitor v)`	Should be implemented as a part of the visitor pattern.
`String`	`getApplicationInstanceId()`
`String`	`getHarvestChannelName()`
`String`	`getHostName()`

Methods inherited from class dk.netarkivet.common.distribute.NetarkivetMessage
getErrMsg, getID, getReplyOfId, getReplyTo, getTo, hasBeenSent, isOk, setNotOk, setNotOk, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HarvesterReadyMessage
```
public HarvesterReadyMessage(String applicationInstanceId,
                             String harvestChannelName)
```
    Builds a new message.
    
    Parameters:
    
    harvestChannelName - the channel of jobs crawled by the sender.
    
    applicationInstanceId - the sender's application instance ID.
- Method Detail
  - accept
```
public void accept(HarvesterMessageVisitor v)
```
    Description copied from class: HarvesterMessage
    
    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
  - getHarvestChannelName
```
public String getHarvestChannelName()
```
    Returns:
    
    the associated harvest channel name
  - getApplicationInstanceId
```
public String getApplicationInstanceId()
```
    Returns:
    
    the application instance ID.
  - getHostName
```
public String getHostName()
```
    Returns:
    
    the hostname of the sender.