XPFHttpServletRequest (EP Extension Point Framework Connectivity 0.0.0-SNAPSHOT API)

java.lang.Object
- com.elasticpath.xpf.connectivity.entity.XPFHttpServletRequest

public class XPFHttpServletRequest
extends Object

Represents an HTTP Servlet request.

Constructor Summary

Constructors
Constructor and Description
XPFHttpServletRequest(@NonNull XPFEntitySupplier<Map<String,Object>> attributes, String characterEncoding, int contentLength, long contentLengthLong, String contentType, @NonNull XPFEntitySupplier<Map<String,List<String>>> parameters, String protocol, String scheme, String serverName, int serverPort, String remoteAddr, String remoteHost, int remotePort, XPFEntitySupplier<Locale> locale, XPFEntitySupplier<Enumeration<Locale>> locales, boolean secure, String localName, String localAddr, int localPort, String authType, @NonNull String contextPath, @NonNull XPFEntitySupplier<List<XPFHttpCookie>> cookies, @NonNull Map<String,List<String>> headers, @NonNull String method, String pathInfo, XPFEntitySupplier<String> pathTranslated, String queryString, XPFEntitySupplier<String> remoteUser, String requestedSessionId, @NonNull String requestURI, @NonNull XPFEntitySupplier<StringBuffer> requestURL, @NonNull String servletPath, XPFEntitySupplier<XPFHttpSession> session, XPFEntitySupplier<String> userPrincipal, XPFEntitySupplier<Boolean> requestedSessionIdFromCookie, XPFEntitySupplier<Boolean> requestedSessionIdFromURL, XPFEntitySupplier<Boolean> requestedSessionIdValid)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`Object`	`getAttribute(String name)` Returns the value of the named attribute as an `Object`, or `null` if no attribute of the given name exists.
`Enumeration<String>`	`getAttributeNames()` Returns an `Enumeration` containing the names of the attributes available to this request.
`Map<String,Object>`	`getAttributes()` Returns a map of attributes associated with this request.
`String`	`getAuthType()` Returns the name of the authentication scheme used to protect the servlet.
`String`	`getCharacterEncoding()` Returns the name of the character encoding used in the body of this request.
`int`	`getContentLength()` Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE.
`long`	`getContentLengthLong()` Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
`String`	`getContentType()` Returns the MIME type of the body of the request, or `null` if the type is not known.
`@NonNull String`	`getContextPath()` Returns the portion of the request URI that indicates the context of the request.
`List<XPFHttpCookie>`	`getCookies()` Returns a list containing all of the `Cookie` objects the client sent with this request.
`long`	`getDateHeader(String name)` Returns the value of the specified request header as a `long` value that represents a `Date` object.
`String`	`getHeader(String name)` Returns the value of the specified request header as a `String`.
`Enumeration<String>`	`getHeaderNames()` Returns an enumeration of all the header names this request contains.
`@NonNull Map<String,List<String>>`	`getHeaders()` Returns a map of all the headers that were sent with this request.
`Enumeration<String>`	`getHeaders(String name)` Returns all the values of the specified request header as an `Enumeration` of `String` objects.
`int`	`getIntHeader(String name)` Returns the value of the specified request header as an `int`.
`String`	`getLocalAddr()` Returns the Internet Protocol (IP) address of the interface on which the request was received.
`Locale`	`getLocale()` Returns the preferred `Locale` that the client will accept content in, based on the Accept-Language header.
`Enumeration<Locale>`	`getLocales()` Returns an `Enumeration` of `Locale` objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.
`String`	`getLocalName()` Returns the host name of the Internet Protocol (IP) interface on which the request was received.
`int`	`getLocalPort()` Returns the Internet Protocol (IP) port number of the interface on which the request was received.
`@NonNull String`	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
`String`	`getParameter(String name)` Returns the value of a request parameter as a `String`, or `null` if the parameter does not exist.
`Map<String,String[]>`	`getParameterMap()` Returns a java.util.Map of the parameters of this request.
`Enumeration<String>`	`getParameterNames()` Returns an `Enumeration` of `String` objects containing the names of the parameters contained in this request.
`Map<String,List<String>>`	`getParameters()` Returns a map of parameters associated with this request.
`String[]`	`getParameterValues(String name)` Returns an array of `String` objects containing all of the values the given request parameter has, or `null` if the parameter does not exist.
`String`	`getPathInfo()` Returns any extra path information associated with the URL the client sent when it made this request.
`String`	`getPathTranslated()` Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
`String`	`getProtocol()` Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
`String`	`getQueryString()` Returns the query string that is contained in the request URL after the path.
`String`	`getRemoteAddr()` Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
`String`	`getRemoteHost()` Returns the fully qualified name of the client or the last proxy that sent the request.
`int`	`getRemotePort()` Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
`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.
`String`	`getRequestedSessionId()` Returns the session ID specified by the client.
`XPFEntitySupplier<Boolean>`	`getRequestedSessionIdFromCookie()` Checks whether the requested session ID came in as a cookie.
`XPFEntitySupplier<Boolean>`	`getRequestedSessionIdFromURL()` Checks whether the requested session ID came in as part of the request URL.
`XPFEntitySupplier<Boolean>`	`getRequestedSessionIdValid()` Checks whether the requested session ID is still valid.
`@NonNull 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.
`StringBuffer`	`getRequestURL()` Reconstructs the URL the client used to make the request.
`String`	`getScheme()` Returns the name of the scheme used to make this request, for example, `http`, `https`, or `ftp`.
`String`	`getServerName()` Returns the host name of the server to which the request was sent.
`int`	`getServerPort()` Returns the port number to which the request was sent.
`@NonNull String`	`getServletPath()` Returns the part of this request's URL that calls the servlet.
`XPFHttpSession`	`getSession()` Returns the current `HttpSession` associated with this request or, if there is no current session and `create` is true, returns a new session.
`String`	`getUserPrincipal()` Returns a `java.security.Principal` object containing the name of the current authenticated user.
`int`	`hashCode()`
`boolean`	`isRequestedSessionIdFromCookie()` Checks whether the requested session ID came in as a cookie.
`boolean`	`isRequestedSessionIdFromURL()` Checks whether the requested session ID came in as a cookie.
`boolean`	`isRequestedSessionIdValid()` Checks whether the requested session ID is still valid.
`boolean`	`isSecure()` Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - XPFHttpServletRequest
```
public XPFHttpServletRequest(@NonNull
                             @NonNull XPFEntitySupplier<Map<String,Object>> attributes,
                             String characterEncoding,
                             int contentLength,
                             long contentLengthLong,
                             String contentType,
                             @NonNull
                             @NonNull XPFEntitySupplier<Map<String,List<String>>> parameters,
                             String protocol,
                             String scheme,
                             String serverName,
                             int serverPort,
                             String remoteAddr,
                             String remoteHost,
                             int remotePort,
                             XPFEntitySupplier<Locale> locale,
                             XPFEntitySupplier<Enumeration<Locale>> locales,
                             boolean secure,
                             String localName,
                             String localAddr,
                             int localPort,
                             String authType,
                             @NonNull
                             @NonNull String contextPath,
                             @NonNull
                             @NonNull XPFEntitySupplier<List<XPFHttpCookie>> cookies,
                             @NonNull
                             @NonNull Map<String,List<String>> headers,
                             @NonNull
                             @NonNull String method,
                             String pathInfo,
                             XPFEntitySupplier<String> pathTranslated,
                             String queryString,
                             XPFEntitySupplier<String> remoteUser,
                             String requestedSessionId,
                             @NonNull
                             @NonNull String requestURI,
                             @NonNull
                             @NonNull XPFEntitySupplier<StringBuffer> requestURL,
                             @NonNull
                             @NonNull String servletPath,
                             XPFEntitySupplier<XPFHttpSession> session,
                             XPFEntitySupplier<String> userPrincipal,
                             XPFEntitySupplier<Boolean> requestedSessionIdFromCookie,
                             XPFEntitySupplier<Boolean> requestedSessionIdFromURL,
                             XPFEntitySupplier<Boolean> requestedSessionIdValid)
```
- Method Detail
  - getAttribute
