Package net.shibboleth.sp.messaging

Class RemotedHttpServletRequest

java.lang.Object

net.shibboleth.sp.messaging.RemotedHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

@NotThreadSafe
public class RemotedHttpServletRequest
extends Object
implements HttpServletRequest

Wraps a DDF object reflecting a remoted message encapsulating an HTTP request.

Potential TODOs are noted in various places. One outstanding issue is header case. The SP code never did case-folding of the header names, so we may need to adjust that on the C++ side to force-lower them in transit and then lower them on access.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RemotedHttpServletRequest.BodyInputStream	Helper class cribbed from Spring.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BODY	Field holding body.
static final String	CONTENT_LENGTH	Field holding content length.
static final String	CONTENT_TYPE	Field holding content type.
private List<Cookie>	cookies	Cookie array.
private CharsetDecoder	decoder	Decoder to apply to byte array data.
private static final byte[]	EMPTY_BODY	Empty byte array for empty bodies.
static final String	HEADERS	Field holding headers.
static final String	HOSTNAME	Field holding server hostname.
static final String	LOCAL_ADDR	Field holding client address.
static final String	METHOD	Field holding method.
private final DDF	obj	Underlying object containing remoted data.
private Map<String,String[]>	parameters	Parameter map.
static final String	PORT	Field holding port.
static final String	PROTOCOL	Field holding protocol.
static final String	QUERY_STRING	Field holding query string.
private String	reconstructedURL	Cached, reconstructed URL from component parts.
static final String	REMOTE_ADDR	Field holding client address.
static final String	REMOTE_USER	Field holding REMOTE_USER.
static final String	REQUEST_URI	Field holding request URI (path without query string).
static final String	SCHEME	Field holding scheme.
static final String	STRUCTURE_NAME	Field holding name of DDF structure containing request.
private static final CharsetDecoder	UTF_8	UTF-8 decoder.

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor	Description
RemotedHttpServletRequest(DDF ddf)	Constructor for UTF-8 usage.
RemotedHttpServletRequest(DDF ddf, CharsetDecoder dec)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(HttpServletResponse response)
String	changeSessionId()
static String	decodeUnsafeString(byte[] buffer, CharsetDecoder decoder, Character delim)	Helper method to decode a byte array via a designated encoding.
AsyncContext	getAsyncContext()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
long	getContentLengthLong()
String	getContentType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String name)
DDF	getDDF()	Gets the underlying object containing the remoted data.
DispatcherType	getDispatcherType()
String	getHeader(String name)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String name)
ServletInputStream	getInputStream()
int	getIntHeader(String name)
String	getLocalAddr()
Locale	getLocale()
Enumeration<Locale>	getLocales()
String	getLocalName()
int	getLocalPort()
String	getMethod()
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
Part	getPart(String name)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getProtocolRequestId()
String	getQueryString()
BufferedReader	getReader()
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
RequestDispatcher	getRequestDispatcher(String path)
String	getRequestedSessionId()
String	getRequestId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
ServletConnection	getServletConnection()
ServletContext	getServletContext()
String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean create)
Principal	getUserPrincipal()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String role)
void	login(String username, String password)
void	logout()
void	removeAttribute(String name)
void	setAttribute(String name, Object o)
void	setCharacterEncoding(String enc)
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest servletRequest, ServletResponse servletResponse)
<T extends HttpUpgradeHandler> T	upgrade(Class<T> handlerClass)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.http.HttpServletRequest

getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

Methods inherited from interface jakarta.servlet.ServletRequest

setCharacterEncoding

Field Details

STRUCTURE_NAME

@Nonnull
@NotEmpty
public static final String STRUCTURE_NAME

Field holding name of DDF structure containing request.

See Also:

• Constant Field Values

REQUEST_URI

@Nonnull
@NotEmpty
public static final String REQUEST_URI

Field holding request URI (path without query string).

See Also:

• Constant Field Values

SCHEME

@Nonnull
@NotEmpty
public static final String SCHEME

Field holding scheme.

See Also:

• Constant Field Values

PORT

@Nonnull
@NotEmpty
public static final String PORT

Field holding port.

See Also:

• Constant Field Values

METHOD

@Nonnull
@NotEmpty
public static final String METHOD

Field holding method.

See Also:

• Constant Field Values

PROTOCOL

@Nonnull
@NotEmpty
public static final String PROTOCOL

Field holding protocol.

See Also:

• Constant Field Values

HOSTNAME

@Nonnull
@NotEmpty
public static final String HOSTNAME

Field holding server hostname.

See Also:

• Constant Field Values

REMOTE_ADDR

@Nonnull
@NotEmpty
public static final String REMOTE_ADDR

Field holding client address.

See Also:

• Constant Field Values

REMOTE_USER

@Nonnull
@NotEmpty
public static final String REMOTE_USER

Field holding REMOTE_USER.

See Also:

• Constant Field Values

LOCAL_ADDR

