org.waarp.openr66.context.authentication

Class R66Auth

java.lang.Object

org.waarp.common.file.filesystembased.FilesystemBasedAuthImpl

org.waarp.openr66.context.authentication.R66Auth

All Implemented Interfaces:

AuthInterface

public class R66Auth
extends FilesystemBasedAuthImpl

Field Summary

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

isIdentified, password, rootFromAuth, session, user

Constructor Summary

Constructors

Constructor and Description
R66Auth(R66Session session)

Method Summary

Modifier and Type	Method and Description
protected void	businessClean() Business implementation of clean
R66Auth	clone() To be able to store a clone of this Authentication
boolean	connection(String hostId, byte[] arg0, boolean isSsl)
boolean	connectionHttps(String hostId, byte[] arg0) connection from HTTPS (no default rights, must be set either as admin or specifically through ROLEs).
String	getBaseDirectory() Return the mount point
RoleDefault	getRole()
static DbHostAuth	getServerAuth(String server)
boolean	isAdmin()
boolean	isBusinessPathValid(String newPath) Is the given complete relative Path valid from Authentication/Business point of view.
boolean	isSsl()
boolean	isValidRole(RoleDefault.ROLE roleCheck)
protected NextCommandReply	setBusinessPassword(String arg0) Set the password according to any implementation and could set the rootFromAuth.
protected String	setBusinessRootFromAuth()
protected NextCommandReply	setBusinessUser(String arg0) Set the user according to any implementation and could set the rootFromAuth.
void	setFromClone(R66Auth source) For same channel, no proxy, authentification from already authenticated channel
protected void	setRootFromAuth() Set the root relative Path from current status of Authentication (should be the highest level for the current authentication).
void	specialNoSessionAuth(boolean isSSL, String hostid) Special Authentication for local execution
String	toString()

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

clear, getAbsolutePath, getBusinessPath, getRelativePath, getSession, getUser, isIdentified, setIsIdentified, setPassword, setUser

Methods inherited from class java.lang.Object

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

Constructor Detail

R66Auth

public R66Auth(R66Session session)

Parameters:

session -

Method Detail

clone

public R66Auth clone()

To be able to store a clone of this Authentication

Overrides:

clone in class Object

Returns:

the clone

setFromClone

public void setFromClone(R66Auth source)

For same channel, no proxy, authentification from already authenticated channel

Parameters:

source -

Throws:

IllegalStateException - if conditions are not valid to create a correct R66Auth

businessClean

protected final void businessClean()

Description copied from class: FilesystemBasedAuthImpl

Business implementation of clean

Specified by:

businessClean in class FilesystemBasedAuthImpl

getBaseDirectory

public final String getBaseDirectory()

Description copied from interface: AuthInterface

Return the mount point

Returns:

the mount point

setBusinessPassword

protected final NextCommandReply setBusinessPassword(String arg0)
                                              throws Reply421Exception

Description copied from class: FilesystemBasedAuthImpl

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

Specified by:

setBusinessPassword in class FilesystemBasedAuthImpl

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

connection

public final boolean connection(String hostId,
                                byte[] arg0,
                                boolean isSsl)
                         throws Reply530Exception,
                                Reply421Exception

Parameters:

hostId -

arg0 -

Returns:

True if the connection is OK (authentication is OK)

Throws:

Reply530Exception - if the authentication is wrong

Reply421Exception - If the service is not available

setRootFromAuth

protected final 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.

Overrides:

setRootFromAuth in class FilesystemBasedAuthImpl

Throws:

Reply421Exception - if the business root is not available

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

setBusinessUser

protected final NextCommandReply setBusinessUser(String arg0)
                                          throws Reply421Exception

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

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

isAdmin

public final boolean isAdmin()

Returns:

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

isValidRole

public final boolean isValidRole(RoleDefault.ROLE roleCheck)

Parameters:

roleCheck -

Returns:

True if the current role contains the specified role to check

isSsl

public final boolean isSsl()

Returns:

True if the associated host is using SSL

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.

Returns:

True if it is Valid

toString

public String toString()

Overrides:

toString in class Object

getServerAuth

public static DbHostAuth getServerAuth(String server)

Parameters:

server -

Returns:

the SimpleAuth if any for this user

specialNoSessionAuth

public final void specialNoSessionAuth(boolean isSSL,
                                       String hostid)

Special Authentication for local execution

Parameters:

isSSL -

hostid -

connectionHttps

public final boolean connectionHttps(String hostId,
                                     byte[] arg0)
                              throws Reply530Exception,
                                     Reply421Exception

connection from HTTPS (no default rights, must be set either as admin or specifically through ROLEs). Only "false client" with port with negative values are allowed.

Parameters:

hostId -

arg0 -

Returns:

True if the connection is OK (authentication is OK)

Throws:

Reply530Exception - if the authentication is wrong

Reply421Exception - If the service is not available

getRole

public final RoleDefault getRole()

Returns:

a copy of the Role of the current authenticated partner