Class HttpBasicAuthenticationHandler
java.lang.Object
com.jalios.jcms.authentication.AuthenticationHandler
com.jalios.jcms.authentication.handlers.HttpBasicAuthenticationHandler
- All Implemented Interfaces:
PluginComponent,Comparable<AuthenticationHandler>
Authenticates user using HTTP Authorization.
In order to make it work you are responsible to call the method
In order to make it work you are responsible to call the method
setHttpBasicAuthorizationHeader(HttpServletResponse, String) to
trigger a HTTP Authorization response, the handler will deal with
decoding of the next request.- Since:
- jcms-5.7.0
- Author:
- Olivier Jaquemet
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intOrder used by the HttpBasicAuthenticationHandlerFields inherited from class com.jalios.jcms.authentication.AuthenticationHandler
channel, GENERIC_BAD_AUTHENTICATION_MSG -
Method Summary
Modifier and TypeMethodDescriptionstatic final MembercheckAuthenticationFromHTTPAuthorization(javax.servlet.http.HttpServletRequest request) Returns the member corresponding to the HTTP Authorization header available in the request.static final HttpBasicAuthenticationHandlervoidThis method will be called by the AuthenticationManager each time the Channel properties are loaded/reloaded.
You can use it to reload properties that might have been changed.
This method is called during initialization of the AuthenticationManagervoidlogin(AuthenticationContext ctxt) Authenticate a member.static final voidsetHttpBasicAuthorizationHeader(javax.servlet.http.HttpServletResponse response, String realm) Set a 401 status code (UNAUTHORIZED) and add the "WWW-Authenticate" header to the given response using the given realm.
-
Field Details
-
ORDER_BASIC_HTTP_HANDLER
public static final int ORDER_BASIC_HTTP_HANDLEROrder used by the HttpBasicAuthenticationHandler- See Also:
-
-
Method Details
-
getInstance
-
loadProperties
public void loadProperties()Description copied from class:AuthenticationHandlerThis method will be called by the AuthenticationManager each time the Channel properties are loaded/reloaded.
You can use it to reload properties that might have been changed.
This method is called during initialization of the AuthenticationManager- Overrides:
loadPropertiesin classAuthenticationHandler
-
login
Description copied from class:AuthenticationHandlerAuthenticate a member.
This method is invoked by the authentication chain on each request.
A typical implementation of this method would follow the following pattern :- Examine informations required to perform the authentication through
the
AuthenticationContextobject (request, response, login.. etc) - Perform your authentication before chain invokation and set the logged Member
AuthenticationContext.setLoggedMember(com.jalios.jcms.Member) - a) Either invoke the next entity in the chain using
AuthenticationContext.doChain(), - b) or else skip the chain invokation and block other authentication handler of the chain (do this with caution...)
- Perform redirection, set information/warning/error message or any
other process, after chain invokation, using
AuthenticationContext.
Default implementation is to invoke the next handler in the chain.- Overrides:
loginin classAuthenticationHandler- Parameters:
ctxt- theAuthenticationContextused for this login- Throws:
IOException
- Examine informations required to perform the authentication through
the
-
checkAuthenticationFromHTTPAuthorization
public static final Member checkAuthenticationFromHTTPAuthorization(javax.servlet.http.HttpServletRequest request) throws IOException Returns the member corresponding to the HTTP Authorization header available in the request.
http://www.ietf.org/rfc/rfc2617.txt
We only handle the "Basic" Authentication Scheme.- Parameters:
request- the request where to look for HTTP Authorization header- Returns:
- the authenticated member or null if not found
- Throws:
IOException- if the underneath login operation with the userId/password could not be performed- Since:
- jcms-5.5.0
-
setHttpBasicAuthorizationHeader
public static final void setHttpBasicAuthorizationHeader(javax.servlet.http.HttpServletResponse response, String realm) Set a 401 status code (UNAUTHORIZED) and add the "WWW-Authenticate" header to the given response using the given realm.
Use this methods to request an HTTP Authorization using the "Basic" Authentication Scheme.- Parameters:
response- the HttpServletResponse of which to set status and add headerrealm- the Basic Realm to set in the response- Since:
- jcms-5.5.0
-