|
DLESE Tools v1.6.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HarvestMessageHandler
Interface that recieves status messages about the progress of an OAI harvest as it occurs.
Harvester
Method Summary | |
---|---|
void |
completedHarvestMessage(int recordCount,
int resumptionCount,
String baseURL,
String set,
long startTime,
long endTime,
String zipFilePathName,
String supportedGranularity,
String deletedRecordSupport)
A final report detailing the result of a successful harvest. |
void |
errorMessage(String msg)
A serios error that occured during the harvest, preventing it from completing. |
int |
getNumRecordsForStatusNotification()
Gets the number of records the Harveser should harvest between sending statusMessage notifications to this HarvestMessageHandler. |
void |
oaiErrorMessage(String oaiError,
String errorMessage,
String supportedGranularity,
String deletedRecordSupport)
A message generated by the harvester when an OAI protocol error has occured. |
void |
setHarvestAttributes(Date from,
Date until)
Sets harvest attributes for this harvest. |
void |
statusMessage(int recordCount,
int resumptionCount)
A status message indicating the number of records currenlty harvested and the number of resumption tokens issued. |
void |
statusMessage(String msg)
A status message indicating an event that took place during the harvest, such as a request made to the data provider. |
Method Detail |
---|
void statusMessage(int recordCount, int resumptionCount)
recordCount
- Number of recrods currently harvested.resumptionCount
- Number of resumption tokens currently issued.getNumRecordsForStatusNotification()
void statusMessage(String msg)
msg
- A harvest status message generated by the harvester.int getNumRecordsForStatusNotification()
statusMessage(String msg)
void setHarvestAttributes(Date from, Date until)
from
- The from date or null if none useduntil
- The until date or null if none usedvoid oaiErrorMessage(String oaiError, String errorMessage, String supportedGranularity, String deletedRecordSupport)
oaiError
- The OAI error code, for example "noRecordsMatch".errorMessage
- The accompanying message returned by the data provider, if any.supportedGranularity
- Supported granularity [days, seconds] or nulldeletedRecordSupport
- Deleted record support [no, transient, persistent] or nullvoid errorMessage(String msg)
msg
- Description of the error.void completedHarvestMessage(int recordCount, int resumptionCount, String baseURL, String set, long startTime, long endTime, String zipFilePathName, String supportedGranularity, String deletedRecordSupport)
recordCount
- The total number of records harvested.resumptionCount
- Number of resumption tokens issued.baseURL
- The baseURL that was harvested.set
- The set that was harvested, or an empty string if none.startTime
- The time the harvest began.endTime
- The time the harvest was completed.zipFilePathName
- The full path to the harvest zip file, or null if none.supportedGranularity
- Supported granularity [days, seconds]deletedRecordSupport
- Deleted record support [no, transient, persistent]
|
DLESE Tools v1.6.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |