org.apache.ftpserver.impl

Interface FtpHandler

All Known Implementing Classes:

DefaultFtpHandler

public interface FtpHandler

Internal class, do not use directly.

Author:

Apache MINA Project

Method Summary

Modifier and Type	Method and Description
void	exceptionCaught(FtpIoSession session, Throwable cause) Invoked when any exception is thrown by user IoHandler implementation or by MINA.
void	init(FtpServerContext context, Listener listener)
void	messageReceived(FtpIoSession session, org.apache.ftpserver.ftplet.FtpRequest request) Invoked when a message is received.
void	messageSent(FtpIoSession session, org.apache.ftpserver.ftplet.FtpReply reply) Invoked when a message written by IoSession.write(Object) is sent out.
void	sessionClosed(FtpIoSession session) Invoked when a connection is closed.
void	sessionCreated(FtpIoSession session) Invoked from an I/O processor thread when a new connection has been created.
void	sessionIdle(FtpIoSession session, org.apache.mina.core.session.IdleStatus status) Invoked with the related IdleStatus when a connection becomes idle.
void	sessionOpened(FtpIoSession session) Invoked when a connection has been opened.

Method Detail

init

void init(FtpServerContext context,
          Listener listener)

sessionCreated

void sessionCreated(FtpIoSession session)
             throws Exception

Invoked from an I/O processor thread when a new connection has been created. Because this method is supposed to be called from the same thread that handles I/O of multiple sessions, please implement this method to perform tasks that consumes minimal amount of time such as socket parameter and user-defined session attribute initialization.

Throws:

Exception

sessionOpened

void sessionOpened(FtpIoSession session)
            throws Exception

Invoked when a connection has been opened. This method is invoked after sessionCreated(FtpIoSession). The biggest difference from sessionCreated(FtpIoSession) is that it's invoked from other thread than an I/O processor thread once thread modesl is configured properly.

Throws:

Exception

sessionClosed

void sessionClosed(FtpIoSession session)
            throws Exception

Invoked when a connection is closed.

Throws:

Exception

sessionIdle

void sessionIdle(FtpIoSession session,
                 org.apache.mina.core.session.IdleStatus status)
          throws Exception

Invoked with the related IdleStatus when a connection becomes idle. This method is not invoked if the transport type is UDP; it's a known bug, and will be fixed in 2.0.

Throws:

Exception

exceptionCaught

void exceptionCaught(FtpIoSession session,
                     Throwable cause)
              throws Exception

Invoked when any exception is thrown by user IoHandler implementation or by MINA. If cause is instanceof IOException, MINA will close the connection automatically.

Throws:

Exception

messageReceived

void messageReceived(FtpIoSession session,
                     org.apache.ftpserver.ftplet.FtpRequest request)
              throws Exception

Invoked when a message is received.

Throws:

Exception

messageSent

void messageSent(FtpIoSession session,
                 org.apache.ftpserver.ftplet.FtpReply reply)
          throws Exception

Invoked when a message written by IoSession.write(Object) is sent out.

Throws:

Exception