|
||||||||||
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 | |
---|---|
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 |
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.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 |
isExternalAuthentication()
Indicates that the user should be already authenticated by an external authentication service (ex : Web Server authentication). |
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 |
---|
java.lang.String getAuthServiceName()
java.lang.String getAuthType(javax.servlet.http.HttpServletRequest request)
request
- The HTTP request
LuteceUser login(java.lang.String strUserName, java.lang.String strUserPassword, javax.servlet.http.HttpServletRequest request) throws javax.security.auth.login.LoginException, LoginRedirectException
strUserName
- The usernamestrUserPassword
- The user's passordrequest
- The HttpServletRequest
javax.security.auth.login.LoginException
- If a Login error occured
LoginRedirectException
- If the the login process should be redirectedvoid logout(LuteceUser user)
user
- The userLuteceUser getAnonymousUser()
boolean isUserInRole(LuteceUser user, javax.servlet.http.HttpServletRequest request, java.lang.String strRole)
user
- The userrequest
- The HTTP requeststrRole
- The role name
java.lang.String[] getRolesByUser(LuteceUser user)
user
- The user
boolean isExternalAuthentication()
LuteceUser getHttpAuthenticatedUser(javax.servlet.http.HttpServletRequest request)
request
- The HTTP request
java.lang.String getLoginPageUrl()
java.lang.String getDoLoginUrl()
java.lang.String getDoLogoutUrl()
java.lang.String getNewAccountPageUrl()
java.lang.String getViewAccountPageUrl()
java.lang.String getLostPasswordPageUrl()
java.lang.String getAccessDeniedTemplate()
java.lang.String getAccessControledTemplate()
boolean isUsersListAvailable()
java.util.Collection<LuteceUser> getUsers()
LuteceUser getUser(java.lang.String strUserLogin)
strUserLogin
- the user login
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |