org.apache.ftpserver.impl

Class FtpIoSession

java.lang.Object

org.apache.ftpserver.impl.FtpIoSession

All Implemented Interfaces:

org.apache.mina.core.session.IoSession

public class FtpIoSession
extends Object
implements org.apache.mina.core.session.IoSession

Internal class, do not use directly.

Author:

Apache MINA Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_PREFIX Contains user name between USER and PASS commands

Constructor Summary

Constructors

Constructor and Description
FtpIoSession(org.apache.mina.core.session.IoSession wrappedSession, FtpServerContext context)

Method Summary

Modifier and Type	Method and Description
org.apache.mina.core.future.CloseFuture	close()
org.apache.mina.core.future.CloseFuture	close(boolean immediately)
org.apache.mina.core.future.CloseFuture	closeNow()
org.apache.mina.core.future.CloseFuture	closeOnFlush()
boolean	containsAttribute(Object key)
Object	getAttachment()
Object	getAttribute(Object key)
Object	getAttribute(Object key, Object defaultValue)
Set<Object>	getAttributeKeys()
int	getBothIdleCount()
Certificate[]	getClientCertificates()
org.apache.mina.core.future.CloseFuture	getCloseFuture()
org.apache.mina.core.session.IoSessionConfig	getConfig()
long	getCreationTime()
Object	getCurrentWriteMessage()
org.apache.mina.core.write.WriteRequest	getCurrentWriteRequest()
ServerDataConnectionFactory	getDataConnection()
org.apache.ftpserver.ftplet.DataType	getDataType()
int	getFailedLogins()
long	getFileOffset()
org.apache.ftpserver.ftplet.FileSystemView	getFileSystemView()
org.apache.mina.core.filterchain.IoFilterChain	getFilterChain()
org.apache.ftpserver.ftplet.FtpSession	getFtpletSession()
org.apache.mina.core.service.IoHandler	getHandler()
long	getId()
int	getIdleCount(org.apache.mina.core.session.IdleStatus status)
String	getLanguage()
Date	getLastAccessTime()
long	getLastBothIdleTime()
long	getLastIdleTime(org.apache.mina.core.session.IdleStatus status)
long	getLastIoTime()
long	getLastReaderIdleTime()
long	getLastReadTime()
org.apache.ftpserver.ftplet.FtpReply	getLastReply() Returns the last reply that was sent to the client.
long	getLastWriterIdleTime()
long	getLastWriteTime()
Listener	getListener()
SocketAddress	getLocalAddress()
Date	getLoginTime()
int	getMaxIdleTime()
long	getReadBytes()
double	getReadBytesThroughput()
int	getReaderIdleCount()
long	getReadMessages()
double	getReadMessagesThroughput()
SocketAddress	getRemoteAddress()
org.apache.ftpserver.ftplet.FtpFile	getRenameFrom()
long	getScheduledWriteBytes()
int	getScheduledWriteMessages()
org.apache.mina.core.service.IoService	getService()
SocketAddress	getServiceAddress()
UUID	getSessionId()
org.apache.ftpserver.ftplet.Structure	getStructure()
org.apache.mina.core.service.TransportMetadata	getTransportMetadata()
org.apache.ftpserver.ftplet.User	getUser()
String	getUserArgument()
org.apache.mina.core.write.WriteRequestQueue	getWriteRequestQueue()
int	getWriterIdleCount()
long	getWrittenBytes()
double	getWrittenBytesThroughput()
long	getWrittenMessages()
double	getWrittenMessagesThroughput()
void	increaseFailedLogins()
void	increaseReadDataBytes(int increment) Increase the number of bytes read on the data connection
void	increaseWrittenDataBytes(int increment) Increase the number of bytes written on the data connection
boolean	isActive()
boolean	isBothIdle()
boolean	isClosing()
boolean	isConnected()
boolean	isIdle(org.apache.mina.core.session.IdleStatus status)
boolean	isLoggedIn() Is logged-in
boolean	isReaderIdle()
boolean	isReadSuspended()
boolean	isSecure() Indicates whether the control socket for this session is secure, that is, running over SSL/TLS
boolean	isSecured()
boolean	isWriterIdle()
boolean	isWriteSuspended()
void	logoutUser()
org.apache.mina.core.future.ReadFuture	read()
void	reinitialize()
Object	removeAttribute(Object key)
boolean	removeAttribute(Object key, Object value)
boolean	replaceAttribute(Object key, Object oldValue, Object newValue)
void	resetState()
void	resumeRead()
void	resumeWrite()
Object	setAttachment(Object attachment)
Object	setAttribute(Object key)
Object	setAttribute(Object key, Object value)
Object	setAttributeIfAbsent(Object key)
Object	setAttributeIfAbsent(Object key, Object value)
void	setCurrentWriteRequest(org.apache.mina.core.write.WriteRequest currentWriteRequest)
void	setDataType(org.apache.ftpserver.ftplet.DataType dataType)
void	setFileOffset(long fileOffset)
void	setLanguage(String language)
void	setListener(Listener listener)
void	setLogin(org.apache.ftpserver.ftplet.FileSystemView fsview)
void	setMaxIdleTime(int maxIdleTime)
void	setRenameFrom(org.apache.ftpserver.ftplet.FtpFile renFr)
void	setStructure(org.apache.ftpserver.ftplet.Structure structure)
void	setUser(org.apache.ftpserver.ftplet.User user)
void	setUserArgument(String userArgument)
void	suspendRead()
void	suspendWrite()
void	updateLastAccessTime()
void	updateThroughput(long currentTime, boolean force)
org.apache.mina.core.future.WriteFuture	write(Object message)
org.apache.mina.core.future.WriteFuture	write(Object message, SocketAddress destination)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTRIBUTE_PREFIX

