|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CrowdHttpAuthenticator
This interface is used to manage HTTP authentication. It is the fundamental class for web/SSO authentication integration. This interface contains many convenience methods for authentication integration with existing applications. For most applications, using the following methods will be sufficient to achieve SSO:
authenticate:
authenticate a user.isAuthenticated:
determine if a request is authenticated.getUser:
retrieve the user for an authenticated request.logout:
sign the user out.HttpAuthenticatorFactory to get an
instance of a class, or use an IoC container (like Spring)
to manage the underlying implementation as a singleton.
Method Summary
User
authenticate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String username,
String password)
Authenticates the user based on provided credentials.
User
authenticateWithoutValidatingPassword(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String username)
Authenticates the user without validating password.
String
getToken(javax.servlet.http.HttpServletRequest request)
Retrieves the Crowd authentication token from the request.
User
getUser(javax.servlet.http.HttpServletRequest request)
Attempts to retrieve the currently authenticated User from the request.
boolean
isAuthenticated(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Tests whether a request is authenticated via SSO.
void
logout(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Logs out the authenticated user.
Method Detail
getUser
User getUser(javax.servlet.http.HttpServletRequest request)
throws InvalidTokenException,
ApplicationPermissionException,
InvalidAuthenticationException,
OperationFailedException
- Attempts to retrieve the currently authenticated User from the request.
This will attempt to find the Crowd SSO token via:
- a request attribute (not the request parameter), OR
- a cookie on the request
- Parameters:
request
- HTTP request, possibly containing a Crowd SSO cookie.
- Returns:
- authenticated
User
or null
if the there is no authenticated user.
- Throws:
InvalidTokenException
- if the token in the request is not valid.
ApplicationPermissionException
- if the application is not permitted to perform the requested operation on the server.
InvalidAuthenticationException
- if the application and password are not valid.
OperationFailedException
- if the operation has failed for an unknown reason.
authenticate
User authenticate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String username,
String password)
throws ApplicationPermissionException,
InvalidAuthenticationException,
OperationFailedException,
ApplicationAccessDeniedException,
ExpiredCredentialException,
InactiveAccountException,
InvalidTokenException
- Authenticates the user based on provided credentials.
Validation factors (such as IP address) are extracted from the request.
If the user is successfully authenticated, the Crowd SSO token is placed in:
- the request: as an attribute, so the user is authenticated for the span of the request.
- the response: as a cookie, so the user is authenticated for subsequent requests.
If the credentials fail authentication, any existing Crowd SSO token is removed from:
- the request attribute.
- the response as a cookie as a cookie with a max-age of 0.
- Parameters:
request
- request to set the Crowd SSO tokenresponse
- response to set the Crowd SSO token cookieusername
- username to authenticatepassword
- password of the user
- Returns:
- the authenticated user if the authentication was successful, otherwise an exception is thrown.
- Throws:
ApplicationPermissionException
- if the application is not permitted to perform the requested operation on the server.
InvalidAuthenticationException
- if the application and password are not valid.
OperationFailedException
- if the operation has failed for an unknown reason.
ApplicationAccessDeniedException
ExpiredCredentialException
InactiveAccountException
InvalidTokenException
authenticateWithoutValidatingPassword
User authenticateWithoutValidatingPassword(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String username)
throws ApplicationPermissionException,
InvalidAuthenticationException,
OperationFailedException,
ApplicationAccessDeniedException,
InactiveAccountException,
InvalidTokenException
- Authenticates the user without validating password.
Validation factors (such as IP address) are extracted from the request.
If the user is successfully authenticated, the Crowd SSO token is placed in:
- the request: as an attribute, so the user is authenticated for the span of the request.
- the response: as a cookie, so the user is authenticated for subsequent requests.
If authentication fails, any existing Crowd SSO token is removed from:
- the request attribute.
- the response as a cookie as a cookie with a max-age of 0.
- Parameters:
request
- request to set the Crowd SSO tokenresponse
- response to set the Crowd SSO token cookieusername
- username to authenticate
- Returns:
- the authenticated user if the authentication was successful, otherwise an exception is thrown.
- Throws:
ApplicationPermissionException
- if the application is not permitted to perform the requested operation on the server.
InvalidAuthenticationException
- if the application and password are not valid.
OperationFailedException
- if the operation has failed for an unknown reason.
ApplicationAccessDeniedException
InactiveAccountException
InvalidTokenException
isAuthenticated
boolean isAuthenticated(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws OperationFailedException
- Tests whether a request is authenticated via SSO.
This only tests against the Crowd server if the validation interval is exceeded, this value is obtained from
crowd.properties AND that there is a valid token present for the user in the Crowd Cookie.
The last validated date/time attribute of the request session is updated.
- Parameters:
request
- HttpServletRequestresponse
- HttpServletResponse
- Returns:
true
if and only if the request has been authenticated.
- Throws:
OperationFailedException
- if the operation has failed for an unknown reason.
logout
void logout(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws ApplicationPermissionException,
InvalidAuthenticationException,
OperationFailedException
- Logs out the authenticated user.
Removes the cookie from the response and request attribute. Invalidates the token on the server.
- Parameters:
request
- request contains the Crowd SSO token to invalidate and hence log the user out.response
- response returns a request to remove the token cookie from the user browser.
- Throws:
ApplicationPermissionException
- if the application is not permitted to perform the requested operation on the server.
InvalidAuthenticationException
- if the application and password are not valid.
OperationFailedException
- if the operation has failed for an unknown reason.
getToken
String getToken(javax.servlet.http.HttpServletRequest request)
- Retrieves the Crowd authentication token from the request.
- Parameters:
request
- request to look for the Crowd SSO token.
- Returns:
- value of the token if found, otherwise null.
- Throws:
IllegalArgumentException
- if the request
is null
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
Copyright © 2014 Atlassian. All Rights Reserved.