Package com.yahoo.jdisc.http.filter

Class DiscFilterRequest

  • Direct Known Subclasses:
    JdiscFilterRequest
    public abstract class DiscFilterRequest
extends java.lang.Object
    The Request class on which all filters will operate upon. Test cases that need a concrete instance should create a JdiscFilterRequest.

    • Constructor Detail

      • DiscFilterRequest

        public DiscFilterRequest​(com.yahoo.jdisc.http.servlet.ServletOrJdiscHttpRequest parent)

    • Method Detail

      • getMethod

        public abstract java.lang.String getMethod()

      • getUri

        public java.net.URI getUri()

      • setUri

        public abstract void setUri​(java.net.URI uri)

      • getParentRequest

        public HttpRequest getParentRequest()

      • getRemoteAddr

        public java.lang.String getRemoteAddr()
        Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.

      • setRemoteAddr

        public void setRemoteAddr​(java.lang.String remoteIpAddress)
        Set the IP address of the remote client associated with this Request.

      • getLocalAddr

        public java.lang.String getLocalAddr()
        Returns the Internet Protocol (IP) address of the interface on which the request was received.

      • getAttributeNames

        public java.util.Enumeration<java.lang.String> getAttributeNames()

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)

      • setAttribute

        public void setAttribute​(java.lang.String name,
                         java.lang.Object value)

      • containsAttribute

        public boolean containsAttribute​(java.lang.String name)

      • removeAttribute

        public void removeAttribute​(java.lang.String name)

      • getParameter

        public abstract java.lang.String getParameter​(java.lang.String name)

      • getParameterNames

        public abstract java.util.Enumeration<java.lang.String> getParameterNames()

      • getParameterNamesAsList

        public java.util.List<java.lang.String> getParameterNamesAsList()

      • getParameterValues

        public java.util.Enumeration<java.lang.String> getParameterValues​(java.lang.String name)

      • getParameterValuesAsList

        public java.util.List<java.lang.String> getParameterValuesAsList​(java.lang.String name)

      • getParameterMap

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getParameterMap()

      • getRemoteHost

        public java.lang.String getRemoteHost()
        Returns the hostName of remoteHost, or null if none

      • getLocalPort

        public int getLocalPort()
        Returns the Internet Protocol (IP) port number of the interface on which the request was received.

      • getRemotePort

        public int getRemotePort()
        Returns the port of remote host

      • getUntreatedParams

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getUntreatedParams()
        Returns a unmodifiable map of untreatedParameters from the parent request.

      • getUntreatedHeaders

        public com.yahoo.jdisc.HeaderFields getUntreatedHeaders()
        Returns the untreatedHeaders from parent request

      • getUntreatedCookies

        public java.util.List<Cookie> getUntreatedCookies()
        Returns the untreatedCookies from parent request

      • addHeader

        public abstract void addHeader​(java.lang.String name,
                               java.lang.String value)
        Sets a header with the given name and value. If the header had already been set, the new value overwrites the previous one.

      • getDateHeader

        public long getDateHeader​(java.lang.String name)

      • getHeader

        public abstract java.lang.String getHeader​(java.lang.String name)

      • getHeaderNames

        public abstract java.util.Enumeration<java.lang.String> getHeaderNames()

      • getHeaderNamesAsList

        public abstract java.util.List<java.lang.String> getHeaderNamesAsList()

      • getHeaders

        public abstract java.util.Enumeration<java.lang.String> getHeaders​(java.lang.String name)

      • getHeadersAsList

        public abstract java.util.List<java.lang.String> getHeadersAsList​(java.lang.String name)

      • removeHeaders

        public abstract void removeHeaders​(java.lang.String name)

      • setHeaders

        public abstract void setHeaders​(java.lang.String name,
                                java.lang.String value)
        Sets a header with the given name and value. If the header had already been set, the new value overwrites the previous one.

      • setHeaders

        public abstract void setHeaders​(java.lang.String name,
                                java.util.List<java.lang.String> values)
        Sets a header with the given name and value. If the header had already been set, the new value overwrites the previous one.

      • getIntHeader

        public int getIntHeader​(java.lang.String name)

      • getCookies

        public java.util.List<Cookie> getCookies()

      • setCookies

        public void setCookies​(java.util.List<Cookie> cookies)

      • getConnectedAt

        public long getConnectedAt​(java.util.concurrent.TimeUnit unit)

      • getProtocol

        public java.lang.String getProtocol()

      • getQueryString

        public java.lang.String getQueryString()
        Returns the query string that is contained in the request URL. Returns the undecoded value uri.getRawQuery()

      • getRemoteUser

        public java.lang.String getRemoteUser()
        Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.

      • getRequestURI

        public java.lang.String getRequestURI()

      • getRequestedSessionId

        public java.lang.String getRequestedSessionId()

      • getScheme

        public java.lang.String getScheme()

      • setScheme

        public void setScheme​(java.lang.String scheme,
                      boolean isSecure)

      • getServerName

        public java.lang.String getServerName()

      • getServerPort

        public int getServerPort()

      • getUserPrincipal

        public abstract java.security.Principal getUserPrincipal()

      • isSecure

        public boolean isSecure()

      • isUserInRole

        public boolean isUserInRole​(java.lang.String role)
        Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

      • setOverrideIsUserInRole

        public void setOverrideIsUserInRole​(boolean overrideIsUserInRole)

      • setRemoteHost

        public void setRemoteHost​(java.lang.String remoteAddr)

      • setRemoteUser

        public void setRemoteUser​(java.lang.String remoteUser)

      • setUserPrincipal

        public abstract void setUserPrincipal​(java.security.Principal principal)

      • getClientCertificateChain

        public abstract java.util.List<java.security.cert.X509Certificate> getClientCertificateChain()
        Returns:
        The client certificate chain in ascending order of trust. The first certificate is the one sent from the client. Returns an empty list if the client did not provide a certificate.

      • setUserRoles

        public void setUserRoles​(java.lang.String[] roles)

      • getContentType

        public java.lang.String getContentType()
        Returns the content-type for the request

      • getCharacterEncoding

        public java.lang.String getCharacterEncoding()
        Get character encoding

      • setCharacterEncoding

        public void setCharacterEncoding​(java.lang.String encoding)
        Set character encoding

      • addCookie

        public void addCookie​(JDiscCookieWrapper cookie)
        Can be called multiple times to add Cookies

      • clearCookies

        public abstract void clearCookies()