org.waarp.gateway.ftp.file

Class FileBasedAuth

java.lang.Object

org.waarp.common.file.filesystembased.FilesystemBasedAuthImpl

org.waarp.ftp.filesystembased.FilesystemBasedFtpAuth

org.waarp.gateway.ftp.file.FileBasedAuth

All Implemented Interfaces:

AuthInterface, FtpAuth, HttpAuthInterface

public class FileBasedAuth
extends FilesystemBasedFtpAuth
implements HttpAuthInterface

FtpAuth implementation based on a list of (user/password/account) stored in a xml file load at startup from configuration.

Field Summary

Fields inherited from class org.waarp.ftp.filesystembased.FilesystemBasedFtpAuth

account

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

isIdentified, password, rootFromAuth, session, user

Constructor Summary

Constructors

Constructor and Description
FileBasedAuth(FtpSession session)

Method Summary

Modifier and Type	Method and Description
protected void	businessClean() Business implementation of clean
AbstractExecutor.CommandExecutor	getCommandExecutor()
long	getSpecialId()
boolean	isAdmin()
boolean	isBusinessPathValid(String newPath) Is the given complete relative Path valid from Authentication/Business point of view.
protected NextCommandReply	setBusinessAccount(String account) Set the account according to any implementation and could set the rootFromAuth.
protected NextCommandReply	setBusinessPassword(String password) Set the password according to any implementation and could set the rootFromAuth.
protected String	setBusinessRootFromAuth()
protected NextCommandReply	setBusinessUser(String user) Set the user according to any implementation and could set the rootFromAuth.
void	setSpecialId(long specialId)
void	specialNoSessionAuth(String hostid) Special Authentication for local execution

Methods inherited from class org.waarp.ftp.filesystembased.FilesystemBasedFtpAuth

clear, getAccount, getBaseDirectory, setAccount, setRootFromAuth

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

getAbsolutePath, getBusinessPath, getRelativePath, getSession, getUser, isIdentified, 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.gateway.kernel.session.HttpAuthInterface

getAccount, setAccount

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

clear, getBaseDirectory, getBusinessPath, getRelativePath, getSession, getUser, isIdentified, setPassword, setUser

Constructor Detail

FileBasedAuth

public FileBasedAuth(FtpSession session)

Parameters:

session -

Method Detail

businessClean

protected final void businessClean()

Description copied from class: FilesystemBasedAuthImpl

Business implementation of clean

Specified by:

businessClean in class FilesystemBasedAuthImpl

setBusinessUser

protected final NextCommandReply setBusinessUser(String user)
                                          throws Reply530Exception

Description copied from class: FilesystemBasedAuthImpl

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

Specified by:

setBusinessUser in class FilesystemBasedAuthImpl

Parameters:

user - the user to set

Returns:

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

Throws:

Reply421Exception - if there is a problem during the authentication

Reply530Exception - if there is a problem during the authentication

setBusinessPassword

protected final NextCommandReply setBusinessPassword(String password)
                                              throws Reply530Exception

Set the password according to any implementation and could set the rootFromAuth. If NOOP is returned, isIdentifed must be TRUE. A special case is implemented for test user.

Specified by:

setBusinessPassword in class FilesystemBasedAuthImpl

Parameters:

password -

Returns:

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

Throws:

Reply421Exception - if there is a problem during the authentication

Reply530Exception - if there is a problem during the authentication

setBusinessAccount

protected final NextCommandReply setBusinessAccount(String account)
                                             throws Reply530Exception

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

Specified by:

setBusinessAccount in class FilesystemBasedFtpAuth

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

isBusinessPathValid

public final boolean isBusinessPathValid(String newPath)

Description copied from interface: AuthInterface

Is the given complete relative Path valid from Authentication/Business point of view.

Specified by:

isBusinessPathValid in interface AuthInterface

Returns:

True if it is Valid

setBusinessRootFromAuth

protected final String setBusinessRootFromAuth()
                                        throws Reply421Exception

Specified by:

setBusinessRootFromAuth in class FilesystemBasedAuthImpl

Returns:

the root relative path from authentication if any or null if the default is used (default is /user or /user/account)

Throws:

Reply421Exception - if the business root is not available

isAdmin

public final boolean isAdmin()

Specified by:

isAdmin in interface AuthInterface

Returns:

True if the current authentication has an admin right (shutdown, bandwidth limitation)

specialNoSessionAuth

public final void specialNoSessionAuth(String hostid)

Special Authentication for local execution

Parameters:

hostid -

getSpecialId

public final long getSpecialId()

Returns:

the specialId

setSpecialId

public final void setSpecialId(long specialId)

Parameters:

specialId - the specialId to set

getCommandExecutor

public final AbstractExecutor.CommandExecutor getCommandExecutor()

Specified by:

getCommandExecutor in interface HttpAuthInterface

Returns:

the associated Command Executor