Class OcHttpServletExtractor


  • @ExperimentalApi
    class OcHttpServletExtractor
    extends HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
    This class extracts attributes from HttpServletRequest and HttpServletResponse.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHost​(javax.servlet.http.HttpServletRequest request)
      Returns the request URL host.
      java.lang.String getMethod​(javax.servlet.http.HttpServletRequest request)
      Returns the request method.
      java.lang.String getPath​(javax.servlet.http.HttpServletRequest request)
      Returns the request URL path.
      java.lang.String getRoute​(javax.servlet.http.HttpServletRequest request)
      Returns the request route.
      int getStatusCode​(javax.servlet.http.HttpServletResponse response)
      Returns the response status code.
      java.lang.String getUrl​(javax.servlet.http.HttpServletRequest request)
      Returns the request URL.
      java.lang.String getUserAgent​(javax.servlet.http.HttpServletRequest request)
      Returns the request user agent.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OcHttpServletExtractor

        OcHttpServletExtractor()
    • Method Detail

      • getHost

        public java.lang.String getHost​(javax.servlet.http.HttpServletRequest request)
        Description copied from class: HttpExtractor
        Returns the request URL host.
        Specified by:
        getHost in class HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
        Parameters:
        request - the HTTP request.
        Returns:
        the request URL host.
      • getMethod

        public java.lang.String getMethod​(javax.servlet.http.HttpServletRequest request)
        Description copied from class: HttpExtractor
        Returns the request method.
        Specified by:
        getMethod in class HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
        Parameters:
        request - the HTTP request.
        Returns:
        the request method.
      • getPath

        public java.lang.String getPath​(javax.servlet.http.HttpServletRequest request)
        Description copied from class: HttpExtractor
        Returns the request URL path.
        Specified by:
        getPath in class HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
        Parameters:
        request - the HTTP request.
        Returns:
        the request URL path.
      • getUserAgent

        public java.lang.String getUserAgent​(javax.servlet.http.HttpServletRequest request)
        Description copied from class: HttpExtractor
        Returns the request user agent.
        Specified by:
        getUserAgent in class HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
        Parameters:
        request - the HTTP request.
        Returns:
        the request user agent.
      • getStatusCode

        public int getStatusCode​(@Nullable
                                 javax.servlet.http.HttpServletResponse response)
        Description copied from class: HttpExtractor
        Returns the response status code. If the response is null, this method should return 0.
        Specified by:
        getStatusCode in class HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
        Parameters:
        response - the HTTP response.
        Returns:
        the response status code.
      • getUrl

        public java.lang.String getUrl​(javax.servlet.http.HttpServletRequest request)
        Description copied from class: HttpExtractor
        Returns the request URL.
        Specified by:
        getUrl in class HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
        Parameters:
        request - the HTTP request.
        Returns:
        the request URL.
      • getRoute

        public java.lang.String getRoute​(javax.servlet.http.HttpServletRequest request)
        Description copied from class: HttpExtractor
        Returns the request route.
        Specified by:
        getRoute in class HttpExtractor<javax.servlet.http.HttpServletRequest,​javax.servlet.http.HttpServletResponse>
        Parameters:
        request - the HTTP request.
        Returns:
        the request route.