public static final String ATTRIBUTE_PREFIX

Contains user name between USER and PASS commands

See Also:

Constant Field Values

Constructor Detail

FtpIoSession

public FtpIoSession(org.apache.mina.core.session.IoSession wrappedSession,
                    FtpServerContext context)

Method Detail

close

public org.apache.mina.core.future.CloseFuture close()

Specified by:

close in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.close()

close

public org.apache.mina.core.future.CloseFuture close(boolean immediately)

Specified by:

close in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.close(boolean)

closeNow

public org.apache.mina.core.future.CloseFuture closeNow()

Specified by:

closeNow in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.closeNow()

closeOnFlush

public org.apache.mina.core.future.CloseFuture closeOnFlush()

Specified by:

closeOnFlush in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.closeOnFlush()

containsAttribute

public boolean containsAttribute(Object key)

Specified by:

containsAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.containsAttribute(Object)

getAttachment

public Object getAttachment()

Specified by:

getAttachment in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getAttachment()

getAttribute

public Object getAttribute(Object key)

Specified by:

getAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getAttribute(Object)

getAttribute

public Object getAttribute(Object key,
                           Object defaultValue)

Specified by:

getAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getAttribute(Object, Object)

getAttributeKeys

public Set<Object> getAttributeKeys()

Specified by:

getAttributeKeys in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getAttributeKeys()

getBothIdleCount

public int getBothIdleCount()

Specified by:

getBothIdleCount in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getBothIdleCount()

getCloseFuture

public org.apache.mina.core.future.CloseFuture getCloseFuture()

Specified by:

getCloseFuture in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getCloseFuture()

getConfig

public org.apache.mina.core.session.IoSessionConfig getConfig()

Specified by:

getConfig in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getConfig()

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getCreationTime()

getFilterChain

public org.apache.mina.core.filterchain.IoFilterChain getFilterChain()

Specified by:

getFilterChain in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getFilterChain()

getHandler

public org.apache.mina.core.service.IoHandler getHandler()

Specified by:

getHandler in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getHandler()

getId

public long getId()

Specified by:

getId in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getId()

getIdleCount

public int getIdleCount(org.apache.mina.core.session.IdleStatus status)

Specified by:

getIdleCount in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getIdleCount(IdleStatus)

getLastBothIdleTime

public long getLastBothIdleTime()

Specified by:

getLastBothIdleTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLastBothIdleTime()

getLastIdleTime

public long getLastIdleTime(org.apache.mina.core.session.IdleStatus status)

Specified by:

getLastIdleTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLastIdleTime(IdleStatus)

getLastIoTime

public long getLastIoTime()

Specified by:

getLastIoTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLastIoTime()

getLastReadTime

public long getLastReadTime()

Specified by:

getLastReadTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLastReadTime()

getLastReaderIdleTime

public long getLastReaderIdleTime()

Specified by:

getLastReaderIdleTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLastReaderIdleTime()

getLastWriteTime

public long getLastWriteTime()

Specified by:

getLastWriteTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLastWriteTime()

getLastWriterIdleTime

public long getLastWriterIdleTime()

Specified by:

getLastWriterIdleTime in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLastWriterIdleTime()

getLocalAddress

public SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getLocalAddress()

getReadBytes

public long getReadBytes()

Specified by:

getReadBytes in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getReadBytes()

getReadBytesThroughput

public double getReadBytesThroughput()

Specified by:

getReadBytesThroughput in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getReadBytesThroughput()

getReadMessages

public long getReadMessages()

Specified by:

getReadMessages in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getReadMessages()

getReadMessagesThroughput

public double getReadMessagesThroughput()

Specified by:

getReadMessagesThroughput in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getReadMessagesThroughput()

getReaderIdleCount

public int getReaderIdleCount()

Specified by:

getReaderIdleCount in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getReaderIdleCount()

getRemoteAddress

public SocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getRemoteAddress()

getScheduledWriteBytes

public long getScheduledWriteBytes()

Specified by:

getScheduledWriteBytes in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getScheduledWriteBytes()

getScheduledWriteMessages

public int getScheduledWriteMessages()

Specified by:

getScheduledWriteMessages in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getScheduledWriteMessages()

getService

public org.apache.mina.core.service.IoService getService()

Specified by:

getService in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getService()

getServiceAddress

public SocketAddress getServiceAddress()

Specified by:

getServiceAddress in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getServiceAddress()

getTransportMetadata

public org.apache.mina.core.service.TransportMetadata getTransportMetadata()

Specified by:

getTransportMetadata in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getTransportMetadata()

getWriterIdleCount

public int getWriterIdleCount()

Specified by:

getWriterIdleCount in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getWriterIdleCount()

getWrittenBytes

public long getWrittenBytes()

Specified by:

getWrittenBytes in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getWrittenBytes()

getWrittenBytesThroughput

public double getWrittenBytesThroughput()

Specified by:

getWrittenBytesThroughput in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getWrittenBytesThroughput()

getWrittenMessages

public long getWrittenMessages()

Specified by:

getWrittenMessages in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getWrittenMessages()

getWrittenMessagesThroughput

public double getWrittenMessagesThroughput()

Specified by:

getWrittenMessagesThroughput in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getWrittenMessagesThroughput()

isClosing

public boolean isClosing()

Specified by:

isClosing in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isClosing()

isConnected

public boolean isConnected()

Specified by:

isConnected in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isConnected()

isActive

public boolean isActive()

Specified by:

isActive in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isActive()

isIdle

public boolean isIdle(org.apache.mina.core.session.IdleStatus status)

Specified by:

isIdle in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isIdle(IdleStatus)

read

public org.apache.mina.core.future.ReadFuture read()

Specified by:

read in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.read()

removeAttribute

public Object removeAttribute(Object key)

Specified by:

removeAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.removeAttribute(Object)

removeAttribute

public boolean removeAttribute(Object key,
                               Object value)

Specified by:

removeAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.removeAttribute(Object, Object)

replaceAttribute

public boolean replaceAttribute(Object key,
                                Object oldValue,
                                Object newValue)

Specified by:

replaceAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.replaceAttribute(Object, Object, Object)

resumeRead

public void resumeRead()

Specified by:

resumeRead in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.resumeRead()

resumeWrite

public void resumeWrite()

Specified by:

resumeWrite in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.resumeWrite()

setAttachment

public Object setAttachment(Object attachment)

Specified by:

setAttachment in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.setAttachment(Object)

setAttribute

public Object setAttribute(Object key)

Specified by:

setAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.setAttribute(Object)

setAttribute

public Object setAttribute(Object key,
                           Object value)

Specified by:

setAttribute in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.setAttribute(Object, Object)

setAttributeIfAbsent

public Object setAttributeIfAbsent(Object key)

Specified by:

setAttributeIfAbsent in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.setAttributeIfAbsent(Object)

setAttributeIfAbsent

public Object setAttributeIfAbsent(Object key,
                                   Object value)

Specified by:

setAttributeIfAbsent in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.setAttributeIfAbsent(Object, Object)

suspendRead

public void suspendRead()

Specified by:

suspendRead in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.suspendRead()

suspendWrite

public void suspendWrite()

Specified by:

suspendWrite in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.suspendWrite()

write

public org.apache.mina.core.future.WriteFuture write(Object message)

Specified by:

write in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.write(Object)

write

public org.apache.mina.core.future.WriteFuture write(Object message,
                                                     SocketAddress destination)

Specified by:

