org.waarp.ftp.filesystembased

Class FilesystemBasedFtpAuth

java.lang.Object

org.waarp.common.file.filesystembased.FilesystemBasedAuthImpl

org.waarp.ftp.filesystembased.FilesystemBasedFtpAuth

All Implemented Interfaces:

AuthInterface, FtpAuth

Direct Known Subclasses:

FileBasedAuth, FileBasedAuth

public abstract class FilesystemBasedFtpAuth
extends FilesystemBasedAuthImpl
implements FtpAuth

Filesystem implementation of a AuthInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected String	account Account name

Fields inherited from class org.waarp.common.file.filesystembased.FilesystemBasedAuthImpl

isIdentified, password, rootFromAuth, session, user

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilesystemBasedFtpAuth(FtpSession session)

Method Summary

Modifier and Type	Method and Description
void	clear() Clean object
String	getAccount()
String	getBaseDirectory() Return the mount point
NextCommandReply	setAccount(String account)
protected abstract NextCommandReply	setBusinessAccount(String account) Set the account according to any implementation and could set the rootFromAuth.
protected void	setRootFromAuth() Set the root relative Path from current status of Authentication (should be the highest level for the current authentication).

Methods inherited from class org.waarp.common.file.filesystembased.FilesystemBasedAuthImpl

businessClean, getAbsolutePath, getBusinessPath, getRelativePath, getSession, getUser, isIdentified, setBusinessPassword, setBusinessRootFromAuth, setBusinessUser, setIsIdentified, setPassword, setUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.waarp.common.file.AuthInterface

getBusinessPath, getRelativePath, getSession, getUser, isAdmin, isBusinessPathValid, isIdentified, setPassword, setUser

Field Detail

account

protected String account

Account name

Constructor Detail

FilesystemBasedFtpAuth

protected FilesystemBasedFtpAuth(FtpSession session)

Parameters:

session -

Method Detail

getAccount

public String getAccount()

Specified by:

getAccount in interface FtpAuth

Returns:

the account

setBusinessAccount

protected abstract NextCommandReply setBusinessAccount(String account)
                                                throws Reply421Exception,
                                                       Reply530Exception,
                                                       Reply502Exception

Set the account according to any implementation and could set the rootFromAuth. If NOOP is returned, isIdentifed must be TRUE.

Parameters:

account -

Returns:

(NOOP, 230) if the Account is OK, else return the following command that must follow and the associated reply

Throws:

Reply421Exception - if there is a problem during the authentication

Reply530Exception - if there is a problem during the authentication

Reply502Exception - if there is a problem during the authentication

setAccount

public NextCommandReply setAccount(String account)
                            throws Reply421Exception,
                                   Reply530Exception,
                                   Reply502Exception

Specified by:

setAccount in interface FtpAuth

Parameters:

account - the account to set

Returns:

(NOOP, 230) if the Account is OK, else return the following command that must follow and the associated reply

Throws:

Reply421Exception - if there is a problem during the authentication

Reply530Exception - if there is a problem during the authentication

Reply502Exception

setRootFromAuth

protected void setRootFromAuth()
                        throws Reply421Exception

Set the root relative Path from current status of Authentication (should be the highest level for the current authentication). If setBusinessRootFromAuth returns null, by default set /user or /user/account.

Overrides:

setRootFromAuth in class FilesystemBasedAuthImpl

Throws:

Reply421Exception - if the business root is not available

clear

public void clear()

Clean object

Specified by:

clear in interface AuthInterface

Overrides:

clear in class FilesystemBasedAuthImpl

getBaseDirectory

public String getBaseDirectory()

Description copied from interface: AuthInterface

Return the mount point

Specified by:

getBaseDirectory in interface AuthInterface

Returns:

the mount point