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

All Known Implementing Classes:
LuteceDefaultAdminAuthentication

public interface AdminAuthentication

This Interface defines all methods required by an authentication service password is not valid


Method Summary
 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)
          get the list of user to display a list for selection in the main user management page
 AdminUser getUserPublicData(String strAccessCode)
          Get user data
 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
 

Method Detail

getAuthServiceName

String getAuthServiceName()
Gets the Authentification service name

Returns:
The Service Name

getAuthType

String getAuthType(javax.servlet.http.HttpServletRequest request)
Gets the Authentification type

Parameters:
request - The HTTP request
Returns:
The type of authentication

login

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

Parameters:
strAccessCode - The username
strUserPassword - The user's password
request - The HttpServletRequest
Returns:
The login
Throws:
LoginException - The Login Exception

logout

void logout(AdminUser user)
logout the user

Parameters:
user - The user

getAnonymousUser

AdminUser getAnonymousUser()
This method create an anonymous user

Returns:
A AdminUser object corresponding to an anonymous user

isExternalAuthentication

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

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

getHttpAuthenticatedUser

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.

Parameters:
request - The HTTP request
Returns:
Returns A Lutece User

getLoginPageUrl

String getLoginPageUrl()
Returns the Login page URL of the Authentication Service

Returns:
The URL

getChangePasswordPageUrl

String getChangePasswordPageUrl()
Returns the password modification page URL of the Authentication Service

Returns:
The URL

getDoLoginUrl

String getDoLoginUrl()
Returns the DoLogin URL of the Authentication Service

Returns:
The URL

getDoLogoutUrl

String getDoLogoutUrl()
Returns the DoLogout URL of the Authentication Service

Returns:
The URL

getNewAccountPageUrl

String getNewAccountPageUrl()
Returns the new account page URL of the Authentication Service

Returns:
The URL

getViewAccountPageUrl

String getViewAccountPageUrl()
Returns the view account page URL of the Authentication Service

Returns:
The URL

getLostPasswordPageUrl

String getLostPasswordPageUrl()
Returns the lost password URL of the Authentication Service

Returns:
The URL

getLostLoginPageUrl

String getLostLoginPageUrl()
Returns the lost login URL of the Authentication Service

Returns:
The URL

getUserList

Collection<AdminUser> getUserList(String strLastName,
                                  String strFirstName,
                                  String strEmail)
get the list of user to display a list for selection in the main user management page

Parameters:
strLastName - The last name
strFirstName - The first name
strEmail - The email
Returns:
the collection of available users

getUserPublicData

AdminUser getUserPublicData(String strAccessCode)
Get user data

Parameters:
strAccessCode - The access code (login)
Returns:
The admin User


Copyright © 2014 Mairie de Paris. All Rights Reserved.