com.liferay.portal.kernel.util

Interface Http

@ProviderType
public interface Http

Author:

Brian Wing Shun Chan, Hugo Huijser

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Http.Auth
static class	Http.Body
static class	Http.FilePart
static class	Http.Method
static class	Http.Options
static class	Http.Response

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTP
static int	HTTP_PORT
static java.lang.String	HTTP_WITH_SLASH
static java.lang.String	HTTPS
static int	HTTPS_PORT
static java.lang.String	HTTPS_WITH_SLASH
static java.lang.String	PROTOCOL_DELIMITER
static int	URL_MAXIMUM_LENGTH

Method Summary

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

Field Detail

HTTP

static final java.lang.String HTTP

See Also:

Constant Field Values

HTTP_PORT

static final int HTTP_PORT

See Also:

Constant Field Values

HTTP_WITH_SLASH

static final java.lang.String HTTP_WITH_SLASH

See Also:

Constant Field Values

HTTPS

static final java.lang.String HTTPS

See Also:

Constant Field Values

HTTPS_PORT

static final int HTTPS_PORT

See Also:

Constant Field Values

HTTPS_WITH_SLASH

static final java.lang.String HTTPS_WITH_SLASH

See Also:

Constant Field Values

PROTOCOL_DELIMITER

static final java.lang.String PROTOCOL_DELIMITER

See Also:

Constant Field Values

URL_MAXIMUM_LENGTH

static final int URL_MAXIMUM_LENGTH

See Also:

Constant Field Values

Method Detail

addParameter

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

addParameter

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

addParameter

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

addParameter

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

addParameter

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

addParameter

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

decodePath

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

decodeURL

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

decodeURL

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

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

encodeParameters

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

encodePath

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

encodeURL

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

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

encodeURL

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

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

fixPath

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

fixPath

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

getCompleteURL

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

getCookies

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

getDomain

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

getIpAddress

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

getParameter

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

getParameter

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

getParameterMap

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

getPath

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

getProtocol

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

getProtocol

java.lang.String getProtocol(boolean secure)

getProtocol

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

getProtocol

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

getProtocol

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

getQueryString

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

getRequestURL

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

hasDomain

boolean hasDomain(java.lang.String url)

hasProtocol

boolean hasProtocol(java.lang.String url)

hasProxyConfig

boolean hasProxyConfig()

isNonProxyHost

boolean isNonProxyHost(java.lang.String host)

isProxyHost

boolean isProxyHost(java.lang.String host)

isSecure

boolean isSecure(java.lang.String url)

normalizePath

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

parameterMapFromString

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

parameterMapToString

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

parameterMapToString

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

protocolize

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

protocolize

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

protocolize

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

protocolize

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

protocolize

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

removeDomain

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

removeParameter

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

removePathParameters

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

removeProtocol

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

sanitizeHeader

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

setParameter

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

setParameter

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

setParameter

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

setParameter

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

setParameter

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

setParameter

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

shortenURL

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

shortenURL

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

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

URLtoByteArray

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

Throws:

java.io.IOException

URLtoByteArray

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

Throws:

java.io.IOException

URLtoByteArray

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

Throws:

java.io.IOException

URLtoInputStream

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

Throws:

java.io.IOException

URLtoInputStream

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

Throws:

java.io.IOException

URLtoInputStream

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

Throws:

java.io.IOException

URLtoString

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

Throws:

java.io.IOException

URLtoString

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

Throws:

java.io.IOException

URLtoString

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

Throws:

java.io.IOException

URLtoString

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