org.fossilec.odettej
Interface OdetteFTPEntity


public interface OdetteFTPEntity

This is the object representation of a Odette FTP entity, or peer, as defined in the protocol specification. It provide the File Transfer Service layer required for operating in both Speaker or Listener states.

A class instance must be loaded from the Session object. If you would like to start an OdetteFTPEntity as an Initiator you must execute the connect() method, otherwise the acceptConnection() should be invoked to start the class instance as a Responder.

Author:
Rafael Marins

Method Summary
 void abort(EndSessionReason error)
           
 void changeDirection()
           
 void closeFile(int recordCount, long unitCount)
           
 void dataRegime()
           
 void endToEndResponse(java.lang.String datasetName, java.util.Date fileDateTime, java.lang.String destination, java.lang.String originator, java.lang.String userData, java.lang.String reserved)
           
 Session getContext()
           
 boolean isConnected()
           
 void release()
           
 void startFile(VirtualFile file, java.lang.String destination, java.lang.String originator, java.lang.String userData, java.lang.String reserved)
           
 void startSession()
           
 

Method Detail

getContext

Session getContext()

startSession

void startSession()
                  throws OdetteFTPException
Throws:
OdetteFTPException

startFile

void startFile(VirtualFile file,
               java.lang.String destination,
               java.lang.String originator,
               java.lang.String userData,
               java.lang.String reserved)
               throws OdetteFTPException
Throws:
OdetteFTPException

dataRegime

void dataRegime()
                throws OdetteFTPException
Throws:
OdetteFTPException

closeFile

void closeFile(int recordCount,
               long unitCount)
               throws OdetteFTPException
Throws:
OdetteFTPException

changeDirection

void changeDirection()
                     throws OdetteFTPException
Throws:
OdetteFTPException

endToEndResponse

void endToEndResponse(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
Throws:
OdetteFTPException

release

void release()
             throws OdetteFTPException
Throws:
OdetteFTPException

abort

void abort(EndSessionReason error)
           throws OdetteFTPException
Throws:
OdetteFTPException

isConnected

boolean isConnected()
                    throws OdetteFTPException
Throws:
OdetteFTPException


Copyright © 2005 ObjectWeb Consortium. All Rights Reserved.