@Nonnull
@NotEmpty
public static final String LOCAL_ADDR

Field holding client address.

See Also:

• Constant Field Values

QUERY_STRING

@Nonnull
@NotEmpty
public static final String QUERY_STRING

Field holding query string.

See Also:

• Constant Field Values

BODY

@Nonnull
@NotEmpty
public static final String BODY

Field holding body.

See Also:

• Constant Field Values

CONTENT_TYPE

@Nonnull
@NotEmpty
public static final String CONTENT_TYPE

Field holding content type.

See Also:

• Constant Field Values

CONTENT_LENGTH

@Nonnull
@NotEmpty
public static final String CONTENT_LENGTH

Field holding content length.

See Also:

• Constant Field Values

HEADERS

@Nonnull
@NotEmpty
public static final String HEADERS

Field holding headers.

See Also:

• Constant Field Values

EMPTY_BODY

@Nonnull
private static final byte[] EMPTY_BODY

Empty byte array for empty bodies.

UTF_8

@Nonnull
private static final CharsetDecoder UTF_8

UTF-8 decoder.

obj

@Nonnull
private final DDF obj

Underlying object containing remoted data.

reconstructedURL

@Nullable
private String reconstructedURL

Cached, reconstructed URL from component parts.

decoder

@Nonnull
private CharsetDecoder decoder

Decoder to apply to byte array data.

cookies

@NonnullElements
private List<Cookie> cookies

Cookie array.

parameters

@Nullable
private Map<String,String[]> parameters

Parameter map.

Constructor Details

RemotedHttpServletRequest

public RemotedHttpServletRequest(@Nonnull
 DDF ddf)

Constructor for UTF-8 usage.

Parameters:

ddf - remoted request information

RemotedHttpServletRequest

public RemotedHttpServletRequest(@Nonnull
 DDF ddf,
 @Nonnull
 CharsetDecoder dec)

Constructor.

Parameters:

ddf - remoted request information

dec - a backup decoder if UTF-8 fails

Method Details

getDDF

@Nonnull
public DDF getDDF()

Gets the underlying object containing the remoted data.

Returns:

remoted data object

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface ServletRequest

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String enc)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface ServletRequest

Throws:

UnsupportedEncodingException

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface ServletRequest

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletRequest

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Throws:

IOException

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface ServletRequest

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface ServletRequest

getParameterMap

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

Specified by:

getParameterMap in interface ServletRequest

getRequestId

public String getRequestId()

Specified by:

getRequestId in interface ServletRequest

getProtocolRequestId

public String getProtocolRequestId()

Specified by:

getProtocolRequestId in interface ServletRequest

getServletConnection

public ServletConnection getServletConnection()

Specified by:

getServletConnection in interface ServletRequest

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

getScheme

public String getScheme()

Specified by:

getScheme in interface ServletRequest

getServerName

public String getServerName()

Specified by:

getServerName in interface ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface ServletRequest

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Throws:

IOException

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

setAttribute

public void setAttribute(String name,
 Object o)

Specified by:

setAttribute in interface ServletRequest

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface ServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletRequest

getLocales

public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ServletRequest

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface ServletRequest

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface ServletRequest

getServletContext

public ServletContext getServletContext()

Specified by:

getServletContext in interface ServletRequest

startAsync

public AsyncContext startAsync()
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

startAsync

public AsyncContext startAsync(ServletRequest servletRequest,
 ServletResponse servletResponse)
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletRequest

getAsyncContext

public AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface ServletRequest

getDispatcherType

public DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface ServletRequest

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface HttpServletRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface HttpServletRequest

getHeaders

public Enumeration<String> getHeaders(String name)

Specified by:

getHeaders in interface HttpServletRequest

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

getIntHeader

public int getIntHeader(String name)

Specified by:

getIntHeader in interface HttpServletRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

getSession

public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws IOException,
ServletException

Specified by:

authenticate in interface HttpServletRequest

Throws:

IOException

ServletException

login

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

Specified by:

login in interface HttpServletRequest

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Throws:

ServletException

getParts

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

Specified by:

getParts in interface HttpServletRequest

Throws:

IOException

ServletException

getPart

public Part getPart(String name)
             throws IOException,
ServletException

Specified by:

getPart in interface HttpServletRequest

Throws:

IOException

ServletException

upgrade

public <T extends HttpUpgradeHandler> T upgrade(Class<T> handlerClass)
                                         throws IOException,
ServletException

Specified by:

upgrade in interface HttpServletRequest

Throws:

IOException

ServletException

decodeUnsafeString

@Nullable
public static String decodeUnsafeString(byte[] buffer,
 @Nonnull
 CharsetDecoder decoder,
 @Nullable
 Character delim)

Helper method to decode a byte array via a designated encoding.

Parameters:

buffer - input buffer

decoder - decoder to apply

delim - optional delimter to truncate at

Returns:

decoded String form of the data or null if a decoding exception was caught