```
@LazyLoaded
public Object getAttribute(String name)
```
    Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
    Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, javax.*, and sun.*.
    
    Parameters:
    
    name - a String specifying the name of the attribute
    
    Returns:
    
    an Object containing the value of the attribute, or null if the attribute does not exist
  - getAttributeNames
```
@LazyLoaded
public Enumeration<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 of strings containing the names of the request's attributes
  - getParameter
```
@LazyLoaded
public String getParameter(String name)
```
    Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
    You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParameterValues(java.lang.String).
    If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.
    
    Parameters:
    
    name - a String specifying the name of the parameter
    
    Returns:
    
    a String representing the single value of the parameter
    
    See Also:
    
    getParameterValues(java.lang.String)
  - getParameterNames
```
@LazyLoaded
public Enumeration<String> getParameterNames()
```
    Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.
    
    Returns:
    
    an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters
  - getParameterValues
```
@LazyLoaded
public String[] getParameterValues(String name)
```
    Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
    If the parameter has a single value, the array has a length of 1.
    
    Parameters:
    
    name - a String containing the name of the parameter whose value is requested
    
    Returns:
    
    an array of String objects containing the parameter's values
    
    See Also:
    
    getParameter(java.lang.String)
  - getParameterMap
```
@LazyLoaded
public Map<String,String[]> getParameterMap()
```
    Returns a java.util.Map of the parameters of this request.
    Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
    
    Returns:
    
    an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.
  - getHeader
```
public String getHeader(String name)
```
    Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.
    
    Parameters:
    
    name - a String specifying the header name
    
    Returns:
    
    a String containing the value of the requested header, or null if the request does not have a header of that name
  - getIntHeader
```
public int getIntHeader(String name)
```
    Returns the value of the specified request header as an int. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a NumberFormatException.
    The header name is case insensitive.
    
    Parameters:
    
    name - a String specifying the name of a request header
    
    Returns:
    
    an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
    
    Throws:
    
    NumberFormatException - If the header value can't be converted to an int
  - getDateHeader
```
public long getDateHeader(String name)
```
    Returns the value of the specified request header as a long value that represents a Date object. Use this method with headers that contain dates, such as If-Modified-Since.
    The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
    If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an IllegalArgumentException.
    
    Parameters:
    
    name - a String specifying the name of the header
    
    Returns:
    
    a long value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request
    
    Throws:
    
    IllegalArgumentException - If the header value can't be converted to a date
  - getHeaders
```
public Enumeration<String> getHeaders(String name)
```
    Returns all the values of the specified request header as an Enumeration of String objects.
    Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.
    If the request did not include any headers of the specified name, this method returns an empty Enumeration. The header name is case insensitive. You can use this method with any request header.
    
    Parameters:
    
    name - a String specifying the header name
    
    Returns:
    
    an Enumeration containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null
  - getHeaderNames
```
public Enumeration<String> getHeaderNames()
```
    Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.
    Some servlet containers do not allow servlets to access headers using this method, in which case this method returns null
    
    Returns:
    
    an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, null
  - getAttributes
```
@LazyLoaded
public Map<String,Object> getAttributes()
```
    Returns a map of attributes associated with this request.
    
    Returns:
    
    a map of attributes where the key is a String and the value is an Object
  - getParameters
```
@LazyLoaded
public Map<String,List<String>> getParameters()
```
    Returns a map of parameters associated with this request.
    
    Returns:
    
    a map of parameters where the key is a String and the value is a a list of Strings
  - getCookies
```
@LazyLoaded
public List<XPFHttpCookie> getCookies()
```
    Returns a list containing all of the Cookie objects the client sent with this request.
    
    Returns:
    
    a list of all the Cookies included with this request
  - getSession
```
@LazyLoaded
public XPFHttpSession getSession()
```
    Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.
    To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
    
    Returns:
    
    the HttpSession associated with this request or null if the request has no valid session
  - getLocale
```
@LazyLoaded
public Locale getLocale()
```
    Returns the preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.
    
    Returns:
    
    the preferred Locale for the client
  - getLocales
```
@LazyLoaded
public Enumeration<Locale> getLocales()
```
    Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns an Enumeration containing one Locale, the default locale for the server.
    
    Returns:
    
    an Enumeration of preferred Locale objects for the client
  - getPathTranslated
```
@LazyLoaded
public String getPathTranslated()
```
    Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.
    If the URL does not have any extra path information, this method returns null or the servlet container cannot translate the virtual path to a real path for any reason (such as when the web application is executed from an archive). The web container does not decode this string.
    
    Returns:
    
    a String specifying the real path, or null if the URL does not have any extra path information
  - getRemoteUser
```
@LazyLoaded
public 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. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.
    
    Returns:
    
    a String specifying the login of the user making this request, or null if the user login is not known
  - getRequestURL
```
@LazyLoaded
public StringBuffer getRequestURL()
```
    Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.
    This method is useful for creating redirect messages and for reporting errors.
    
    Returns:
    
    a StringBuffer object containing the reconstructed URL
  - getUserPrincipal
```
@LazyLoaded
public String getUserPrincipal()
```
    Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.
    
    Returns:
    
    a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated
  - isRequestedSessionIdFromCookie
```
@LazyLoaded
public boolean isRequestedSessionIdFromCookie()
```
    Checks whether the requested session ID came in as a cookie.
    
    Returns:
    
    true if the session ID came in as a cookie; otherwise, false
    
    See Also:
    
    getSession()
  - isRequestedSessionIdFromURL
```
@LazyLoaded
public boolean isRequestedSessionIdFromURL()
```
    Checks whether the requested session ID came in as a cookie.
    
    Returns:
    
    true if the session ID came in as a cookie; otherwise, false
    
    See Also:
    
    getSession()
  - isRequestedSessionIdValid
```
@LazyLoaded
public boolean isRequestedSessionIdValid()
```
    Checks whether the requested session ID is still valid.
    If the client did not specify any session ID, this method returns false.
    
    Returns:
    
    true if this request has an id for a valid session in the current session context; false otherwise
    
    See Also:
    
    getRequestedSessionId(), getSession()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Returns the name of the character encoding used in the body of this request. This method returns null if the request does not specify a character encoding
    
    Returns:
    
    a String containing the name of the character encoding, or null if the request does not specify a character encoding
  - getContentLength
```
public int getContentLength()
```
    Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
    
    Returns:
    
    an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE.
  - getContentLengthLong
```
public long getContentLengthLong()
```
    Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.
    
    Returns:
    
    a long containing the length of the request body or -1L if the length is not known
    
    Since:
    
    Servlet 3.1
  - getContentType
```
public String getContentType()
```
    Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.
    
    Returns:
    
    a String containing the name of the MIME type of the request, or null if the type is not known
  - getProtocol
```
public String getProtocol()
```
    Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.
    
    Returns:
    
    a String containing the protocol name and version number
  - getScheme
```
public String getScheme()
```
    Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.
    
    Returns:
    
    a String containing the name of the scheme used to make this request
  - getServerName
```
public String getServerName()
```
    Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.
    
    Returns:
    
    a String containing the name of the server
  - getServerPort
```
public int getServerPort()
```
    Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.
    
    Returns:
    
    an integer specifying the port number
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.
    
    Returns:
    
    a String containing the IP address of the client that sent the request
  - getRemoteHost
```
public String getRemoteHost()
```
    Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.
    
    Returns:
    
    a String containing the fully qualified name of the client
  - getRemotePort
```
public int getRemotePort()
```
    Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
    
    Returns:
    
    an integer specifying the port number
    
    Since:
    
    Servlet 2.4
  - isSecure
```
public boolean isSecure()
```
    Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
    
    Returns:
    
    a boolean indicating if the request was made using a secure channel
  - getLocalName
```
public String getLocalName()
```
    Returns the host name of the Internet Protocol (IP) interface on which the request was received.
    
    Returns:
    
    a String containing the host name of the IP on which the request was received.
    
    Since:
    
    Servlet 2.4
  - getLocalAddr
```
public String getLocalAddr()
```
    Returns the Internet Protocol (IP) address of the interface on which the request was received.
    
    Returns:
    
    a String containing the IP address on which the request was received.
    
    Since:
    
    Servlet 2.4
  - getLocalPort
```
public int getLocalPort()
```
    Returns the Internet Protocol (IP) port number of the interface on which the request was received.
    
    Returns:
    
    an integer specifying the port number
    
    Since:
    
    Servlet 2.4
  - getAuthType
```
public String getAuthType()
```
    Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated null is returned.
    Same as the value of the CGI variable AUTH_TYPE.
    
    Returns:
    
    one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.
  - getContextPath
```
@NonNull
public @NonNull String getContextPath()
```
    Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.
    
    Returns:
    
    a String specifying the portion of the request URI that indicates the context of the request
  - getHeaders
```
@NonNull
public @NonNull Map<String,List<String>> getHeaders()
```
    Returns a map of all the headers that were sent with this request. Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list. The header name is case insensitive. You can use this method with any request header.
    
    Returns:
    
    an map containing the name of the header as the key and a list of strings as the values.
  - getMethod
```
@NonNull
public @NonNull String getMethod()
```
    Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.
    
    Returns:
    
    a String specifying the name of the method with which this request was made
  - getPathInfo
```
public String getPathInfo()
```
    Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.
    This method returns null if there was no extra path information.
    Same as the value of the CGI variable PATH_INFO.
    
    Returns:
    
    a String, decoded by the web container, specifying extra path information that comes after the servlet path but before the query string in the request URL; or null if the URL does not have any extra path information
  - getQueryString
```
public String getQueryString()
```
    Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.
    
    Returns:
    
    a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Returns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returns null.
    
    Returns:
    
    a String specifying the session ID, or null if the request did not specify a session ID
    
    See Also:
    
    isRequestedSessionIdValid()
  - getRequestURI
```
@NonNull
public @NonNull 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. The web container does not decode this String. For example:
    
    First line of HTTP request Returned Value
    POST /some/path.html HTTP/1.1 /some/path.html
    GET http://foo.bar/a.html HTTP/1.0 /a.html
    HEAD /xyz?a=b HTTP/1.1 /xyz
    
    Returns:
    
    a String containing the part of the URL from the protocol name up to the query string
  - getServletPath
```
@NonNull
public @NonNull String getServletPath()
```
    Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.
    This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
    
    Returns:
    
    a String containing the name or path of the servlet being called, as specified in the request URL, decoded, or an empty string if the servlet used to process the request is matched using the "/*" pattern.
  - getRequestedSessionIdFromCookie
```
public XPFEntitySupplier<Boolean> getRequestedSessionIdFromCookie()
```
    Checks whether the requested session ID came in as a cookie.
    
    Returns:
    
    true if the session ID came in as a cookie; otherwise, false
    
    See Also:
    
    getSession()
  - getRequestedSessionIdFromURL
```
public XPFEntitySupplier<Boolean> getRequestedSessionIdFromURL()
```
    Checks whether the requested session ID came in as part of the request URL.
    
    Returns:
    
    true if the session ID came in as part of a URL; otherwise, false
    
    See Also:
    
    getSession()
  - getRequestedSessionIdValid
```
public XPFEntitySupplier<Boolean> getRequestedSessionIdValid()
```
    Checks whether the requested session ID is still valid.
    If the client did not specify any session ID, this method returns false.
    
    Returns:
    
    true if this request has an id for a valid session in the current session context; false otherwise
    
    See Also:
    
    getRequestedSessionId(), getSession()

First line of HTTP request	Returned Value
POST /some/path.html HTTP/1.1		/some/path.html
GET http://foo.bar/a.html HTTP/1.0		/a.html
HEAD /xyz?a=b HTTP/1.1		/xyz

Class XPFHttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XPFHttpServletRequest

Method Detail

getAttribute

getAttributeNames

getParameter

getParameterNames

getParameterValues

getParameterMap

getHeader

getIntHeader

getDateHeader

getHeaders

getHeaderNames

getAttributes

getParameters

getCookies

getSession

getLocale

getLocales

getPathTranslated

getRemoteUser

getRequestURL

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdValid

toString

equals

canEqual

hashCode

getCharacterEncoding

getContentLength

getContentLengthLong

getContentType

getProtocol

getScheme

getServerName

getServerPort

getRemoteAddr

getRemoteHost

getRemotePort

isSecure

getLocalName

getLocalAddr

getLocalPort

getAuthType

getContextPath

getHeaders

getMethod

getPathInfo

getQueryString

getRequestedSessionId

getRequestURI

getServletPath

getRequestedSessionIdFromCookie

getRequestedSessionIdFromURL

getRequestedSessionIdValid