write in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.write(Object, SocketAddress)

resetState

public void resetState()

getDataConnection

public ServerDataConnectionFactory getDataConnection()

getFileSystemView

public org.apache.ftpserver.ftplet.FileSystemView getFileSystemView()

getUser

public org.apache.ftpserver.ftplet.User getUser()

isLoggedIn

public boolean isLoggedIn()

Is logged-in

getListener

public Listener getListener()

setListener

public void setListener(Listener listener)

getFtpletSession

public org.apache.ftpserver.ftplet.FtpSession getFtpletSession()

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

getUserArgument

public String getUserArgument()

setUser

public void setUser(org.apache.ftpserver.ftplet.User user)

setUserArgument

public void setUserArgument(String userArgument)

getMaxIdleTime

public int getMaxIdleTime()

setMaxIdleTime

public void setMaxIdleTime(int maxIdleTime)

increaseFailedLogins

public void increaseFailedLogins()

getFailedLogins

public int getFailedLogins()

setLogin

public void setLogin(org.apache.ftpserver.ftplet.FileSystemView fsview)

reinitialize

public void reinitialize()

logoutUser

public void logoutUser()

setFileOffset

public void setFileOffset(long fileOffset)

setRenameFrom

public void setRenameFrom(org.apache.ftpserver.ftplet.FtpFile renFr)

getRenameFrom

public org.apache.ftpserver.ftplet.FtpFile getRenameFrom()

getFileOffset

public long getFileOffset()

setStructure

public void setStructure(org.apache.ftpserver.ftplet.Structure structure)

setDataType

public void setDataType(org.apache.ftpserver.ftplet.DataType dataType)

getSessionId

public UUID getSessionId()

See Also:

FtpSession.getSessionId()

getStructure

public org.apache.ftpserver.ftplet.Structure getStructure()

getDataType

public org.apache.ftpserver.ftplet.DataType getDataType()

getLoginTime

public Date getLoginTime()

getLastAccessTime

public Date getLastAccessTime()

getClientCertificates

public Certificate[] getClientCertificates()

updateLastAccessTime

public void updateLastAccessTime()

getCurrentWriteMessage

public Object getCurrentWriteMessage()

Specified by:

getCurrentWriteMessage in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getCurrentWriteMessage()

getCurrentWriteRequest

public org.apache.mina.core.write.WriteRequest getCurrentWriteRequest()

Specified by:

getCurrentWriteRequest in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getCurrentWriteRequest()

isBothIdle

public boolean isBothIdle()

Specified by:

isBothIdle in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isBothIdle()

isReaderIdle

public boolean isReaderIdle()

Specified by:

isReaderIdle in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isReaderIdle()

isWriterIdle

public boolean isWriterIdle()

Specified by:

isWriterIdle in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isWriterIdle()

isSecure

public boolean isSecure()

Indicates whether the control socket for this session is secure, that is, running over SSL/TLS

Returns:

true if the control socket is secured

increaseWrittenDataBytes

public void increaseWrittenDataBytes(int increment)

Increase the number of bytes written on the data connection

Parameters:

increment - The number of bytes written

increaseReadDataBytes

public void increaseReadDataBytes(int increment)

Increase the number of bytes read on the data connection

Parameters:

increment - The number of bytes written

getLastReply

public org.apache.ftpserver.ftplet.FtpReply getLastReply()

Returns the last reply that was sent to the client.

Returns:

the last reply that was sent to the client.

getWriteRequestQueue

public org.apache.mina.core.write.WriteRequestQueue getWriteRequestQueue()

Specified by:

getWriteRequestQueue in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.getWriteRequestQueue()

isReadSuspended

public boolean isReadSuspended()

Specified by:

isReadSuspended in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isReadSuspended()

isWriteSuspended

public boolean isWriteSuspended()

Specified by:

isWriteSuspended in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.isWriteSuspended()

setCurrentWriteRequest

public void setCurrentWriteRequest(org.apache.mina.core.write.WriteRequest currentWriteRequest)

Specified by:

setCurrentWriteRequest in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.setCurrentWriteRequest(WriteRequest)

updateThroughput

public void updateThroughput(long currentTime,
                             boolean force)

Specified by:

updateThroughput in interface org.apache.mina.core.session.IoSession

See Also:

IoSession.updateThroughput(long, boolean)

isSecured

public boolean isSecured()

Specified by:

isSecured in interface org.apache.mina.core.session.IoSession