fr.paris.lutece.portal.service.security
Interface LuteceAuthentication


public interface LuteceAuthentication

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


Method Summary
 java.lang.String getAccessControledTemplate()
          Returns the template that contains the Access Controled message.
 java.lang.String getAccessDeniedTemplate()
          Returns the template that contains the Access Denied message.
 LuteceUser 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 getDoLoginUrl()
          Returns the DoLogin URL of the Authentication Service
 java.lang.String getDoLogoutUrl()
          Returns the DoLogout URL of the Authentication Service
 LuteceUser getHttpAuthenticatedUser(javax.servlet.http.HttpServletRequest request)
          Returns a Lutece user object if the user is already authenticated in the Http request.
 java.lang.String getIconUrl()
          Icon url
 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 getName()
          Used as Identifier.
 java.lang.String getNewAccountPageUrl()
          Returns the new account page URL of the Authentication Service
 java.lang.String getPluginName()
          Returns the plugin name.
 java.lang.String[] getRolesByUser(LuteceUser user)
          get all roles for this user : - user's roles - user's groups roles
 LuteceUser getUser(java.lang.String strUserLogin)
          Returns user managed by the authentication service if this feature is available.
 java.util.Collection<LuteceUser> getUsers()
          Returns all users managed by the authentication service if this feature is available.
 java.lang.String getViewAccountPageUrl()
          Returns the view account page URL of the Authentication Service
 boolean isDelegatedAuthentication()
          Authentication is done by remote system (like OAuth)
 boolean isExternalAuthentication()
          Indicates that the user should be already authenticated by an external authentication service (ex : Web Server authentication).
 boolean isMultiAuthenticationSupported()
          true when the service provides multi authentication support
 boolean isUserInRole(LuteceUser user, javax.servlet.http.HttpServletRequest request, java.lang.String strRole)
          Checks that the current user is associated to a given role
 boolean isUsersListAvailable()
          Tells whether or not the authentication service can provide a list of all its users
 LuteceUser login(java.lang.String strUserName, java.lang.String strUserPassword, javax.servlet.http.HttpServletRequest request)
          Checks the login
 void logout(LuteceUser user)
          logout the user
 

Method Detail

getAuthServiceName

java.lang.String getAuthServiceName()
Gets the Authentification service name

Returns:
The Service Name

getAuthType

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

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

login

LuteceUser login(java.lang.String strUserName,
                 java.lang.String strUserPassword,
                 javax.servlet.http.HttpServletRequest request)
                 throws javax.security.auth.login.LoginException,
                        LoginRedirectException
Checks the login

Parameters:
strUserName - The username
strUserPassword - The user's passord
request - The HttpServletRequest
Returns:
The login
Throws:
javax.security.auth.login.LoginException - If a Login error occured
LoginRedirectException - If the the login process should be redirected

logout

void logout(LuteceUser user)
logout the user

Parameters:
user - The user

getAnonymousUser

LuteceUser getAnonymousUser()
This method create an anonymous user

Returns:
A LuteceUser object corresponding to an anonymous user

isUserInRole

boolean isUserInRole(LuteceUser user,
                     javax.servlet.http.HttpServletRequest request,
                     java.lang.String strRole)
Checks that the current user is associated to a given role

Parameters:
user - The user
request - The HTTP request
strRole - The role name
Returns:
Returns true if the user is associated to the role, otherwise false

getRolesByUser

java.lang.String[] getRolesByUser(LuteceUser user)
get all roles for this user : - user's roles - user's groups roles

Parameters:
user - The user
Returns:
Array of roles

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.

isDelegatedAuthentication

boolean isDelegatedAuthentication()
Authentication is done by remote system (like OAuth)

Returns:
true if part of the authentication if done by external website, false otherwise.

getHttpAuthenticatedUser

LuteceUser 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

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

Returns:
The URL

getDoLoginUrl

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

Returns:
The URL

getDoLogoutUrl

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

Returns:
The URL

getNewAccountPageUrl

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

Returns:
The URL

getViewAccountPageUrl

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

Returns:
The URL

getLostPasswordPageUrl

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

Returns:
The URL

getAccessDeniedTemplate

java.lang.String getAccessDeniedTemplate()
Returns the template that contains the Access Denied message.

Returns:
The template path

getAccessControledTemplate

java.lang.String getAccessControledTemplate()
Returns the template that contains the Access Controled message.

Returns:
The template path

isUsersListAvailable

boolean isUsersListAvailable()
Tells whether or not the authentication service can provide a list of all its users

Returns:
true if the service can return a users list

getUsers

java.util.Collection<LuteceUser> getUsers()
Returns all users managed by the authentication service if this feature is available.

Returns:
A collection of Lutece users or null if the service doesn't provide a users list

getUser

LuteceUser getUser(java.lang.String strUserLogin)
Returns user managed by the authentication service if this feature is available.

Parameters:
strUserLogin - the user login
Returns:
A Lutece user or null if the service doesn't provide LuteceUser

isMultiAuthenticationSupported

boolean isMultiAuthenticationSupported()
true when the service provides multi authentication support

Returns:
true if multi authentication is supported, false otherwise.

getIconUrl

java.lang.String getIconUrl()
Icon url

Returns:
icon url

getName

java.lang.String getName()
Used as Identifier. MUST be unique.

Returns:
the identifier

getPluginName

java.lang.String getPluginName()
Returns the plugin name.
Used to show (or not) this authentication depending on the plugin status .

Returns:
the plugin name


Copyright © 2011 Mairie de Paris. All Rights Reserved.