Module org.eclipse.jetty.ee10.servlet

Package org.eclipse.jetty.ee10.servlet

Class ServletApiRequest

java.lang.Object

org.eclipse.jetty.ee10.servlet.ServletApiRequest

All Implemented Interfaces:

jakarta.servlet.http.HttpServletRequest, jakarta.servlet.ServletRequest

Direct Known Subclasses:

ServletApiRequest.CrossContextForwarded, ServletApiRequest.CrossContextIncluded

public class ServletApiRequest
extends Object
implements jakarta.servlet.http.HttpServletRequest

The Jetty implementation of the ee10 HttpServletRequest object. This provides the bridge from Servlet HttpServletRequest to the Jetty Core Request via the ServletContextRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServletApiRequest.CrossContextForwarded
static class	ServletApiRequest.CrossContextIncluded

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.jetty.util.Fields	_contentParameters
protected org.eclipse.jetty.util.Fields	_queryParameters

Fields inherited from interface jakarta.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ServletApiRequest(ServletContextRequest servletContextRequest)

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(jakarta.servlet.http.HttpServletResponse response)
String	changeSessionId()
protected void	extractQueryParameters()
jakarta.servlet.AsyncContext	getAsyncContext()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
org.eclipse.jetty.security.AuthenticationState	getAuthentication()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
long	getContentLengthLong()
String	getContentType()
String	getContextPath()
jakarta.servlet.http.Cookie[]	getCookies()
long	getDateHeader(String name)
jakarta.servlet.DispatcherType	getDispatcherType()
org.eclipse.jetty.http.HttpFields	getFields()
String	getHeader(String name)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String name)
jakarta.servlet.http.HttpServletMapping	getHttpServletMapping()
jakarta.servlet.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()
org.eclipse.jetty.util.Fields	getParameters()
String[]	getParameterValues(String name)
jakarta.servlet.http.Part	getPart(String name)
Collection<jakarta.servlet.http.Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getProtocolRequestId()
String	getQueryString()
BufferedReader	getReader()
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
org.eclipse.jetty.server.Request	getRequest()
jakarta.servlet.RequestDispatcher	getRequestDispatcher(String path)
String	getRequestedSessionId()
String	getRequestId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
jakarta.servlet.ServletConnection	getServletConnection()
jakarta.servlet.ServletContext	getServletContext()
String	getServletPath()
ServletContextHandler.ServletRequestInfo	getServletRequestInfo()
jakarta.servlet.http.HttpSession	getSession()
jakarta.servlet.http.HttpSession	getSession(boolean create)
Map<String,String>	getTrailerFields()
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()
jakarta.servlet.http.PushBuilder	newPushBuilder()
void	removeAttribute(String name)
void	setAsyncSupported(boolean asyncSupported)
void	setAttribute(String name, Object attribute)
void	setCharacterEncoding(String encoding)
jakarta.servlet.AsyncContext	startAsync()
jakarta.servlet.AsyncContext	startAsync(jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse)
String	toString()
<T extends jakarta.servlet.http.HttpUpgradeHandler> T	upgrade(Class<T> handlerClass)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.http.HttpServletRequest

isTrailerFieldsReady

Field Details

_contentParameters

protected org.eclipse.jetty.util.Fields _contentParameters

_queryParameters

protected org.eclipse.jetty.util.Fields _queryParameters

Constructor Details

ServletApiRequest

protected ServletApiRequest(ServletContextRequest servletContextRequest)

Method Details

getAuthentication

public org.eclipse.jetty.security.AuthenticationState getAuthentication()

getMethod

public String getMethod()

Specified by:

getMethod in interface jakarta.servlet.http.HttpServletRequest

getServletRequestInfo

public ServletContextHandler.ServletRequestInfo getServletRequestInfo()

Returns:

The ServletContextHandler.ServletRequestInfo view of the ServletContextRequest as wrapped by the ServletContextHandler.

See Also:

• getRequest()

getRequest

public org.eclipse.jetty.server.Request getRequest()

Returns:

The core Request associated with the servlet API request. This may differ from ServletContextRequest as wrapped by the ServletContextHandler as it may have been further wrapped before being passed to ServletChannel.associate(Request, Response, Callback).

See Also:

• getServletRequestInfo()
• ServletChannel.associate(Request, Response, Callback)

getFields

public org.eclipse.jetty.http.HttpFields getFields()

getRequestId

public String getRequestId()

Specified by:

getRequestId in interface jakarta.servlet.ServletRequest

getProtocolRequestId

public String getProtocolRequestId()

Specified by:

getProtocolRequestId in interface jakarta.servlet.ServletRequest

getServletConnection

public jakarta.servlet.ServletConnection getServletConnection()

Specified by:

getServletConnection in interface jakarta.servlet.ServletRequest

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface jakarta.servlet.http.HttpServletRequest

getCookies

public jakarta.servlet.http.Cookie[] getCookies()

Specified by:

getCookies in interface jakarta.servlet.http.HttpServletRequest

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface jakarta.servlet.http.HttpServletRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface jakarta.servlet.http.HttpServletRequest

getHeaders

public Enumeration<String> getHeaders(String name)

Specified by:

getHeaders in interface jakarta.servlet.http.HttpServletRequest

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface jakarta.servlet.http.HttpServletRequest

getIntHeader

public int getIntHeader(String name)

Specified by:

