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

java.lang.Object
  extended by fr.paris.lutece.portal.business.user.authentication.LuteceDefaultAdminAuthentication
All Implemented Interfaces:
AdminAuthentication

public class LuteceDefaultAdminAuthentication
extends java.lang.Object
implements AdminAuthentication

Default authentication module for admin authentication


Constructor Summary
LuteceDefaultAdminAuthentication()
           
 
Method Summary
 AdminUser getAnonymousUser()
          This method create an anonymous user
 java.lang.String getAuthServiceName()
          Gets the Authentification service name
 java.lang.String getAuthType(javax.servlet.http.HttpServletRequest request)
          Gets the Authentification type
 java.lang.String getChangePasswordPageUrl()
          Returns the password modification page URL of the Authentication Service
 java.lang.String getDoLoginUrl()
          Returns the DoLogin URL of the Authentication Service
 java.lang.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.
 java.lang.String getLoginPageUrl()
          Returns the Login page URL of the Authentication Service
 java.lang.String getLostPasswordPageUrl()
          Returns the lost password URL of the Authentication Service
 java.lang.String getNewAccountPageUrl()
          Returns the new account page URL of the Authentication Service
 java.util.Collection getUserList(java.lang.String strLastName, java.lang.String strFirstName, java.lang.String strEmail)
          Not used - Return null always for this module
 AdminUser getUserPublicData(java.lang.String strLogin)
          Not used - Return null always for this module
 java.lang.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(java.lang.String strAccessCode, java.lang.String strUserPassword, javax.servlet.http.HttpServletRequest request)
          Checks the login
 void logout(AdminUser user)
          logout the user
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LuteceDefaultAdminAuthentication

public LuteceDefaultAdminAuthentication()
Method Detail

getAuthServiceName

public java.lang.String getAuthServiceName()
Description copied from interface: AdminAuthentication
Gets the Authentification service name

Specified by:
getAuthServiceName in interface AdminAuthentication
Returns:
The Service Name

getAuthType

public java.lang.String getAuthType(javax.servlet.http.HttpServletRequest request)
Description copied from interface: AdminAuthentication
Gets the Authentification type

Specified by:
getAuthType in interface AdminAuthentication
Parameters:
request - The HTTP request
Returns:
The type of authentication

login

public AdminUser login(java.lang.String strAccessCode,
                       java.lang.String strUserPassword,
                       javax.servlet.http.HttpServletRequest request)
                throws javax.security.auth.login.LoginException
Description copied from interface: AdminAuthentication
Checks the login

Specified by:
login in interface AdminAuthentication
Parameters:
strAccessCode - The username
strUserPassword - The user's passord
request - The HttpServletRequest
Returns:
The login
Throws:
javax.security.auth.login.LoginException - The Login Exception

logout

public void logout(AdminUser user)
Description copied from interface: AdminAuthentication
logout the user

Specified by:
logout in interface AdminAuthentication
Parameters:
user - The user

getAnonymousUser

public AdminUser getAnonymousUser()
Description copied from interface: AdminAuthentication
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()
Description copied from interface: AdminAuthentication
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)
Description copied from interface: AdminAuthentication
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 java.lang.String getLoginPageUrl()
Description copied from interface: AdminAuthentication
Returns the Login page URL of the Authentication Service

Specified by:
getLoginPageUrl in interface AdminAuthentication
Returns:
The URL

getChangePasswordPageUrl

public java.lang.String getChangePasswordPageUrl()
Description copied from interface: AdminAuthentication
Returns the password modification page URL of the Authentication Service

Specified by:
getChangePasswordPageUrl in interface AdminAuthentication
Returns:
The URL

getDoLoginUrl

public java.lang.String getDoLoginUrl()
Description copied from interface: AdminAuthentication
Returns the DoLogin URL of the Authentication Service

Specified by:
getDoLoginUrl in interface AdminAuthentication
Returns:
The URL

getDoLogoutUrl

public java.lang.String getDoLogoutUrl()
Description copied from interface: AdminAuthentication
Returns the DoLogout URL of the Authentication Service

Specified by:
getDoLogoutUrl in interface AdminAuthentication
Returns:
The URL

getNewAccountPageUrl

public java.lang.String getNewAccountPageUrl()
Description copied from interface: AdminAuthentication
Returns the new account page URL of the Authentication Service

Specified by:
getNewAccountPageUrl in interface AdminAuthentication
Returns:
The URL

getViewAccountPageUrl

public java.lang.String getViewAccountPageUrl()
Description copied from interface: AdminAuthentication
Returns the view account page URL of the Authentication Service

Specified by:
getViewAccountPageUrl in interface AdminAuthentication
Returns:
The URL

getLostPasswordPageUrl

public java.lang.String getLostPasswordPageUrl()
Description copied from interface: AdminAuthentication
Returns the lost password URL of the Authentication Service

Specified by:
getLostPasswordPageUrl in interface AdminAuthentication
Returns:
The URL

getUserList

public java.util.Collection getUserList(java.lang.String strLastName,
                                        java.lang.String strFirstName,
                                        java.lang.String strEmail)
Not used - Return null always for this module

Specified by:
getUserList in interface AdminAuthentication
Returns:
the collection of available users
See Also:
fr.paris.lutece.portal.business.user.authentication.AdminAuthentication#getUserList()

getUserPublicData

public AdminUser getUserPublicData(java.lang.String strLogin)
Not used - Return null always for this module

Specified by:
getUserPublicData in interface AdminAuthentication
Returns:
See Also:
AdminAuthentication.getUserPublicData(java.lang.String)


Copyright © 2007 Mairie de Paris. All Rights Reserved.