org.picketlink.identity.federation.bindings.wildfly.sp

Class SPFormAuthenticationRequestWrapper

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.picketlink.identity.federation.bindings.wildfly.sp.SPFormAuthenticationRequestWrapper

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class SPFormAuthenticationRequestWrapper
extends HttpServletRequestWrapper

HttpServletRequest wrapper which changes behavior of ServletRequest.getParameter. In case origin getParameter() method returns null and there is a not null instance of {@see FormData), wrapper returns data from FormData instead. Wrapper is a part of the fix of JBEAP-10449.

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
SPFormAuthenticationRequestWrapper(HttpServletRequest request, FormData formData)

Method Summary

Modifier and Type	Method and Description
String	getParameter(String name) The default behavior of this method is to return getParameter(String name) on the wrapped request object.
Map<String,String[]>	getParameterMap() The default behavior of this method is to return getParameterMap() on the wrapped request object.
Enumeration<String>	getParameterNames() The default behavior of this method is to return getParameterNames() on the wrapped request object.
String[]	getParameterValues(String name) The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
Part	getPart(String name) The default behavior of this method is to call getPart on the wrapped request object.
Collection<Part>	getParts() The default behavior of this method is to call getParts on the wrapped request object.

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getHttpServletMapping, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getTrailerFields, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isTrailerFieldsReady, isUserInRole, login, logout, newPushBuilder, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, 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, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Detail

SPFormAuthenticationRequestWrapper

public SPFormAuthenticationRequestWrapper(HttpServletRequest request,
                                          FormData formData)

Method Detail

getParameter

public String getParameter(String name)

Description copied from class: ServletRequestWrapper

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

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class ServletRequestWrapper

Parameters:

name - a String specifying the name of the parameter

Returns:

a String representing the single value of the parameter

See Also:

ServletRequest.getParameterValues(java.lang.String)

getParameterValues

public String[] getParameterValues(String name)

Description copied from class: ServletRequestWrapper

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

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class ServletRequestWrapper

Parameters:

name - a String containing the name of the parameter whose value is requested

Returns:

an array of String objects containing the parameter's values

See Also:

ServletRequest.getParameter(java.lang.String)

getParameterMap

public Map<String,String[]> getParameterMap()

Description copied from class: ServletRequestWrapper

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

Specified by:

getParameterMap in interface ServletRequest

Overrides:

getParameterMap in class ServletRequestWrapper

Returns:

an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

getParameterNames

public Enumeration<String> getParameterNames()

Description copied from class: ServletRequestWrapper

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

Specified by:

getParameterNames in interface ServletRequest

Overrides:

getParameterNames in class ServletRequestWrapper

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getPart

public Part getPart(String name)
             throws IOException,
                    ServletException

Description copied from class: HttpServletRequestWrapper

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

Specified by:

getPart in interface HttpServletRequest

Overrides:

getPart in class HttpServletRequestWrapper

Parameters:

name - the name of the requested Part

Returns:

The Part with the given name, or null if this request is of type multipart/form-data, but does not contain the requested Part

Throws:

IOException - if an I/O error occurred during the retrieval of the requested Part

ServletException - if this request is not of type multipart/form-data

See Also:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()

getParts

public Collection<Part> getParts()
                          throws IOException,
                                 ServletException

Description copied from class: HttpServletRequestWrapper

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

Any changes to the returned Collection must not affect this HttpServletRequestWrapper.

Specified by:

getParts in interface HttpServletRequest

Overrides:

getParts in class HttpServletRequestWrapper

Returns:

a (possibly empty) Collection of the Part components of this request

Throws:

IOException - if an I/O error occurred during the retrieval of the Part components of this request

ServletException - if this request is not of type multipart/form-data

See Also:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()