org.waarp.gateway.kernel.session

Class DefaultHttpAuth

java.lang.Object

org.waarp.gateway.kernel.session.DefaultHttpAuth

All Implemented Interfaces:

AuthInterface, HttpAuthInterface

public class DefaultHttpAuth
extends Object
implements HttpAuthInterface

Allow all default implementation

If an authentication is needed, then it will have to use an implementation compatible with the Security of the IT that needs it.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	account Account name
protected boolean	isIdentified Is Identified
protected String	password Password
protected SessionInterface	session SessionInterface
protected String	user User name

Constructor Summary

Constructors

Constructor and Description
DefaultHttpAuth(SessionInterface session)

Method Summary

Modifier and Type	Method and Description
void	clear() Clean object
String	getAccount()
String	getBaseDirectory() Return the mount point
String	getBusinessPath() Return the relative path for this account according to the Business (without true root of mount).
CommandExecutorInterface	getCommandExecutor()
String	getRelativePath(String file) Return the relative path from a file (without mount point)
SessionInterface	getSession()
String	getUser()
boolean	isAdmin()
boolean	isBusinessPathValid(String newPath) Is the given complete relative Path valid from Authentication/Business point of view.
boolean	isIdentified() Is the current Authentication OK for full identification.
NextCommandReply	setAccount(String account)
NextCommandReply	setPassword(String password)
NextCommandReply	setUser(String user)

Methods inherited from class java.lang.Object

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

Field Detail

user

protected String user

User name

password

protected String password

Password

account

protected String account

Account name

isIdentified

protected final boolean isIdentified

Is Identified

session

protected final SessionInterface session

SessionInterface

Constructor Detail

DefaultHttpAuth

public DefaultHttpAuth(SessionInterface session)

Parameters:

session -

Method Detail

getSession

public SessionInterface getSession()

Specified by:

getSession in interface AuthInterface

Returns:

the Ftp SessionInterface

setUser

public NextCommandReply setUser(String user)
                         throws Reply421Exception,
                                Reply530Exception

Specified by:

setUser in interface AuthInterface

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

getUser

public String getUser()

Specified by:

getUser in interface AuthInterface

Returns:

the user

setPassword

public NextCommandReply setPassword(String password)
                             throws Reply421Exception,
                                    Reply530Exception

Specified by:

setPassword in interface AuthInterface

Parameters:

password - the password to set

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

isIdentified

public boolean isIdentified()

Description copied from interface: AuthInterface

Is the current Authentication OK for full identification. It must be true after a correct sequence of identification: At most, it is true when setAccount is OK. It could be positive before (user name only, user+password only).
In the current implementation, as USER+PASS+ACCT are needed, it will be true only after a correct ACCT.

Specified by:

isIdentified in interface AuthInterface

Returns:

True if the user has a positive login, else False

isAdmin

public boolean isAdmin()

Specified by:

isAdmin in interface AuthInterface

Returns:

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

isBusinessPathValid

public 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

getBusinessPath

public String getBusinessPath()

Description copied from interface: AuthInterface

Return the relative path for this account according to the Business (without true root of mount).

Specified by:

getBusinessPath in interface AuthInterface

Returns:

Return the relative path for this account

getBaseDirectory

public String getBaseDirectory()

Description copied from interface: AuthInterface

Return the mount point

Specified by:

getBaseDirectory in interface AuthInterface

Returns:

the mount point

getRelativePath

public String getRelativePath(String file)

Description copied from interface: AuthInterface

Return the relative path from a file (without mount point)

Specified by:

getRelativePath in interface AuthInterface

Parameters:

file - (full path with mount point)

Returns:

the relative path from a file

clear

public void clear()

Description copied from interface: AuthInterface

Clean object

Specified by:

clear in interface AuthInterface

getAccount

public String getAccount()

Specified by:

getAccount in interface HttpAuthInterface

Returns:

the account

setAccount

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

Specified by:

setAccount in interface HttpAuthInterface

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

getCommandExecutor

public CommandExecutorInterface getCommandExecutor()

Specified by:

getCommandExecutor in interface HttpAuthInterface

Returns:

the CommandExecutor associated with the current Auth