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

java.lang.Object
  extended by fr.paris.lutece.portal.service.admin.AdminAuthenticationService

public final class AdminAuthenticationService
extends java.lang.Object

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


Method Summary
 java.lang.String getChangePasswordPageUrl()
          Returns the modification password 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
static AdminAuthenticationService getInstance()
          Get the unique instance of the Security Service
 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
 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
 java.util.Collection getUserListFromModule(java.lang.String strLastName, java.lang.String strFirstName, java.lang.String strEmail)
          Returns the user list
 AdminUser getUserPublicDataFromModule(java.lang.String strAccessCode)
           
 java.lang.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, java.lang.String strAccessCode, java.lang.String strPassword)
          Checks user's login with the Authentication service.
 void logoutUser(javax.servlet.http.HttpServletRequest request)
          Logout the user
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

init

public static void init()
                 throws LuteceInitException
Initialize service

Throws:
LuteceInitException

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:
UserNotSignedException - If there is no current user
AccessDeniedException

loginUser

public void loginUser(javax.servlet.http.HttpServletRequest request,
                      java.lang.String strAccessCode,
                      java.lang.String strPassword)
               throws javax.security.auth.login.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:
javax.security.auth.login.LoginException - The LoginException

logoutUser

public void logoutUser(javax.servlet.http.HttpServletRequest request)
Logout the user

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 java.lang.String getLoginPageUrl()
Returns the Login page URL of the Authentication Service

Returns:
The URL

getChangePasswordPageUrl

public java.lang.String getChangePasswordPageUrl()
Returns the modification password page URL of the Authentication Service

Returns:
The URL

getDoLoginUrl

public java.lang.String getDoLoginUrl()
Returns the DoLogin URL of the Authentication Service

Returns:
The URL

getDoLogoutUrl

public java.lang.String getDoLogoutUrl()
Returns the DoLogout URL of the Authentication Service

Returns:
The URL

getNewAccountPageUrl

public java.lang.String getNewAccountPageUrl()
Returns the new account page URL of the Authentication Service

Returns:
The URL

getViewAccountPageUrl

public java.lang.String getViewAccountPageUrl()
Returns the view account page URL of the Authentication Service

Returns:
The URL

getLostPasswordPageUrl

public java.lang.String getLostPasswordPageUrl()
Returns the lost password URL of the Authentication Service

Returns:
The URL

getUserListFromModule

public java.util.Collection getUserListFromModule(java.lang.String strLastName,
                                                  java.lang.String strFirstName,
                                                  java.lang.String strEmail)
Returns the user list

Returns:
the collection of all users from the module

getUserPublicDataFromModule

public AdminUser getUserPublicDataFromModule(java.lang.String strAccessCode)
Parameters:
strAccessCode -
Returns:


Copyright © 2007 Mairie de Paris. All Rights Reserved.