com.ibm.zosconnect.spi

Interface HttpZosConnectRequest


  • public interface HttpZosConnectRequest
    Provides access to information associated to a specific HTTP request.

    This interface is implemented by z/OS Connect.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright_notice 

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.Object getAttribute(java.lang.String attribute)
      Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
      java.util.Enumeration<java.lang.String> getAttributeNames()
      Returns an Enumeration containing the names of the attributes available to this request.
      java.lang.String getCharacterEncoding()
      Returns the name of the character encoding used in the body of this request.
      java.lang.String getHeader(java.lang.String key)
      Returns the value of the specified request header as a String.
      java.util.Enumeration<java.lang.String> getHeaderNames()
      Returns an Enumeration of the names of all the headers for this request.
      java.util.Enumeration<java.lang.String> getHeaders(java.lang.String key)
      Returns an Enumeration of all the values for the specified request header.
      java.lang.String getLocalAddr()
      Returns the Internet Protocol (IP) address of the interface on which the request was received.
      java.lang.String getMethod()
      Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
      java.lang.String getParameter(java.lang.String name)
      Returns the value of a request parameter as a String, or null if the parameter does not exist.
      java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
      Returns a java.util.Map of the parameters of this request.
      java.lang.String getPathInfo()
      Returns any extra path information associated with the URL the client sent when it made this request.
      java.lang.String getQueryString()
      Returns the query string that is contained in the request URL after the path.
      java.lang.String getRemoteAddr()
      Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
      java.lang.String getRequestURI()
      Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
      java.lang.StringBuffer getRequestURL()
      Reconstructs the URL the client used to make the request.
      java.lang.String getServletPath()
      Returns the part of this request's URL that calls the servlet.
      java.security.Principal getUserPrincipal()
      Returns a java.security.Principal object containing the name of the current authenticated user.
      boolean isSecure()
      Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

    • Method Detail

      • getHeader

        java.lang.String getHeader(java.lang.String key)
        Returns the value of the specified request header as a String. If there are multiple headers with the same name, this method returns the first one. If the request did not include a header of the specified name, this method returns null.
        Parameters:
        key - A String specifying the header name.
        Returns:
        A String containing the value of the requested header.
        See Also:
        HttpServletRequest.getHeader(java.lang.String)

      • getHeaders

        java.util.Enumeration<java.lang.String> getHeaders(java.lang.String key)
        Returns an Enumeration of all the values for the specified request header. If the request did not include the specified header, this method returns an empty Enumeration.
        Parameters:
        key - A String specifying the header name.
        Returns:
        An Enumeration containing the values of the requested header.
        See Also:
        HttpServletRequest.getHeaders(java.lang.String)

      • getHeaderNames

        java.util.Enumeration<java.lang.String> getHeaderNames()
        Returns an Enumeration of the names of all the headers for this request. If the request did not include any headers, this method returns an empty Enumeration.
        Returns:
        An Enumeration with the names of all the headers for this request.

      • getMethod

        java.lang.String getMethod()
        Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
        Returns:
        A String specifying the name of the method with which this request was made.
        See Also:
        HttpServletRequest.getMethod()

      • getQueryString

        java.lang.String getQueryString()
        Returns the query string that is contained in the request URL after the path.
        Returns:
        A string containing the query string.
        See Also:
        HttpServletRequest.getQueryString()

      • getRequestURI

        java.lang.String getRequestURI()
        Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
        Returns:
        A String containing the part of the URL from the protocol name up to the query string.
        See Also:
        HttpServletRequest.getRequestURI()

      • getRequestURL

        java.lang.StringBuffer getRequestURL()
        Reconstructs the URL the client used to make the request.
        Returns:
        A StringBuffer containing the reconstructed URL.
        See Also:
        HttpServletRequest.getRequestURL()

      • getServletPath

        java.lang.String getServletPath()
        Returns the part of this request's URL that calls the servlet.
        Returns:
        A String containing the part of this request's URL that calls the servlet.
        See Also:
        HttpServletRequest.getServletPath()

      • getUserPrincipal

        java.security.Principal getUserPrincipal()
        Returns a java.security.Principal object containing the name of the current authenticated user.
        Returns:
        A java.security.Principal object containing the name of the current authenticated user.
        See Also:
        HttpServletRequest.getUserPrincipal()

      • getParameter

        java.lang.String getParameter(java.lang.String name)
        Returns the value of a request parameter as a String, or null if the parameter does not exist.
        Parameters:
        name - A String specifying the name of the parameter.
        Returns:
        The value of a request parameter as a String, or null if the parameter does not exist.
        See Also:
        ServletRequest.getParameter(java.lang.String)

      • getParameterMap

        java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
        Returns a java.util.Map of the parameters of this request.
        Returns:
        A java.util.Map of the parameters of this request.
        See Also:
        ServletRequest.getParameterMap()

      • getCharacterEncoding

        java.lang.String getCharacterEncoding()
        Returns the name of the character encoding used in the body of this request.
        Returns:
        A String containing the name of the character encoding used in the body of this request.
        See Also:
        ServletRequest.getCharacterEncoding()

      • getPathInfo

        java.lang.String getPathInfo()
        Returns any extra path information associated with the URL the client sent when it made this request.
        Returns:
        A String containing any extra path information associated with the URL the client sent when it made this request.
        See Also:
        HttpServletRequest.getPathInfo()

      • isSecure

        boolean isSecure()
        Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
        Returns:
        A boolean indicating whether this request was made using a secure channel, such as HTTPS.
        See Also:
        ServletRequest.isSecure()

      • getAttributeNames

        java.util.Enumeration<java.lang.String> getAttributeNames()
        Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.
        Returns:
        An Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.
        See Also:
        ServletRequest.getAttributeNames()

      • getAttribute

        java.lang.Object getAttribute(java.lang.String attribute)
        Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
        Parameters:
        attribute - A String specifying the name of the attribute.
        Returns:
        An Object containing the value of the attribute, or null if no attribute of the given name exists.
        See Also:
        ServletRequest.getAttribute(java.lang.String)

      • getLocalAddr

        java.lang.String getLocalAddr()
        Returns the Internet Protocol (IP) address of the interface on which the request was received.
        Returns:
        A String containing the Internet Protocol (IP) address of the interface on which the request was received.
        See Also:
        ServletRequest.getLocalAddr()

      • getRemoteAddr

        java.lang.String getRemoteAddr()
        Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
        Returns:
        A String containing the Internet Protocol (IP) address of the client or last proxy that sent the request.
        See Also:
        ServletRequest.getRemoteAddr()
Skip navigation links