org.neociclo.odetteftp.support
Class InOutSharedQueueOftplet

java.lang.Object
  extended by org.neociclo.odetteftp.oftplet.OftpletAdapter
      extended by org.neociclo.odetteftp.support.InOutSharedQueueOftplet
All Implemented Interfaces:
Oftplet

public class InOutSharedQueueOftplet
extends OftpletAdapter
implements Oftplet

Version:
$Rev: 818 $ $Date: 2010-10-20 22:18:00 -0200 (Wed, 20 Oct 2010) $
Author:
Rafael Marins

Constructor Summary
InOutSharedQueueOftplet(OdetteFtpConfiguration config, MappedCallbackHandler callbackHandler, Queue<OdetteFtpObject> outgoing, Queue<OdetteFtpObject> outgoingDone, Queue<OdetteFtpObject> incoming)
           
 
Method Summary
 OftpletListener getListener()
           
 SecurityContext getSecurityContext()
           
 OftpletSpeaker getSpeaker()
           
 void init(OdetteFtpSession s)
          Called by the Oftplet container to indicate that it is placed into service.
 boolean isProtocolVersionSupported(OdetteFtpVersion version)
           
 void onExceptionCaught(Throwable cause)
          Callback method called on event of an unexpected exception during the communication session and while performing file transfer.
 void onSessionEnd()
          Callback method indicating protocol release of End Session (ESID) command - normal or abnormal protocol termination.
 void onSessionStart()
           
 void setEventListener(OftpletEventListener eventListener)
           
 
Methods inherited from class org.neociclo.odetteftp.oftplet.OftpletAdapter
destroy
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.neociclo.odetteftp.oftplet.Oftplet
destroy
 

Constructor Detail

InOutSharedQueueOftplet

public InOutSharedQueueOftplet(OdetteFtpConfiguration config,
                               MappedCallbackHandler callbackHandler,
                               Queue<OdetteFtpObject> outgoing,
                               Queue<OdetteFtpObject> outgoingDone,
                               Queue<OdetteFtpObject> incoming)
Method Detail

getSecurityContext

public SecurityContext getSecurityContext()
Specified by:
getSecurityContext in interface Oftplet
Overrides:
getSecurityContext in class OftpletAdapter

init

public void init(OdetteFtpSession s)
          throws OdetteFtpException
Description copied from interface: Oftplet
Called by the Oftplet container to indicate that it is placed into service.

The implementation of this method might set up the given session in the context with parameters configuration for the initial handshaking (SSID).

Specified by:
init in interface Oftplet
Overrides:
init in class OftpletAdapter
Throws:
OdetteFtpException

isProtocolVersionSupported

public boolean isProtocolVersionSupported(OdetteFtpVersion version)
Specified by:
isProtocolVersionSupported in interface Oftplet
Overrides:
isProtocolVersionSupported in class OftpletAdapter
Returns:

getListener

public OftpletListener getListener()
Specified by:
getListener in interface Oftplet
Overrides:
getListener in class OftpletAdapter

getSpeaker

public OftpletSpeaker getSpeaker()
Specified by:
getSpeaker in interface Oftplet
Overrides:
getSpeaker in class OftpletAdapter

setEventListener

public void setEventListener(OftpletEventListener eventListener)

onSessionStart

public void onSessionStart()
Specified by:
onSessionStart in interface Oftplet
Overrides:
onSessionStart in class OftpletAdapter

onSessionEnd

public void onSessionEnd()
Description copied from interface: Oftplet
Callback method indicating protocol release of End Session (ESID) command - normal or abnormal protocol termination.

There ISN'T a corresponding onSessionStart() method but the Oftplet#init(OdetteFtpContext) method can be used with similar way, since it's invoked when the protocol session is just created.

Specified by:
onSessionEnd in interface Oftplet
Overrides:
onSessionEnd in class OftpletAdapter

onExceptionCaught

public void onExceptionCaught(Throwable cause)
Description copied from interface: Oftplet
Callback method called on event of an unexpected exception during the communication session and while performing file transfer. The Oftplet might check the current ODETTE-FTP entity state and if in the circumstance of file transfer when handling the exceptions thrown.

Specified by:
onExceptionCaught in interface Oftplet
Overrides:
onExceptionCaught in class OftpletAdapter


ACCORD