com.liferay.portal.kernel.util

Class HttpUtil

Object

com.liferay.portal.kernel.util.HttpUtil

public class HttpUtil
extends Object

Author:

Brian Wing Shun Chan

Constructor Summary

Constructors

Constructor and Description
HttpUtil()

Method Summary

Modifier and Type	Method and Description
static String	addParameter(String url, String name, boolean value)
static String	addParameter(String url, String name, double value)
static String	addParameter(String url, String name, int value)
static String	addParameter(String url, String name, long value)
static String	addParameter(String url, String name, short value)
static String	addParameter(String url, String name, String value)
static String	decodePath(String path)
static String	decodeURL(String url)
static String	decodeURL(String url, boolean unescapeSpaces) Deprecated. As of 7.0.0, replaced by decodeURL(String)
static String	encodeParameters(String url)
static String	encodePath(String path)
static String	encodeURL(String url)
static String	encodeURL(String url, boolean escapeSpaces)
static String	fixPath(String path)
static String	fixPath(String path, boolean leading, boolean trailing)
static String	getCompleteURL(javax.servlet.http.HttpServletRequest request)
static javax.servlet.http.Cookie[]	getCookies()
static String	getDomain(String url)
static Http	getHttp()
static String	getIpAddress(String url)
static String	getParameter(String url, String name)
static String	getParameter(String url, String name, boolean escaped)
static Map<String,String[]>	getParameterMap(String queryString)
static String	getPath(String url)
static String	getProtocol(ActionRequest actionRequest)
static String	getProtocol(boolean secure)
static String	getProtocol(javax.servlet.http.HttpServletRequest request)
static String	getProtocol(RenderRequest renderRequest)
static String	getProtocol(String url)
static String	getQueryString(String url)
static String	getRequestURL(javax.servlet.http.HttpServletRequest request)
static boolean	hasDomain(String url)
static boolean	hasProtocol(String url)
static boolean	hasProxyConfig()
static boolean	isNonProxyHost(String host)
static boolean	isProxyHost(String host)
static boolean	isSecure(String url)
static String	normalizePath(String uri)
static Map<String,String[]>	parameterMapFromString(String queryString)
static String	parameterMapToString(Map<String,String[]> parameterMap)
static String	parameterMapToString(Map<String,String[]> parameterMap, boolean addQuestion)
static String	protocolize(String url, ActionRequest actionRequest)
static String	protocolize(String url, boolean secure)
static String	protocolize(String url, javax.servlet.http.HttpServletRequest request)
static String	protocolize(String url, int port, boolean secure)
static String	protocolize(String url, RenderRequest renderRequest)
static String	removeDomain(String url)
static String	removeParameter(String url, String name)
static String	removePathParameters(String uri)
static String	removeProtocol(String url)
static String	sanitizeHeader(String header)
void	setHttp(Http http)
static String	setParameter(String url, String name, boolean value)
static String	setParameter(String url, String name, double value)
static String	setParameter(String url, String name, int value)
static String	setParameter(String url, String name, long value)
static String	setParameter(String url, String name, short value)
static String	setParameter(String url, String name, String value)
static String	shortenURL(String url, int count)
static byte[]	URLtoByteArray(Http.Options options)
static byte[]	URLtoByteArray(String location)
static byte[]	URLtoByteArray(String location, boolean post)
static InputStream	URLtoInputStream(Http.Options options)
static InputStream	URLtoInputStream(String location)
static InputStream	URLtoInputStream(String location, boolean post)
static String	URLtoString(Http.Options options)
static String	URLtoString(String location)
static String	URLtoString(String location, boolean post)
static String	URLtoString(URL url) This method only uses the default Commons HttpClient implementation when the URL object represents a HTTP resource.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpUtil

public HttpUtil()

Method Detail

addParameter

public static String addParameter(String url,
                                  String name,
                                  boolean value)

addParameter

public static String addParameter(String url,
                                  String name,
                                  double value)

addParameter

public static String addParameter(String url,
                                  String name,
                                  int value)

addParameter

public static String addParameter(String url,
                                  String name,
                                  long value)

addParameter

public static String addParameter(String url,
                                  String name,
                                  short value)

addParameter

public static String addParameter(String url,
                                  String name,
                                  String value)

decodePath

public static String decodePath(String path)

decodeURL

public static String decodeURL(String url)

decodeURL

@Deprecated
public static String decodeURL(String url,
                                           boolean unescapeSpaces)

Deprecated. As of 7.0.0, replaced by decodeURL(String)

encodeParameters

public static String encodeParameters(String url)

encodePath

public static String encodePath(String path)

encodeURL

public static String encodeURL(String url)

encodeURL

public static String encodeURL(String url,
                               boolean escapeSpaces)

fixPath

public static String fixPath(String path)

fixPath

public static String fixPath(String path,
                             boolean leading,
                             boolean trailing)

getCompleteURL

public static String getCompleteURL(javax.servlet.http.HttpServletRequest request)

getCookies

public static javax.servlet.http.Cookie[] getCookies()

getDomain

public static String getDomain(String url)

getHttp

public static Http getHttp()

getIpAddress

public static String getIpAddress(String url)

getParameter

public static String getParameter(String url,
                                  String name)

getParameter

public static String getParameter(String url,
                                  String name,
                                  boolean escaped)

getParameterMap

public static Map<String,String[]> getParameterMap(String queryString)

getPath

public static String getPath(String url)

getProtocol

public static String getProtocol(ActionRequest actionRequest)

getProtocol

public static String getProtocol(boolean secure)

getProtocol

public static String getProtocol(javax.servlet.http.HttpServletRequest request)

getProtocol

public static String getProtocol(RenderRequest renderRequest)

getProtocol

public static String getProtocol(String url)

getQueryString

public static String getQueryString(String url)

getRequestURL

public static String getRequestURL(javax.servlet.http.HttpServletRequest request)

hasDomain

public static boolean hasDomain(String url)

hasProtocol

public static boolean hasProtocol(String url)

hasProxyConfig

public static boolean hasProxyConfig()

isNonProxyHost

public static boolean isNonProxyHost(String host)

isProxyHost

public static boolean isProxyHost(String host)

isSecure

public static boolean isSecure(String url)

normalizePath

public static String normalizePath(String uri)

parameterMapFromString

public static Map<String,String[]> parameterMapFromString(String queryString)

parameterMapToString

public static String parameterMapToString(Map<String,String[]> parameterMap)

parameterMapToString

public static String parameterMapToString(Map<String,String[]> parameterMap,
                                          boolean addQuestion)

protocolize

public static String protocolize(String url,
                                 ActionRequest actionRequest)

protocolize

public static String protocolize(String url,
                                 boolean secure)

protocolize

public static String protocolize(String url,
                                 javax.servlet.http.HttpServletRequest request)

protocolize

public static String protocolize(String url,
                                 int port,
                                 boolean secure)

protocolize

public static String protocolize(String url,
                                 RenderRequest renderRequest)

removeDomain

public static String removeDomain(String url)

removeParameter

public static String removeParameter(String url,
                                     String name)

removePathParameters

public static String removePathParameters(String uri)

removeProtocol

public static String removeProtocol(String url)

sanitizeHeader

public static String sanitizeHeader(String header)

setParameter

public static String setParameter(String url,
                                  String name,
                                  boolean value)

setParameter

public static String setParameter(String url,
                                  String name,
                                  double value)

setParameter

public static String setParameter(String url,
                                  String name,
                                  int value)

setParameter

public static String setParameter(String url,
                                  String name,
                                  long value)

setParameter

public static String setParameter(String url,
                                  String name,
                                  short value)

setParameter

public static String setParameter(String url,
                                  String name,
                                  String value)

shortenURL

public static String shortenURL(String url,
                                int count)

URLtoByteArray

public static byte[] URLtoByteArray(Http.Options options)
                             throws IOException

Throws:

IOException

URLtoByteArray

public static byte[] URLtoByteArray(String location)
                             throws IOException

Throws:

IOException

URLtoByteArray

public static byte[] URLtoByteArray(String location,
                                    boolean post)
                             throws IOException

Throws:

IOException

URLtoInputStream

public static InputStream URLtoInputStream(Http.Options options)
                                    throws IOException

Throws:

IOException

URLtoInputStream

public static InputStream URLtoInputStream(String location)
                                    throws IOException

Throws:

IOException

URLtoInputStream

public static InputStream URLtoInputStream(String location,
                                           boolean post)
                                    throws IOException

Throws:

IOException

URLtoString

public static String URLtoString(Http.Options options)
                          throws IOException

Throws:

IOException

URLtoString

public static String URLtoString(String location)
                          throws IOException

Throws:

IOException

URLtoString

public static String URLtoString(String location,
                                 boolean post)
                          throws IOException

Throws:

IOException

URLtoString

public static String URLtoString(URL url)
                          throws IOException

This method only uses the default Commons HttpClient implementation when the URL object represents a HTTP resource. The URL object could also represent a file or some JNDI resource. In that case, the default Java implementation is used.

Parameters:

url - the URL

Returns:

A string representation of the resource referenced by the URL object

Throws:

IOException - if an IO Exception occurred

setHttp

public void setHttp(Http http)