org.eclipse.jetty.server

Class Request

  • All Implemented Interfaces:
    javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest


    public class Requestextends Objectimplements javax.servlet.http.HttpServletRequest
    Jetty Request.

    Implements HttpServletRequest from the javax.servlet.http package.

    The standard interface of mostly getters, is extended with setters so that the request is mutable by the handlers that it is passed to. This allows the request object to be as lightweight as possible and not actually implement any significant behavior. For example

    • The getContextPath() method will return null, until the request has been passed to a ContextHandler which matches the getPathInfo() with a context path and calls setContextPath(String) as a result.
    • the HTTP session methods will all return null sessions until such time as a request has been passed to a SessionHandler which checks for session cookies and enables the ability to create new sessions.
    • The getServletPath() method will return null until the request has been passed to a org.eclipse.jetty.servlet.ServletHandler and the pathInfo matched against the servlet URL patterns and setServletPath(String) called as a result.
    A request instance is created for each AbstractHttpConnection accepted by the server and recycled for each HTTP request received via that connection. An effort is made to avoid reparsing headers and cookies that are likely to be the same for requests from the same connection.

    The form content that a request can process is limited to protect from Denial of Service attacks. The size in bytes is limited by ContextHandler.getMaxFormContentSize() or if there is no context then the "org.eclipse.jetty.server.Request.maxFormContentSize" Server attribute. The number of parameters keys is limited by ContextHandler.getMaxFormKeys() or if there is no context then the "org.eclipse.jetty.server.Request.maxFormKeys" Server attribute.

    • Method Detail

      • getRequest

        public static Request getRequest(javax.servlet.http.HttpServletRequest request)
      • addEventListener

        public void addEventListener(EventListener listener)
      • extractParameters

        public void extractParameters()
        Extract Parameters from query string and/or form _content.
      • getAsyncContext

        public javax.servlet.AsyncContext getAsyncContext()
        Specified by:
        getAsyncContext in interface javax.servlet.ServletRequest
      • getAttribute

        public Object getAttribute(String name)
        Specified by:
        getAttribute in interface javax.servlet.ServletRequest
      • getAttributeNames

        public Enumeration getAttributeNames()
        Specified by:
        getAttributeNames in interface javax.servlet.ServletRequest
      • getAuthentication

        public Authentication getAuthentication()
        Get the authentication.
        Returns:
        the authentication
      • getAuthType

        public String getAuthType()
        Specified by:
        getAuthType in interface javax.servlet.http.HttpServletRequest
      • getCharacterEncoding

        public String getCharacterEncoding()
        Specified by:
        getCharacterEncoding in interface javax.servlet.ServletRequest
      • getContentLength

        public int getContentLength()
        Specified by:
        getContentLength in interface javax.servlet.ServletRequest
      • getContentRead

        public long getContentRead()
      • getContentType

        public String getContentType()
        Specified by:
        getContentType in interface javax.servlet.ServletRequest
      • getContextPath

        public String getContextPath()
        Specified by:
        getContextPath in interface javax.servlet.http.HttpServletRequest
      • getCookies

        public javax.servlet.http.Cookie[] getCookies()
        Specified by:
        getCookies in interface javax.servlet.http.HttpServletRequest
      • getDateHeader

        public long getDateHeader(String name)
        Specified by:
        getDateHeader in interface javax.servlet.http.HttpServletRequest
      • getDispatcherType

        public javax.servlet.DispatcherType getDispatcherType()
        Specified by:
        getDispatcherType in interface javax.servlet.ServletRequest
      • getHeader

        public String getHeader(String name)
        Specified by:
        getHeader in interface javax.servlet.http.HttpServletRequest
      • getHeaderNames

        public Enumeration getHeaderNames()
        Specified by:
        getHeaderNames in interface javax.servlet.http.HttpServletRequest
      • getHeaders

        public Enumeration getHeaders(String name)
        Specified by:
        getHeaders in interface javax.servlet.http.HttpServletRequest
      • getInputState

        public int getInputState()
        Returns:
        Returns the inputState.
      • getInputStream

        public javax.servlet.ServletInputStream getInputStream()                                                throws IOException
        Specified by:
        getInputStream in interface javax.servlet.ServletRequest
        Throws:
        IOException
      • getIntHeader

        public int getIntHeader(String name)
        Specified by:
        getIntHeader in interface javax.servlet.http.HttpServletRequest
      • getLocalAddr

        public String getLocalAddr()
        Specified by:
        getLocalAddr in interface javax.servlet.ServletRequest
      • getLocale

        public Locale getLocale()
        Specified by:
        getLocale in interface javax.servlet.ServletRequest
      • getLocales

        public Enumeration getLocales()
        Specified by:
        getLocales in interface javax.servlet.ServletRequest
      • getLocalName

        public String getLocalName()
        Specified by:
        getLocalName in interface javax.servlet.ServletRequest
      • getLocalPort

        public int getLocalPort()
        Specified by:
        getLocalPort in interface javax.servlet.ServletRequest
      • getMethod

        public String getMethod()
        Specified by:
        getMethod in interface javax.servlet.http.HttpServletRequest
      • getParameter

        public String getParameter(String name)
        Specified by:
        getParameter in interface javax.servlet.ServletRequest
      • getParameterMap

        public Map getParameterMap()
        Specified by:
        getParameterMap in interface javax.servlet.ServletRequest
      • getParameterNames

        public Enumeration getParameterNames()
        Specified by:
        getParameterNames in interface javax.servlet.ServletRequest
      • getParameters

        public MultiMap<String> getParameters()
        Returns:
        Returns the parameters.
      • getParameterValues

        public String[] getParameterValues(String name)
        Specified by:
        getParameterValues in interface javax.servlet.ServletRequest
      • getPathInfo

        public String getPathInfo()
        Specified by:
        getPathInfo in interface javax.servlet.http.HttpServletRequest
      • getPathTranslated

        public String getPathTranslated()
        Specified by:
        getPathTranslated in interface javax.servlet.http.HttpServletRequest
      • getProtocol

        public String getProtocol()
        Specified by:
        getProtocol in interface javax.servlet.ServletRequest
      • getQueryEncoding

        public String getQueryEncoding()
      • getQueryString

        public String getQueryString()
        Specified by:
        getQueryString in interface javax.servlet.http.HttpServletRequest
      • getRealPath

        public String getRealPath(String path)
        Specified by:
        getRealPath in interface javax.servlet.ServletRequest
      • getRemoteAddr

        public String getRemoteAddr()
        Specified by:
        getRemoteAddr in interface javax.servlet.ServletRequest
      • getRemoteHost

        public String getRemoteHost()
        Specified by:
        getRemoteHost in interface javax.servlet.ServletRequest
      • getRemotePort

        public int getRemotePort()
        Specified by:
        getRemotePort in interface javax.servlet.ServletRequest
      • getRemoteUser

        public String getRemoteUser()
        Specified by:
        getRemoteUser in interface javax.servlet.http.HttpServletRequest
      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
        Specified by:
        getRequestDispatcher in interface javax.servlet.ServletRequest
      • getRequestedSessionId

        public String getRequestedSessionId()
        Specified by:
        getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
      • getRequestURI

        public String getRequestURI()
        Specified by:
        getRequestURI in interface javax.servlet.http.HttpServletRequest
      • getRequestURL

        public StringBuffer getRequestURL()
        Specified by:
        getRequestURL in interface javax.servlet.http.HttpServletRequest
      • getResponse

        public Response getResponse()
      • getRootURL

        public StringBuilder getRootURL()
        Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and, but it does not include a path.

        Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append path and query parameters. This method is useful for creating redirect messages and for reporting errors.

        Returns:
        "scheme://host:port"
      • getScheme

        public String getScheme()
        Specified by:
        getScheme in interface javax.servlet.ServletRequest
      • getServerName

        public String getServerName()
        Specified by:
        getServerName in interface javax.servlet.ServletRequest
      • getServerPort

        public int getServerPort()
        Specified by:
        getServerPort in interface javax.servlet.ServletRequest
      • getServletContext

        public javax.servlet.ServletContext getServletContext()
        Specified by:
        getServletContext in interface javax.servlet.ServletRequest
      • getServletName

        public String getServletName()
      • getServletPath

        public String getServletPath()
        Specified by:
        getServletPath in interface javax.servlet.http.HttpServletRequest
      • getServletResponse

        public javax.servlet.ServletResponse getServletResponse()
      • getSession

        public javax.servlet.http.HttpSession getSession()
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest
      • getSession

        public javax.servlet.http.HttpSession getSession(boolean create)
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest
      • getSessionManager

        public SessionManager getSessionManager()
        Returns:
        Returns the sessionManager.
      • getTimeStamp

        public long getTimeStamp()
        Get Request TimeStamp
        Returns:
        The time that the request was received.
      • getTimeStampBuffer

        public Buffer getTimeStampBuffer()
        Get Request TimeStamp
        Returns:
        The time that the request was received.
      • getUri

        public HttpURI getUri()
        Returns:
        Returns the uri.
      • getUserPrincipal

        public Principal getUserPrincipal()
        Specified by:
        getUserPrincipal in interface javax.servlet.http.HttpServletRequest
      • getDispatchTime

        public long getDispatchTime()
        Get timestamp of the request dispatch
        Returns:
        timestamp
      • isHandled

        public boolean isHandled()
      • isAsyncStarted

        public boolean isAsyncStarted()
        Specified by:
        isAsyncStarted in interface javax.servlet.ServletRequest
      • isAsyncSupported

        public boolean isAsyncSupported()
        Specified by:
        isAsyncSupported in interface javax.servlet.ServletRequest
      • isRequestedSessionIdFromCookie

        public boolean isRequestedSessionIdFromCookie()
        Specified by:
        isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromUrl

        public boolean isRequestedSessionIdFromUrl()
        Specified by:
        isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromURL

        public boolean isRequestedSessionIdFromURL()
        Specified by:
        isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdValid

        public boolean isRequestedSessionIdValid()
        Specified by:
        isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
      • isSecure

        public boolean isSecure()
        Specified by:
        isSecure in interface javax.servlet.ServletRequest
      • isUserInRole

        public boolean isUserInRole(String role)
        Specified by:
        isUserInRole in interface javax.servlet.http.HttpServletRequest
      • recoverNewSession

        public javax.servlet.http.HttpSession recoverNewSession(Object key)
      • recycle

        protected void recycle()
      • removeAttribute

        public void removeAttribute(String name)
        Specified by:
        removeAttribute in interface javax.servlet.ServletRequest
      • removeEventListener

        public void removeEventListener(EventListener listener)
      • saveNewSession

        public void saveNewSession(Object key,                  javax.servlet.http.HttpSession session)
      • setAsyncSupported

        public void setAsyncSupported(boolean supported)
      • setAttribute

        public void setAttribute(String name,                Object value)
        Specified by:
        setAttribute in interface javax.servlet.ServletRequest
      • setAttributes

        public void setAttributes(Attributes attributes)
      • setAuthentication

        public void setAuthentication(Authentication authentication)
        Set the authentication.
        Parameters:
        authentication - the authentication to set
      • setCharacterEncodingUnchecked

        public void setCharacterEncodingUnchecked(String encoding)
      • setContentType

        public void setContentType(String contentType)
      • setContext

        public void setContext(ContextHandler.Context context)
        Set request context
        Parameters:
        context - context object
      • setContextPath

        public void setContextPath(String contextPath)
        Sets the "context path" for this request
        See Also:
        HttpServletRequest.getContextPath()
      • setCookies

        public void setCookies(javax.servlet.http.Cookie[] cookies)
        Parameters:
        cookies - The cookies to set.
      • setDispatcherType

        public void setDispatcherType(javax.servlet.DispatcherType type)
      • setHandled

        public void setHandled(boolean h)
      • setMethod

        public void setMethod(String method)
        Parameters:
        method - The method to set.
      • setParameters

        public void setParameters(MultiMap<String> parameters)
        Parameters:
        parameters - The parameters to set.
      • setPathInfo

        public void setPathInfo(String pathInfo)
        Parameters:
        pathInfo - The pathInfo to set.
      • setProtocol

        public void setProtocol(String protocol)
        Parameters:
        protocol - The protocol to set.
      • setQueryEncoding

        public void setQueryEncoding(String queryEncoding)
        Set the character encoding used for the query string. This call will effect the return of getQueryString and getParamaters. It must be called before any geParameter methods. The request attribute "org.eclipse.jetty.server.server.Request.queryEncoding" may be set as an alternate method of calling setQueryEncoding.
        Parameters:
        queryEncoding -
      • setQueryString

        public void setQueryString(String queryString)
        Parameters:
        queryString - The queryString to set.
      • setRemoteAddr

        public void setRemoteAddr(String addr)
        Parameters:
        addr - The address to set.
      • setRemoteHost

        public void setRemoteHost(String host)
        Parameters:
        host - The host to set.
      • setRequestedSessionId

        public void setRequestedSessionId(String requestedSessionId)
        Parameters:
        requestedSessionId - The requestedSessionId to set.
      • setRequestedSessionIdFromCookie

        public void setRequestedSessionIdFromCookie(boolean requestedSessionIdCookie)
        Parameters:
        requestedSessionIdCookie - The requestedSessionIdCookie to set.
      • setRequestURI

        public void setRequestURI(String requestURI)
        Parameters:
        requestURI - The requestURI to set.
      • setScheme

        public void setScheme(String scheme)
        Parameters:
        scheme - The scheme to set.
      • setServerName

        public void setServerName(String host)
        Parameters:
        host - The host to set.
      • setServerPort

        public void setServerPort(int port)
        Parameters:
        port - The port to set.
      • setServletPath

        public void setServletPath(String servletPath)
        Parameters:
        servletPath - The servletPath to set.
      • setSession

        public void setSession(javax.servlet.http.HttpSession session)
        Parameters:
        session - The session to set.
      • setSessionManager

        public void setSessionManager(SessionManager sessionManager)
        Parameters:
        sessionManager - The sessionManager to set.
      • setTimeStamp

        public void setTimeStamp(long ts)
      • setUri

        public void setUri(HttpURI uri)
        Parameters:
        uri - The uri to set.
      • setDispatchTime

        public void setDispatchTime(long value)
        Set timetstamp of request dispatch
        Parameters:
        value - timestamp
      • startAsync

        public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,                                    javax.servlet.ServletResponse servletResponse)                                      throws IllegalStateException
        Specified by:
        startAsync in interface javax.servlet.ServletRequest
        Throws:
        IllegalStateException
      • authenticate

        public boolean authenticate(javax.servlet.http.HttpServletResponse response)                     throws IOException,                            javax.servlet.ServletException
        Specified by:
        authenticate in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • getPart

        public javax.servlet.http.Part getPart(String name)                                throws IOException,                                       javax.servlet.ServletException
        Specified by:
        getPart in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • getParts

        public Collection<javax.servlet.http.Part> getParts()                                             throws IOException,                                                    javax.servlet.ServletException
        Specified by:
        getParts in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • login

        public void login(String username,         String password)           throws javax.servlet.ServletException
        Specified by:
        login in interface javax.servlet.http.HttpServletRequest
        Throws:
        javax.servlet.ServletException
      • logout

        public void logout()            throws javax.servlet.ServletException
        Specified by:
        logout in interface javax.servlet.http.HttpServletRequest
        Throws:
        javax.servlet.ServletException
      • mergeQueryString

        public void mergeQueryString(String query)
        Merge in a new query string. The query string is merged with the existing parameters and setParameters(MultiMap) and setQueryString(String) are called with the result. The merge is according to the rules of the servlet dispatch forward method.
        Parameters:
        query - The query string to merge into the request.

Copyright © 1995-2013 Mort Bay Consulting. All Rights Reserved.



NOTHING
NOTHING
Add the Maven Dependecy to your project: maven dependecy for com.amazonaws : aws-java-sdk : 1.3.14