org.fossilec.odettej
Interface ListenerTemplate


public interface ListenerTemplate


Method Summary
 VirtualFile beginStartFile(java.lang.String datasetName, java.util.Date fileDateTime, java.lang.String destination, java.lang.String originator, RecordFormat format, int maxRecordSize, int fileSizeBlocks, long restartPosition, java.lang.String userData, java.lang.String reserved)
          This method must return a Virtual File object linked to the filesystem, which will be used to store receiving records from peer's sending file.
If the
 void fileDelivered(java.lang.String datasetName, java.util.Date fileDateTime, java.lang.String destination, java.lang.String originator, java.lang.String userData, java.lang.String reserved)
          The End to End Response (EERP) command notifies the originator of a Virtual File that it has been successfully delivered to it's final destination.
 boolean hasDeliveredFile(java.lang.String datasetName, java.util.Date fileDateTime, java.lang.String destination, java.lang.String originator)
          This method is invoked after a sucessful receiving a file by the Odette FTP Entity to certify it was delivered.
 AnswerReason requestStartFile(java.lang.String datasetName, java.util.Date fileDateTime, java.lang.String destination, java.lang.String originator, RecordFormat format, int maxRecordSize, int fileSizeBlocks, long restartPosition, java.lang.String userData, java.lang.String reserved)
           
 

Method Detail

requestStartFile

AnswerReason requestStartFile(java.lang.String datasetName,
                              java.util.Date fileDateTime,
                              java.lang.String destination,
                              java.lang.String originator,
                              RecordFormat format,
                              int maxRecordSize,
                              int fileSizeBlocks,
                              long restartPosition,
                              java.lang.String userData,
                              java.lang.String reserved)
                              throws OdetteFTPException
Parameters:
datasetName -
fileDateTime -
destination -
originator -
format -
maxRecordSize -
fileSizeBlocks -
restartPosition -
userData -
reserved -
Returns:
Throws:
OdetteFTPException

beginStartFile

VirtualFile beginStartFile(java.lang.String datasetName,
                           java.util.Date fileDateTime,
                           java.lang.String destination,
                           java.lang.String originator,
                           RecordFormat format,
                           int maxRecordSize,
                           int fileSizeBlocks,
                           long restartPosition,
                           java.lang.String userData,
                           java.lang.String reserved)
                           throws OdetteFTPException
This method must return a Virtual File object linked to the filesystem, which will be used to store receiving records from peer's sending file.
If the

Parameters:
datasetName -
fileDateTime -
destination -
originator -
format -
maxRecordSize -
fileSizeBlocks -
restartPosition -
userData -
reserved -
Returns:
Throws:
OdetteFTPException

hasDeliveredFile

boolean hasDeliveredFile(java.lang.String datasetName,
                         java.util.Date fileDateTime,
                         java.lang.String destination,
                         java.lang.String originator)
                         throws OdetteFTPException
This method is invoked after a sucessful receiving a file by the Odette FTP Entity to certify it was delivered. In case the file is not completely delivered just after the receiving, such as happens in a clearing centers distribution, the user should send the end to end response command manually in a future session.

Parameters:
datasetName -
fileDateTime -
destination -
originator -
Returns:
Throws:
OdetteFTPException

fileDelivered

void fileDelivered(java.lang.String datasetName,
                   java.util.Date fileDateTime,
                   java.lang.String destination,
                   java.lang.String originator,
                   java.lang.String userData,
                   java.lang.String reserved)
                   throws OdetteFTPException
The End to End Response (EERP) command notifies the originator of a Virtual File that it has been successfully delivered to it's final destination. This allows the originator to perform house keeping tasks such as deleting copies of the delivered data. A Response Command must be sent from the location performing the final processing or distribution of the data to the originator. The Response is mandatory and may be sent in the same or in any subsequent session. When an intermediate location broadcasts or distributes a Virtual File it must receive a Response command from all the locations to which it forwarded the data before sending it's own Response. This ensures that the Response received by the Virtual File's originator accounts for all the destination locations. An intermediate location therefore needs to track the status of files it processes over time.

Parameters:
datasetName -
fileDateTime -
destination -
originator -
userData -
reserved -
Throws:
OdetteFTPException


Copyright © 2005 ObjectWeb Consortium. All Rights Reserved.