getIntHeader in interface jakarta.servlet.http.HttpServletRequest

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface jakarta.servlet.http.HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface jakarta.servlet.http.HttpServletRequest

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface jakarta.servlet.http.HttpServletRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface jakarta.servlet.http.HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface jakarta.servlet.http.HttpServletRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface jakarta.servlet.http.HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface jakarta.servlet.http.HttpServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface jakarta.servlet.http.HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface jakarta.servlet.http.HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface jakarta.servlet.http.HttpServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface jakarta.servlet.http.HttpServletRequest

getSession

public jakarta.servlet.http.HttpSession getSession(boolean create)

Specified by:

getSession in interface jakarta.servlet.http.HttpServletRequest

getSession

public jakarta.servlet.http.HttpSession getSession()

Specified by:

getSession in interface jakarta.servlet.http.HttpServletRequest

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface jakarta.servlet.http.HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface jakarta.servlet.http.HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface jakarta.servlet.http.HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface jakarta.servlet.http.HttpServletRequest

authenticate

public boolean authenticate(jakarta.servlet.http.HttpServletResponse response)
                     throws IOException,
jakarta.servlet.ServletException

Specified by:

authenticate in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException

login

public void login(String username,
 String password)
           throws jakarta.servlet.ServletException

Specified by:

login in interface jakarta.servlet.http.HttpServletRequest

Throws:

jakarta.servlet.ServletException

logout

public void logout()
            throws jakarta.servlet.ServletException

Specified by:

logout in interface jakarta.servlet.http.HttpServletRequest

Throws:

jakarta.servlet.ServletException

getParts

public Collection<jakarta.servlet.http.Part> getParts()
                                               throws IOException,
jakarta.servlet.ServletException

Specified by:

getParts in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException

getPart

public jakarta.servlet.http.Part getPart(String name)
                                  throws IOException,
jakarta.servlet.ServletException

Specified by:

getPart in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException

upgrade

public <T extends jakarta.servlet.http.HttpUpgradeHandler>
T upgrade(Class<T> handlerClass)
   throws IOException,
jakarta.servlet.ServletException

Specified by:

upgrade in interface jakarta.servlet.http.HttpServletRequest

Throws:

IOException

jakarta.servlet.ServletException

newPushBuilder

public jakarta.servlet.http.PushBuilder newPushBuilder()

Specified by:

newPushBuilder in interface jakarta.servlet.http.HttpServletRequest

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface jakarta.servlet.ServletRequest

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface jakarta.servlet.ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface jakarta.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String encoding)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface jakarta.servlet.ServletRequest

Throws:

UnsupportedEncodingException

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface jakarta.servlet.ServletRequest

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface jakarta.servlet.ServletRequest

getContentType

public String getContentType()

Specified by:

getContentType in interface jakarta.servlet.ServletRequest

getInputStream

public jakarta.servlet.ServletInputStream getInputStream()
                                                  throws IOException

Specified by:

getInputStream in interface jakarta.servlet.ServletRequest

Throws:

IOException

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface jakarta.servlet.ServletRequest

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface jakarta.servlet.ServletRequest

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface jakarta.servlet.ServletRequest

getParameterMap

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

Specified by:

getParameterMap in interface jakarta.servlet.ServletRequest

getParameters

public org.eclipse.jetty.util.Fields getParameters()

extractQueryParameters

protected void extractQueryParameters()
                               throws org.eclipse.jetty.http.BadMessageException

Throws:

org.eclipse.jetty.http.BadMessageException

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface jakarta.servlet.ServletRequest

getScheme

public String getScheme()

Specified by:

getScheme in interface jakarta.servlet.ServletRequest

getServerName

public String getServerName()

Specified by:

getServerName in interface jakarta.servlet.ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface jakarta.servlet.ServletRequest

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface jakarta.servlet.ServletRequest

Throws:

IOException

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface jakarta.servlet.ServletRequest

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface jakarta.servlet.ServletRequest

setAttribute

public void setAttribute(String name,
 Object attribute)

Specified by:

setAttribute in interface jakarta.servlet.ServletRequest

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface jakarta.servlet.ServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface jakarta.servlet.ServletRequest

getLocales

public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface jakarta.servlet.ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface jakarta.servlet.ServletRequest

getRequestDispatcher

public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface jakarta.servlet.ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface jakarta.servlet.ServletRequest

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface jakarta.servlet.ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface jakarta.servlet.ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface jakarta.servlet.ServletRequest

getServletContext

public jakarta.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface jakarta.servlet.ServletRequest

startAsync

public jakarta.servlet.AsyncContext startAsync()
                                        throws IllegalStateException

Specified by:

startAsync in interface jakarta.servlet.ServletRequest

Throws:

IllegalStateException

startAsync

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

Specified by:

startAsync in interface jakarta.servlet.ServletRequest

Throws:

IllegalStateException

getHttpServletMapping

public jakarta.servlet.http.HttpServletMapping getHttpServletMapping()

Specified by:

getHttpServletMapping in interface jakarta.servlet.http.HttpServletRequest

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface jakarta.servlet.ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface jakarta.servlet.ServletRequest

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)

getAsyncContext

public jakarta.servlet.AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface jakarta.servlet.ServletRequest

getDispatcherType

public jakarta.servlet.DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface jakarta.servlet.ServletRequest

getTrailerFields

public Map<String,String> getTrailerFields()

Specified by:

getTrailerFields in interface jakarta.servlet.http.HttpServletRequest

toString

public String toString()

Overrides:

toString in class Object