fr.paris.lutece.portal.business.user.authentication

Class LuteceDefaultAdminAuthentication

java.lang.Object

fr.paris.lutece.portal.business.user.authentication.LuteceDefaultAdminAuthentication

All Implemented Interfaces:

AdminAuthentication

public class LuteceDefaultAdminAuthentication
extends Object
implements AdminAuthentication

Default authentication module for admin authentication

Constructor Summary

Constructors

Constructor and Description
LuteceDefaultAdminAuthentication()

Method Summary

Modifier and Type	Method and Description
AdminUser	getAnonymousUser() This method create an anonymous user
String	getAuthServiceName() Gets the Authentification service name
String	getAuthType(javax.servlet.http.HttpServletRequest request) Gets the Authentification type
String	getChangePasswordPageUrl() Returns the password modification page URL of the Authentication Service
String	getDoLoginUrl() Returns the DoLogin URL of the Authentication Service
String	getDoLogoutUrl() Returns the DoLogout URL of the Authentication Service
AdminUser	getHttpAuthenticatedUser(javax.servlet.http.HttpServletRequest request) Returns a Lutece user object if the user is already authenticated in the Http request.
String	getLoginPageUrl() Returns the Login page URL of the Authentication Service
String	getLostLoginPageUrl() Returns the lost login URL of the Authentication Service
String	getLostPasswordPageUrl() Returns the lost password URL of the Authentication Service
String	getNewAccountPageUrl() Returns the new account page URL of the Authentication Service
Collection<AdminUser>	getUserList(String strLastName, String strFirstName, String strEmail) Not used - Return null always for this module
AdminUser	getUserPublicData(String strLogin) Not used - Return null always for this module
String	getViewAccountPageUrl() Returns the view account page URL of the Authentication Service
boolean	isExternalAuthentication() Indicates that the user should be already authenticated by an external authentication service (ex : Web Server authentication).
AdminUser	login(String strAccessCode, String strUserPassword, javax.servlet.http.HttpServletRequest request) Checks the login
void	logout(AdminUser user) logout the user
void	setDao(ILuteceDefaultAdminUserDAO dao) Setter used by Spring IoC

Methods inherited from class java.lang.Object

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

Constructor Detail

LuteceDefaultAdminAuthentication

public LuteceDefaultAdminAuthentication()

Method Detail

setDao

public void setDao(ILuteceDefaultAdminUserDAO dao)

Setter used by Spring IoC

Parameters:

dao - The DAO (defined in the Spring context)

getAuthServiceName

public String getAuthServiceName()

Gets the Authentification service name

Specified by:

getAuthServiceName in interface AdminAuthentication

Returns:

The Service Name

getAuthType

public String getAuthType(javax.servlet.http.HttpServletRequest request)

Gets the Authentification type

Specified by:

getAuthType in interface AdminAuthentication

Parameters:

request - The HTTP request

Returns:

The type of authentication

login

public AdminUser login(String strAccessCode,
                       String strUserPassword,
                       javax.servlet.http.HttpServletRequest request)
                throws LoginException

Checks the login

Specified by:

login in interface AdminAuthentication

Parameters:

strAccessCode - The username

strUserPassword - The user's password

request - The HttpServletRequest

Returns:

The login

Throws:

LoginException - The Login Exception

logout

public void logout(AdminUser user)

logout the user

Specified by:

logout in interface AdminAuthentication

Parameters:

user - The user

getAnonymousUser

public AdminUser getAnonymousUser()

This method create an anonymous user

Specified by:

getAnonymousUser in interface AdminAuthentication

Returns:

A AdminUser object corresponding to an anonymous user

isExternalAuthentication

public boolean isExternalAuthentication()

Indicates that the user should be already authenticated by an external authentication service (ex : Web Server authentication).

Specified by:

isExternalAuthentication in interface AdminAuthentication

Returns:

true if the authentication is external, false if the authentication is provided by the Lutece portal.

getHttpAuthenticatedUser

public AdminUser getHttpAuthenticatedUser(javax.servlet.http.HttpServletRequest request)

Returns a Lutece user object if the user is already authenticated in the Http request. This method should return null if the user is not authenticated or if the authentication service is not based on Http authentication.

Specified by:

getHttpAuthenticatedUser in interface AdminAuthentication

Parameters:

request - The HTTP request

Returns:

Returns A Lutece User

getLoginPageUrl

public String getLoginPageUrl()

Returns the Login page URL of the Authentication Service

Specified by:

getLoginPageUrl in interface AdminAuthentication

Returns:

The URL

getChangePasswordPageUrl

public String getChangePasswordPageUrl()

Returns the password modification page URL of the Authentication Service

Specified by:

getChangePasswordPageUrl in interface AdminAuthentication

Returns:

The URL

getDoLoginUrl

public String getDoLoginUrl()

Returns the DoLogin URL of the Authentication Service

Specified by:

getDoLoginUrl in interface AdminAuthentication

Returns:

The URL

getDoLogoutUrl

public String getDoLogoutUrl()

Returns the DoLogout URL of the Authentication Service

Specified by:

getDoLogoutUrl in interface AdminAuthentication

Returns:

The URL

getNewAccountPageUrl

public String getNewAccountPageUrl()

Returns the new account page URL of the Authentication Service

Specified by:

getNewAccountPageUrl in interface AdminAuthentication

Returns:

The URL

getViewAccountPageUrl

public String getViewAccountPageUrl()

Returns the view account page URL of the Authentication Service

Specified by:

getViewAccountPageUrl in interface AdminAuthentication

Returns:

The URL

getLostPasswordPageUrl

public String getLostPasswordPageUrl()

Returns the lost password URL of the Authentication Service

Specified by:

getLostPasswordPageUrl in interface AdminAuthentication

Returns:

The URL

getLostLoginPageUrl

public String getLostLoginPageUrl()

Returns the lost login URL of the Authentication Service

Specified by:

getLostLoginPageUrl in interface AdminAuthentication

Returns:

The URL

getUserList

public Collection<AdminUser> getUserList(String strLastName,
                                         String strFirstName,
                                         String strEmail)

Not used - Return null always for this module

Specified by:

getUserList in interface AdminAuthentication

Parameters:

strLastName - The last name

strFirstName - The first name

strEmail - The email

Returns:

null

See Also:

AdminAuthentication.getUserList(String strLastName, String strFirstName, String strEmail )

getUserPublicData

public AdminUser getUserPublicData(String strLogin)

Not used - Return null always for this module

Specified by:

getUserPublicData in interface AdminAuthentication

Parameters:

strLogin - The login

Returns:

null

See Also:

AdminAuthentication.getUserPublicData(java.lang.String)