com.liferay.portal.kernel.util
Interface Http

public interface Http

View Source

Author:

Brian Wing Shun Chan

Nested Class Summary

static class	Http.Auth
static class	Http.Body

Field Summary

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

Method Summary

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	decodeURL(java.lang.String url)
java.lang.String	decodeURL(java.lang.String url, boolean unescapeSpace)
java.lang.String	encodeURL(java.lang.String url)
java.lang.String	encodeURL(java.lang.String url, boolean escapeSpaces)
java.lang.String	getCompleteURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getDomain(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	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	hasProxyConfig()
boolean	isNonProxyHost(java.lang.String host)
boolean	isProxyHost(java.lang.String host)
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, 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	removeProtocol(java.lang.String url)
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)
byte[]	URLtoByteArray(java.lang.String location)
byte[]	URLtoByteArray(java.lang.String location, boolean post)
byte[]	URLtoByteArray(java.lang.String location, javax.servlet.http.Cookie[] cookies, Http.Auth auth, Http.Body body, boolean post)
byte[]	URLtoByteArray(java.lang.String location, javax.servlet.http.Cookie[] cookies, Http.Auth auth, java.util.Map<java.lang.String,java.lang.String> parts, boolean post)
java.lang.String	URLtoString(java.lang.String location)
java.lang.String	URLtoString(java.lang.String location, boolean post)
java.lang.String	URLtoString(java.lang.String location, javax.servlet.http.Cookie[] cookies, Http.Auth auth, Http.Body body, boolean post)
java.lang.String	URLtoString(java.lang.String location, javax.servlet.http.Cookie[] cookies, Http.Auth auth, java.util.Map<java.lang.String,java.lang.String> parts, 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

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)

decodeURL

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

decodeURL

java.lang.String decodeURL(java.lang.String url,
                           boolean unescapeSpace)

encodeURL

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

encodeURL

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

getCompleteURL

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

getDomain

java.lang.String getDomain(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)

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)

hasProxyConfig

boolean hasProxyConfig()

isNonProxyHost

boolean isNonProxyHost(java.lang.String host)

isProxyHost

boolean isProxyHost(java.lang.String host)

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,
                             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)

removeProtocol

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

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)

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

URLtoByteArray

byte[] URLtoByteArray(java.lang.String location,
                      javax.servlet.http.Cookie[] cookies,
                      Http.Auth auth,
                      Http.Body body,
                      boolean post)
                      throws java.io.IOException

Throws:

java.io.IOException

URLtoByteArray

byte[] URLtoByteArray(java.lang.String location,
                      javax.servlet.http.Cookie[] cookies,
                      Http.Auth auth,
                      java.util.Map<java.lang.String,java.lang.String> parts,
                      boolean post)
                      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.lang.String location,
                             javax.servlet.http.Cookie[] cookies,
                             Http.Auth auth,
                             Http.Body body,
                             boolean post)
                             throws java.io.IOException

Throws:

java.io.IOException

URLtoString

java.lang.String URLtoString(java.lang.String location,
                             javax.servlet.http.Cookie[] cookies,
                             Http.Auth auth,
                             java.util.Map<java.lang.String,java.lang.String> parts,
                             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 - URL object

Returns:

A string representation of the resource referenced by the URL object

Throws:

java.io.IOException