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:

org.waarp.common.file.AuthInterface, org.waarp.ftp.core.file.FtpAuth, org.waarp.gateway.kernel.session.HttpAuthInterface

public class FileBasedAuth
extends org.waarp.ftp.filesystembased.FilesystemBasedFtpAuth
implements org.waarp.gateway.kernel.session.HttpAuthInterface

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

Author:

Frederic Bregier

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(org.waarp.ftp.core.session.FtpSession session)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	businessClean()
org.waarp.gateway.kernel.exec.AbstractExecutor.CommandExecutor	getCommandExecutor()
long	getSpecialId()
boolean	isAdmin()
boolean	isBusinessPathValid(String newPath)
protected org.waarp.common.command.NextCommandReply	setBusinessAccount(String account) Set the account according to any implementation and could set the rootFromAuth.
protected org.waarp.common.command.NextCommandReply	setBusinessPassword(String password) Set the password according to any implementation and could set the rootFromAuth.
protected String	setBusinessRootFromAuth()
protected org.waarp.common.command.NextCommandReply	setBusinessUser(String user)
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

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(org.waarp.ftp.core.session.FtpSession session)

Parameters:

session -

Method Detail

businessClean

protected void businessClean()

Specified by:

businessClean in class org.waarp.common.file.filesystembased.FilesystemBasedAuthImpl

setBusinessUser

protected org.waarp.common.command.NextCommandReply setBusinessUser(String user)
                                                             throws org.waarp.common.command.exception.Reply421Exception,
                                                                    org.waarp.common.command.exception.Reply530Exception

Specified by:

setBusinessUser in class org.waarp.common.file.filesystembased.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:

org.waarp.common.command.exception.Reply421Exception - if there is a problem during the authentication

org.waarp.common.command.exception.Reply530Exception - if there is a problem during the authentication

setBusinessPassword

protected org.waarp.common.command.NextCommandReply setBusinessPassword(String password)
                                                                 throws org.waarp.common.command.exception.Reply421Exception,
                                                                        org.waarp.common.command.exception.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 org.waarp.common.file.filesystembased.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:

org.waarp.common.command.exception.Reply421Exception - if there is a problem during the authentication

org.waarp.common.command.exception.Reply530Exception - if there is a problem during the authentication

setBusinessAccount

protected org.waarp.common.command.NextCommandReply setBusinessAccount(String account)
                                                                throws org.waarp.common.command.exception.Reply421Exception,
                                                                       org.waarp.common.command.exception.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 org.waarp.ftp.filesystembased.FilesystemBasedFtpAuth

Parameters:

account -

Returns:

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

Throws:

org.waarp.common.command.exception.Reply421Exception - if there is a problem during the authentication

org.waarp.common.command.exception.Reply530Exception - if there is a problem during the authentication

isBusinessPathValid

public boolean isBusinessPathValid(String newPath)

Specified by:

isBusinessPathValid in interface org.waarp.common.file.AuthInterface

setBusinessRootFromAuth

protected String setBusinessRootFromAuth()
                                  throws org.waarp.common.command.exception.Reply421Exception

Specified by:

setBusinessRootFromAuth in class org.waarp.common.file.filesystembased.FilesystemBasedAuthImpl

Throws:

org.waarp.common.command.exception.Reply421Exception

isAdmin

public boolean isAdmin()

Specified by:

isAdmin in interface org.waarp.common.file.AuthInterface

specialNoSessionAuth

public void specialNoSessionAuth(String hostid)

Special Authentication for local execution

Parameters:

hostid -

getSpecialId

public long getSpecialId()

Returns:

the specialId

setSpecialId

public void setSpecialId(long specialId)

Parameters:

specialId - the specialId to set

getCommandExecutor

public org.waarp.gateway.kernel.exec.AbstractExecutor.CommandExecutor getCommandExecutor()

Specified by:

getCommandExecutor in interface org.waarp.gateway.kernel.session.HttpAuthInterface

Returns:

the associated Command Executor