org.picketlink.http.internal

Class PicketLinkHttpServletRequest

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.picketlink.http.internal.PicketLinkHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class PicketLinkHttpServletRequest
extends HttpServletRequestWrapper

PicketLink wrapper to HttpServletRequest instances.

This class provides a better integration with Servlet API.

Author:

Pedro Igor

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
PicketLinkHttpServletRequest(HttpServletRequest request, Identity identity, DefaultLoginCredentials credentials, PartitionManager partitionManager, ELProcessor elProcessor)

Method Summary

Methods

Modifier and Type	Method and Description
String	getRequestURI() The default behavior of this method is to return getRequestURI() on the wrapped request object.
Principal	getUserPrincipal() The default behavior of this method is to return getUserPrincipal() on the wrapped request object.
boolean	isUserInRole(String roleName) The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.
void	login(String username, String password) The default behavior of this method is to call login on the wrapped request object.
void	logout() The default behavior of this method is to call login on the wrapped request object.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURL, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Detail

PicketLinkHttpServletRequest

public PicketLinkHttpServletRequest(HttpServletRequest request,
                            Identity identity,
                            DefaultLoginCredentials credentials,
                            PartitionManager partitionManager,
                            ELProcessor elProcessor)

Method Detail

login

public void login(String username,
         String password)
           throws ServletException

Description copied from class: HttpServletRequestWrapper

The default behavior of this method is to call login on the wrapped request object.

Specified by:

login in interface HttpServletRequest

Overrides:

login in class HttpServletRequestWrapper

Parameters:

username - The String value corresponding to the login identifier of the user.

password - The password String corresponding to the identified user.

Throws:

ServletException - if the configured login mechanism does not support username password authentication, or if a non-null caller identity had already been established (prior to the call to login), or if validation of the provided username and password fails.

logout

public void logout()
            throws ServletException

Description copied from class: HttpServletRequestWrapper

The default behavior of this method is to call login on the wrapped request object.

Specified by:

logout in interface HttpServletRequest

Overrides:

logout in class HttpServletRequestWrapper

Throws:

ServletException - if logout fails

getUserPrincipal

public Principal getUserPrincipal()

Description copied from class: HttpServletRequestWrapper

The default behavior of this method is to return getUserPrincipal() on the wrapped request object.

Specified by:

getUserPrincipal in interface HttpServletRequest

Overrides:

getUserPrincipal in class HttpServletRequestWrapper

Returns:

a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

getRequestURI

public String getRequestURI()

Description copied from class: HttpServletRequestWrapper

The default behavior of this method is to return getRequestURI() on the wrapped request object.

Specified by:

getRequestURI in interface HttpServletRequest

Overrides:

getRequestURI in class HttpServletRequestWrapper

Returns:

a String containing the part of the URL from the protocol name up to the query string

See Also:

HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)

isUserInRole

public boolean isUserInRole(String roleName)

Description copied from class: HttpServletRequestWrapper

The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.

Specified by:

isUserInRole in interface HttpServletRequest

Overrides:

isUserInRole in class HttpServletRequestWrapper

Parameters:

roleName - a String specifying the name of the role

Returns:

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated