Package org.apache.wiki.util
Class HttpUtil
java.lang.Object
org.apache.wiki.util.HttpUtil
Contains useful utilities for some common HTTP tasks.
- Since:
- 2.1.61.
-
Method Summary
Modifier and TypeMethodDescriptionstatic booleancheckFor304(javax.servlet.http.HttpServletRequest req, String pageName, Date lastModified) If returns true, then should return a 304 (HTTP_NOT_MODIFIED)static voidclearCookie(javax.servlet.http.HttpServletResponse response, String cookieName) static StringcreateETag(String pageName, Date lastModified) Creates an ETag based on page information.static StringgetAbsoluteUrl(javax.servlet.http.HttpServletRequest request) Generate an absolute URL based solely on the given HttpServletRequest.static StringgetAbsoluteUrl(javax.servlet.http.HttpServletRequest request, String relativeUrl) Generates an absolute URL based on the given HttpServletRequest and a relative URL.static StringgetRemoteAddress(javax.servlet.http.HttpServletRequest req) returns the remote address by looking intox-forwarded-forheader or, if unavailable, intoServletRequest.getRemoteAddr().static StringguessValidURI(String uri) Attempts to form a valid URI based on the string given.static booleanisIPV4Address(String name) Verifies whether a String represents an IPv4 address.static StringretrieveCookieValue(javax.servlet.http.HttpServletRequest request, String cookieName) Attempts to retrieve the given cookie value from the request.static StringsafeGetQueryString(javax.servlet.http.HttpServletRequest request, Charset contentEncoding) Returns the query string (the portion after the question mark).
-
Method Details
-
getRemoteAddress
returns the remote address by looking intox-forwarded-forheader or, if unavailable, intoServletRequest.getRemoteAddr().- Parameters:
req- http request- Returns:
- remote address associated to the request.
-
retrieveCookieValue
public static String retrieveCookieValue(javax.servlet.http.HttpServletRequest request, String cookieName) Attempts to retrieve the given cookie value from the request. Returns the string value (which may or may not be decoded correctly, depending on browser!), or null if the cookie is not found. The algorithm will automatically trim leading and trailing double quotes, if found.- Parameters:
request- The current requestcookieName- The name of the cookie to fetch.- Returns:
- Value of the cookie, or null, if there is no such cookie.
-
createETag
Creates an ETag based on page information. An ETag is unique to each page and version, so it can be used to check if the page has changed. Do not assume that the ETag is in any particular format.- Parameters:
pageName- The page name for which the ETag should be created.lastModified- The page last modified date for which the ETag should be created.- Returns:
- A String depiction of an ETag.
-
checkFor304
public static boolean checkFor304(javax.servlet.http.HttpServletRequest req, String pageName, Date lastModified) If returns true, then should return a 304 (HTTP_NOT_MODIFIED)- Parameters:
req- the HTTP requestpageName- the wiki page name to check forlastModified- the last modified date of the wiki page to check for- Returns:
- the result of the check
-
guessValidURI
Attempts to form a valid URI based on the string given. Currently it can guess email addresses (mailto:). If nothing else is given, it assumes it to be an http:// url.- Parameters:
uri- URI to take a poke at- Returns:
- Possibly a valid URI
- Since:
- 2.2.8
-
safeGetQueryString
public static String safeGetQueryString(javax.servlet.http.HttpServletRequest request, Charset contentEncoding) Returns the query string (the portion after the question mark).- Parameters:
request- The HTTP request to parse.- Returns:
- The query string. If the query string is null, returns an empty string.
- Since:
- 2.1.3 (method moved from WikiEngine on 2.11.0.M6)
-
isIPV4Address
Verifies whether a String represents an IPv4 address. The algorithm is extremely efficient and does not allocate any objects.- Parameters:
name- the address to test- Returns:
- the result
-
clearCookie
-
getAbsoluteUrl
public static String getAbsoluteUrl(javax.servlet.http.HttpServletRequest request, String relativeUrl) Generates an absolute URL based on the given HttpServletRequest and a relative URL. This method takes into account various headers like X-Forwarded-Host, X-Forwarded-Proto, and X-Forwarded-Server to construct the absolute URL.- Parameters:
request- The HttpServletRequest object, used to obtain scheme, server name, and port.relativeUrl- The relative URL to be appended to the base URL. Can be null.- Returns:
- The absolute URL as a String.
- Since:
- 2.12.2
-
getAbsoluteUrl
Generate an absolute URL based solely on the given HttpServletRequest. This is a convenience method that callsgetAbsoluteUrl(HttpServletRequest, String)with a null relative URL.- Parameters:
request- The HttpServletRequest object, used to obtain scheme, server name, and port.- Returns:
- The absolute URL as a String.
- Since:
- 2.12.2
- See Also:
-