|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LuteceAuthentication
This Interface defines all methods required by an authentication service password is not valid
Method Summary | |
---|---|
boolean |
findResetPassword(javax.servlet.http.HttpServletRequest request,
String strLogin)
Checks if a user's password has been reset |
String |
getAccessControledTemplate()
Returns the template that contains the Access Controled message. |
String |
getAccessDeniedTemplate()
Returns the template that contains the Access Denied message. |
LuteceUser |
getAnonymousUser()
This method creates an anonymous user |
String |
getAuthServiceName()
Gets the Authentification service name |
String |
getAuthType(javax.servlet.http.HttpServletRequest request)
Gets the Authentification type |
String |
getDoLoginUrl()
Returns the DoLogin URL of the Authentication Service |
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. |
String |
getIconUrl()
Icon url |
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 |
getName()
Used as Identifier. |
String |
getNewAccountPageUrl()
Returns the new account page URL of the Authentication Service |
String |
getPluginName()
Returns the plugin name. |
String |
getResetPasswordPageUrl(javax.servlet.http.HttpServletRequest request)
Returns the reset password URL of the Authentication Service |
String[] |
getRolesByUser(LuteceUser user)
get all roles for this user : - user's roles - user's groups roles |
LuteceUser |
getUser(String strUserLogin)
Returns user managed by the authentication service if this feature is available. |
Collection<LuteceUser> |
getUsers()
Returns all users managed by the authentication service if this feature is available. |
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,
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(String strUserName,
String strUserPassword,
javax.servlet.http.HttpServletRequest request)
Checks the login |
void |
logout(LuteceUser user)
logout the user |
void |
updateDateLastLogin(LuteceUser user,
javax.servlet.http.HttpServletRequest request)
Update the last login date of a user |
Method Detail |
---|
String getAuthServiceName()
String getAuthType(javax.servlet.http.HttpServletRequest request)
request
- The HTTP request
LuteceUser login(String strUserName, String strUserPassword, javax.servlet.http.HttpServletRequest request) throws LoginException, LoginRedirectException
strUserName
- The usernamestrUserPassword
- The user's passwordrequest
- The HttpServletRequest
LoginException
- If a Login error occured
LoginRedirectException
- If the the login process should be redirectedvoid logout(LuteceUser user)
user
- The userboolean findResetPassword(javax.servlet.http.HttpServletRequest request, String strLogin)
request
- The requeststrLogin
- the login
LuteceUser getAnonymousUser()
boolean isUserInRole(LuteceUser user, javax.servlet.http.HttpServletRequest request, String strRole)
user
- The userrequest
- The HTTP requeststrRole
- The role name
String[] getRolesByUser(LuteceUser user)
user
- The user
boolean isExternalAuthentication()
boolean isDelegatedAuthentication()
true
if part of the authentication if done by external website,
false
otherwise.LuteceUser getHttpAuthenticatedUser(javax.servlet.http.HttpServletRequest request)
request
- The HTTP request
String getLoginPageUrl()
String getDoLoginUrl()
String getDoLogoutUrl()
String getNewAccountPageUrl()
String getViewAccountPageUrl()
String getLostPasswordPageUrl()
String getLostLoginPageUrl()
String getResetPasswordPageUrl(javax.servlet.http.HttpServletRequest request)
request
- the HTTP request
String getAccessDeniedTemplate()
String getAccessControledTemplate()
boolean isUsersListAvailable()
Collection<LuteceUser> getUsers()
LuteceUser getUser(String strUserLogin)
strUserLogin
- the user login
boolean isMultiAuthenticationSupported()
true
if multi authentication is supported, false
otherwise.String getIconUrl()
String getName()
String getPluginName()
void updateDateLastLogin(LuteceUser user, javax.servlet.http.HttpServletRequest request)
user
- User to updaterequest
- The request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |