com.liferay.portal.kernel.util

Class HttpUtil

java.lang.Object

com.liferay.portal.kernel.util.HttpUtil

public class HttpUtil
extends java.lang.Object

Author:

Brian Wing Shun Chan

Constructor Summary

Constructors

Constructor and Description
HttpUtil()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpUtil

public HttpUtil()

Method Detail

addParameter

public static java.lang.String addParameter(java.lang.String url,
                                            java.lang.String name,
                                            boolean value)

addParameter

public static java.lang.String addParameter(java.lang.String url,
                                            java.lang.String name,
                                            double value)

addParameter

public static java.lang.String addParameter(java.lang.String url,
                                            java.lang.String name,
                                            int value)

addParameter

public static java.lang.String addParameter(java.lang.String url,
                                            java.lang.String name,
                                            long value)

addParameter

public static java.lang.String addParameter(java.lang.String url,
                                            java.lang.String name,
                                            short value)

addParameter

public static java.lang.String addParameter(java.lang.String url,
                                            java.lang.String name,
                                            java.lang.String value)

decodePath

public static java.lang.String decodePath(java.lang.String path)

decodeURL

public static java.lang.String decodeURL(java.lang.String url)

decodeURL

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

Deprecated. As of Wilberforce (7.0.x), replaced by decodeURL(String)

encodeParameters

public static java.lang.String encodeParameters(java.lang.String url)

encodePath

public static java.lang.String encodePath(java.lang.String path)

encodeURL

@Deprecated
public static java.lang.String encodeURL(java.lang.String url)

Deprecated. As of Judson (7.1.x), replaced by URLCodec.encodeURL(String)

encodeURL

@Deprecated
public static java.lang.String encodeURL(java.lang.String url,
                                                     boolean escapeSpaces)

Deprecated. As of Judson (7.1.x), replaced by URLCodec.encodeURL(String, boolean)

fixPath

public static java.lang.String fixPath(java.lang.String path)

fixPath

public static java.lang.String fixPath(java.lang.String path,
                                       boolean leading,
                                       boolean trailing)

getCompleteURL

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

getCookies

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

getDomain

public static java.lang.String getDomain(java.lang.String url)

getHttp

public static Http getHttp()

getIpAddress

public static java.lang.String getIpAddress(java.lang.String url)

getParameter

public static java.lang.String getParameter(java.lang.String url,
                                            java.lang.String name)

getParameter

public static java.lang.String getParameter(java.lang.String url,
                                            java.lang.String name,
                                            boolean escaped)

getParameterMap

public static java.util.Map<java.lang.String,java.lang.String[]> getParameterMap(java.lang.String queryString)

getPath

public static java.lang.String getPath(java.lang.String url)

getProtocol

public static java.lang.String getProtocol(javax.portlet.ActionRequest actionRequest)

getProtocol

public static java.lang.String getProtocol(boolean secure)

getProtocol

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

getProtocol

public static java.lang.String getProtocol(javax.portlet.RenderRequest renderRequest)

getProtocol

public static java.lang.String getProtocol(java.lang.String url)

getQueryString

public static java.lang.String getQueryString(java.lang.String url)

getRequestURL

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

hasDomain

public static boolean hasDomain(java.lang.String url)

hasProtocol

public static boolean hasProtocol(java.lang.String url)

hasProxyConfig

public static boolean hasProxyConfig()

isNonProxyHost

public static boolean isNonProxyHost(java.lang.String host)

isProxyHost

public static boolean isProxyHost(java.lang.String host)

isSecure

public static boolean isSecure(java.lang.String url)

normalizePath

public static java.lang.String normalizePath(java.lang.String uri)

parameterMapFromString

public static java.util.Map<java.lang.String,java.lang.String[]> parameterMapFromString(java.lang.String queryString)

parameterMapToString

public static java.lang.String parameterMapToString(java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

parameterMapToString

public static java.lang.String parameterMapToString(java.util.Map<java.lang.String,java.lang.String[]> parameterMap,
                                                    boolean addQuestion)

protocolize

public static java.lang.String protocolize(java.lang.String url,
                                           javax.portlet.ActionRequest actionRequest)

protocolize

public static java.lang.String protocolize(java.lang.String url,
                                           boolean secure)

protocolize

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

protocolize

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

protocolize

public static java.lang.String protocolize(java.lang.String url,
                                           javax.portlet.RenderRequest renderRequest)

removeDomain

public static java.lang.String removeDomain(java.lang.String url)

removeParameter

public static java.lang.String removeParameter(java.lang.String url,
                                               java.lang.String name)

removePathParameters

public static java.lang.String removePathParameters(java.lang.String uri)

removeProtocol

public static java.lang.String removeProtocol(java.lang.String url)

sanitizeHeader

public static java.lang.String sanitizeHeader(java.lang.String header)

setParameter

public static java.lang.String setParameter(java.lang.String url,
                                            java.lang.String name,
                                            boolean value)

setParameter

public static java.lang.String setParameter(java.lang.String url,
                                            java.lang.String name,
                                            double value)

setParameter

public static java.lang.String setParameter(java.lang.String url,
                                            java.lang.String name,
                                            int value)

setParameter

public static java.lang.String setParameter(java.lang.String url,
                                            java.lang.String name,
                                            long value)

setParameter

public static java.lang.String setParameter(java.lang.String url,
                                            java.lang.String name,
                                            short value)

setParameter

public static java.lang.String setParameter(java.lang.String url,
                                            java.lang.String name,
                                            java.lang.String value)

shortenURL

public static java.lang.String shortenURL(java.lang.String url)

shortenURL

@Deprecated
public static java.lang.String shortenURL(java.lang.String url,
                                                      int count)

Deprecated. As of Judson (7.1.x), replaced by shortenURL(String)

URLtoByteArray

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

Throws:

java.io.IOException

URLtoByteArray

public static byte[] URLtoByteArray(java.lang.String location)
                             throws java.io.IOException

Throws:

java.io.IOException

URLtoByteArray

public static byte[] URLtoByteArray(java.lang.String location,
                                    boolean post)
                             throws java.io.IOException

Throws:

java.io.IOException

URLtoInputStream

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

Throws:

java.io.IOException

URLtoInputStream

public static java.io.InputStream URLtoInputStream(java.lang.String location)
                                            throws java.io.IOException

Throws:

java.io.IOException

URLtoInputStream

public static java.io.InputStream URLtoInputStream(java.lang.String location,
                                                   boolean post)
                                            throws java.io.IOException

Throws:

java.io.IOException

URLtoString

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

Throws:

java.io.IOException

URLtoString

public static java.lang.String URLtoString(java.lang.String location)
                                    throws java.io.IOException

Throws:

java.io.IOException

URLtoString

public static java.lang.String URLtoString(java.lang.String location,
                                           boolean post)
                                    throws java.io.IOException

Throws:

java.io.IOException

URLtoString

public static java.lang.String URLtoString(java.net.URL url)
                                    throws java.io.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:

java.io.IOException - if an IO Exception occurred

setHttp

public void setHttp(Http http)