fr.paris.lutece.portal.service.admin

Class AdminAuthenticationService

java.lang.Object

fr.paris.lutece.portal.service.admin.AdminAuthenticationService

public final class AdminAuthenticationService
extends Object

This class provides a security service to register and check user authentication

Method Summary

Modifier and Type	Method and Description
String	getChangePasswordPageUrl() Returns the modification password 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
static AdminAuthenticationService	getInstance() Get the unique instance of the Security Service
String	getLoginNextUrl(javax.servlet.http.HttpServletRequest request) Returns the url (asked before login) to redirect after login
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
AdminUser	getRegisteredUser(javax.servlet.http.HttpServletRequest request) Gets the Lutece user registered in the Http session
AdminUser	getRemoteUser(javax.servlet.http.HttpServletRequest request) Gets the AdminUser attached to the current Http session
Collection<AdminUser>	getUserListFromModule(String strLastName, String strFirstName, String strEmail) Returns the user list
AdminUser	getUserPublicDataFromModule(String strAccessCode)
String	getViewAccountPageUrl() Returns the view account page URL of the Authentication Service
static void	init() Initialize service
boolean	isDefaultModuleUsed() Check whether the authentication service is configurer on the default module.
boolean	isExternalAuthentication() Returns the authentication type : External or Lutece portal based
void	loginUser(javax.servlet.http.HttpServletRequest request, String strAccessCode, String strPassword) Checks user's login with the Authentication service.
void	logoutUser(javax.servlet.http.HttpServletRequest request) Logout the user
void	registerUser(javax.servlet.http.HttpServletRequest request, AdminUser user) Register the user in the Http session
void	setLoginNextUrl(javax.servlet.http.HttpServletRequest request) Set the admin login next url
void	unregisterUser(javax.servlet.http.HttpServletRequest request) Unregister the user in the Http session

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()

Initialize service

getInstance

public static AdminAuthenticationService getInstance()

Get the unique instance of the Security Service

Returns:

The instance

isDefaultModuleUsed

public boolean isDefaultModuleUsed()

Check whether the authentication service is configurer on the default module.

Returns:

true if the default module is in use, false if another module is used

getRemoteUser

public AdminUser getRemoteUser(javax.servlet.http.HttpServletRequest request)
                        throws UserNotSignedException,
                               AccessDeniedException

Gets the AdminUser attached to the current Http session

Parameters:

request - The Http request

Returns:

A valid AdminUser object if found

Throws:

AccessDeniedException - If the user cannot have access

UserNotSignedException - If the user is not signed

loginUser

public void loginUser(javax.servlet.http.HttpServletRequest request,
                      String strAccessCode,
                      String strPassword)
               throws LoginException

Checks user's login with the Authentication service.

Parameters:

request - The Http request

strAccessCode - The user's login

strPassword - The user's password

Throws:

LoginException - The LoginException

logoutUser

public void logoutUser(javax.servlet.http.HttpServletRequest request)

Logout the user

Parameters:

request - The HTTP request

registerUser

public void registerUser(javax.servlet.http.HttpServletRequest request,
                         AdminUser user)
                  throws AccessDeniedException,
                         UserNotSignedException

Register the user in the Http session

Parameters:

request - The Http request

user - The current user

Throws:

AccessDeniedException - If the user cannot have access

UserNotSignedException - If the user is not signed

unregisterUser

public void unregisterUser(javax.servlet.http.HttpServletRequest request)

Unregister the user in the Http session

Parameters:

request - The Http request

getRegisteredUser

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

Gets the Lutece user registered in the Http session

Parameters:

request - The HTTP request

Returns:

The User registered or null if the user has not been registered

isExternalAuthentication

public boolean isExternalAuthentication()

Returns the authentication type : External or Lutece portal based

Returns:

true if the user is already authenticated or false if it needs to login.

getLoginPageUrl

public String getLoginPageUrl()

Returns the Login page URL of the Authentication Service

Returns:

The URL

getChangePasswordPageUrl

public String getChangePasswordPageUrl()

Returns the modification password page URL of the Authentication Service

Returns:

The URL

getDoLoginUrl

public String getDoLoginUrl()

Returns the DoLogin URL of the Authentication Service

Returns:

The URL

getDoLogoutUrl

public String getDoLogoutUrl()

Returns the DoLogout URL of the Authentication Service

Returns:

The URL

getNewAccountPageUrl

public String getNewAccountPageUrl()

Returns the new account page URL of the Authentication Service

Returns:

The URL

getViewAccountPageUrl

public String getViewAccountPageUrl()

Returns the view account page URL of the Authentication Service

Returns:

The URL

getLostPasswordPageUrl

public String getLostPasswordPageUrl()

Returns the lost password URL of the Authentication Service

Returns:

The URL

getLostLoginPageUrl

public String getLostLoginPageUrl()

Returns the lost login URL of the Authentication Service

Returns:

The URL

getUserListFromModule

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

Returns the user list

Parameters:

strLastName - The last name

strFirstName - The first name

strEmail - The email

Returns:

the collection of all users from the module

getUserPublicDataFromModule

public AdminUser getUserPublicDataFromModule(String strAccessCode)

Parameters:

strAccessCode - The login

Returns:

The AdminUser

setLoginNextUrl

public void setLoginNextUrl(javax.servlet.http.HttpServletRequest request)

Set the admin login next url

Parameters:

request - the HTTP request

getLoginNextUrl

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

Returns the url (asked before login) to redirect after login

Parameters:

request - The Http request

Returns:

The url asked before login