com.liferay.portal.util

Class HttpImpl

java.lang.Object

com.liferay.portal.util.HttpImpl

All Implemented Interfaces:

Http

public class HttpImpl
extends java.lang.Object
implements Http

Nested Class Summary

Nested classes/interfaces inherited from interface com.liferay.portal.kernel.util.Http

Http.Auth, Http.Body, Http.FilePart, Http.Method, Http.Options, Http.Response

Field Summary

Fields inherited from interface com.liferay.portal.kernel.util.Http

HTTP, HTTP_PORT, HTTP_WITH_SLASH, HTTPS, HTTPS_PORT, HTTPS_WITH_SLASH, PROTOCOL_DELIMITER, URL_MAXIMUM_LENGTH

Constructor Summary

Constructors

Constructor and Description
HttpImpl()

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)
protected void	addProxyCredentials(java.net.URI uri, HttpClientContext httpClientContext)
java.lang.String	decodePath(java.lang.String path)
java.lang.String	decodeURL(java.lang.String url)
void	destroy()
java.lang.String	encodeParameters(java.lang.String url)
java.lang.String	encodePath(java.lang.String path)
java.lang.String	fixPath(java.lang.String path)
java.lang.String	fixPath(java.lang.String path, boolean leading, boolean trailing)
protected CloseableHttpClient	getCloseableHttpClient(HttpHost proxyHost)
java.lang.String	getCompleteURL(javax.servlet.http.HttpServletRequest httpServletRequest)
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 httpServletRequest)
java.lang.String	getProtocol(javax.portlet.RenderRequest renderRequest)
java.lang.String	getProtocol(java.lang.String url)
java.lang.String	getQueryString(java.lang.String url)
protected RequestConfig.Builder	getRequestConfigBuilder(java.net.URI uri, int timeout)
java.lang.String	getRequestURL(javax.servlet.http.HttpServletRequest httpServletRequest)
java.net.URI	getURI(java.lang.String uriString)
boolean	hasDomain(java.lang.String url)
boolean	hasProtocol(java.lang.String url)
boolean	hasProxyConfig()
protected boolean	hasRequestHeader(RequestBuilder requestBuilder, java.lang.String name)
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)
protected void	processPostMethod(RequestBuilder requestBuilder, java.util.Map<java.lang.String,java.lang.String> headers, java.util.List<Http.FilePart> fileParts, java.util.Map<java.lang.String,java.lang.String> parts)
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 httpServletRequest)
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)
protected Cookie	toHttpCookie(javax.servlet.http.Cookie cookie)
protected Cookie[]	toHttpCookies(javax.servlet.http.Cookie[] cookies)
protected javax.servlet.http.Cookie	toServletCookie(Cookie httpCookie)
protected javax.servlet.http.Cookie[]	toServletCookies(java.util.List<Cookie> httpCookies)
byte[]	URLtoByteArray(Http.Options options)
byte[]	URLtoByteArray(java.lang.String location)
byte[]	URLtoByteArray(java.lang.String location, boolean post)
protected byte[]	URLtoByteArray(java.lang.String location, Http.Method method, java.util.Map<java.lang.String,java.lang.String> headers, javax.servlet.http.Cookie[] cookies, Http.Auth auth, Http.Body body, java.util.List<Http.FilePart> fileParts, java.util.Map<java.lang.String,java.lang.String> parts, Http.Response response, boolean followRedirects)
protected byte[]	URLtoByteArray(java.lang.String location, Http.Method method, java.util.Map<java.lang.String,java.lang.String> headers, javax.servlet.http.Cookie[] cookies, Http.Auth auth, Http.Body body, java.util.List<Http.FilePart> fileParts, java.util.Map<java.lang.String,java.lang.String> parts, Http.Response response, boolean followRedirects, int timeout)
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)
protected java.io.InputStream	URLtoInputStream(java.lang.String location, Http.Method method, java.util.Map<java.lang.String,java.lang.String> headers, javax.servlet.http.Cookie[] cookies, Http.Auth auth, Http.Body body, java.util.List<Http.FilePart> fileParts, java.util.Map<java.lang.String,java.lang.String> parts, Http.Response response, boolean followRedirects)
protected java.io.InputStream	URLtoInputStream(java.lang.String location, Http.Method method, java.util.Map<java.lang.String,java.lang.String> headers, javax.servlet.http.Cookie[] cookies, Http.Auth auth, Http.Body body, java.util.List<Http.FilePart> fileParts, java.util.Map<java.lang.String,java.lang.String> parts, Http.Response response, boolean followRedirects, int timeout)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpImpl

public HttpImpl()

Method Detail

addParameter

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

Specified by:

addParameter in interface Http

addParameter

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

Specified by:

addParameter in interface Http

addParameter

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

Specified by:

addParameter in interface Http

addParameter

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

Specified by:

addParameter in interface Http

addParameter

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

Specified by:

addParameter in interface Http

addParameter

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

Specified by:

addParameter in interface Http

decodePath

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

Specified by:

decodePath in interface Http

decodeURL

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

Specified by:

decodeURL in interface Http

destroy

public void destroy()

encodeParameters

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

Specified by:

encodeParameters in interface Http

encodePath

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

Specified by:

encodePath in interface Http

fixPath

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

Specified by:

fixPath in interface Http

fixPath

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

Specified by:

fixPath in interface Http

getCompleteURL

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

Specified by:

getCompleteURL in interface Http

getCookies

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

Specified by:

getCookies in interface Http

getDomain

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

Specified by:

getDomain in interface Http

getIpAddress

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

Specified by:

getIpAddress in interface Http

getParameter

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

Specified by:

getParameter in interface Http

getParameter

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

Specified by:

getParameter in interface Http

getParameterMap

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

Specified by:

getParameterMap in interface Http

getPath

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

Specified by:

getPath in interface Http

getProtocol

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

Specified by:

getProtocol in interface Http

getProtocol

public java.lang.String getProtocol(boolean secure)

Specified by:

getProtocol in interface Http

getProtocol

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

Specified by:

getProtocol in interface Http

getProtocol

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

Specified by:

getProtocol in interface Http

getProtocol

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

Specified by:

getProtocol in interface Http

getQueryString

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

Specified by:

getQueryString in interface Http

getRequestURL

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

Specified by:

getRequestURL in interface Http

getURI

public java.net.URI getURI(java.lang.String uriString)

Specified by:

getURI in interface Http

hasDomain

public boolean hasDomain(java.lang.String url)

Specified by:

hasDomain in interface Http

hasProtocol

public boolean hasProtocol(java.lang.String url)

Specified by:

hasProtocol in interface Http

hasProxyConfig

public boolean hasProxyConfig()

Specified by:

hasProxyConfig in interface Http

isNonProxyHost

public boolean isNonProxyHost(java.lang.String host)

Specified by:

isNonProxyHost in interface Http

isProxyHost

public boolean isProxyHost(java.lang.String host)

Specified by:

isProxyHost in interface Http

isSecure

public boolean isSecure(java.lang.String url)

Specified by:

isSecure in interface Http

normalizePath

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

Specified by:

normalizePath in interface Http

parameterMapFromString

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

Specified by:

parameterMapFromString in interface Http

parameterMapToString

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

Specified by:

parameterMapToString in interface Http

parameterMapToString

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

Specified by:

parameterMapToString in interface Http

protocolize

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

Specified by:

protocolize in interface Http

protocolize

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

Specified by:

protocolize in interface Http

protocolize

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

Specified by:

protocolize in interface Http

protocolize

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

Specified by:

protocolize in interface Http

protocolize

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

Specified by:

protocolize in interface Http

removeDomain

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

Specified by:

removeDomain in interface Http

removeParameter

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

Specified by:

removeParameter in interface Http

removePathParameters

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

Specified by:

removePathParameters in interface Http

removeProtocol

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

Specified by:

removeProtocol in interface Http

sanitizeHeader

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

Specified by:

sanitizeHeader in interface Http

setParameter

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

Specified by:

setParameter in interface Http

setParameter

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

Specified by:

setParameter in interface Http

setParameter

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

Specified by:

setParameter in interface Http

setParameter

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

Specified by:

setParameter in interface Http

setParameter

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

Specified by:

setParameter in interface Http

setParameter

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

Specified by:

setParameter in interface Http

shortenURL

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

Specified by:

shortenURL in interface Http

URLtoByteArray

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

Specified by:

URLtoByteArray in interface Http

Throws:

java.io.IOException

URLtoByteArray

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

Specified by:

URLtoByteArray in interface Http

Throws:

java.io.IOException

URLtoByteArray

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

Specified by:

URLtoByteArray in interface Http

Throws:

java.io.IOException

URLtoInputStream

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

Specified by:

URLtoInputStream in interface Http

Throws:

java.io.IOException

URLtoInputStream

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

Specified by:

URLtoInputStream in interface Http

Throws:

java.io.IOException

URLtoInputStream

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

Specified by:

URLtoInputStream in interface Http

Throws:

java.io.IOException

URLtoString

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

Specified by:

URLtoString in interface Http

Throws:

java.io.IOException

URLtoString

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

Specified by:

URLtoString in interface Http

Throws:

java.io.IOException

URLtoString

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

Specified by:

URLtoString in interface Http

Throws:

java.io.IOException

URLtoString

public 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.

Specified by:

URLtoString in interface Http

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

addProxyCredentials

protected void addProxyCredentials(java.net.URI uri,
                                   HttpClientContext httpClientContext)

getCloseableHttpClient

protected CloseableHttpClient getCloseableHttpClient(HttpHost proxyHost)

getRequestConfigBuilder

protected RequestConfig.Builder getRequestConfigBuilder(java.net.URI uri,
                                                        int timeout)

hasRequestHeader

protected boolean hasRequestHeader(RequestBuilder requestBuilder,
                                   java.lang.String name)

processPostMethod

protected void processPostMethod(RequestBuilder requestBuilder,
                                 java.util.Map<java.lang.String,java.lang.String> headers,
                                 java.util.List<Http.FilePart> fileParts,
                                 java.util.Map<java.lang.String,java.lang.String> parts)

toHttpCookie

protected Cookie toHttpCookie(javax.servlet.http.Cookie cookie)

toHttpCookies

protected Cookie[] toHttpCookies(javax.servlet.http.Cookie[] cookies)

toServletCookie

protected javax.servlet.http.Cookie toServletCookie(Cookie httpCookie)

toServletCookies

protected javax.servlet.http.Cookie[] toServletCookies(java.util.List<Cookie> httpCookies)

URLtoByteArray

protected byte[] URLtoByteArray(java.lang.String location,
                                Http.Method method,
                                java.util.Map<java.lang.String,java.lang.String> headers,
                                javax.servlet.http.Cookie[] cookies,
                                Http.Auth auth,
                                Http.Body body,
                                java.util.List<Http.FilePart> fileParts,
                                java.util.Map<java.lang.String,java.lang.String> parts,
                                Http.Response response,
                                boolean followRedirects)
                         throws java.io.IOException

Throws:

java.io.IOException

URLtoByteArray

protected byte[] URLtoByteArray(java.lang.String location,
                                Http.Method method,
                                java.util.Map<java.lang.String,java.lang.String> headers,
                                javax.servlet.http.Cookie[] cookies,
                                Http.Auth auth,
                                Http.Body body,
                                java.util.List<Http.FilePart> fileParts,
                                java.util.Map<java.lang.String,java.lang.String> parts,
                                Http.Response response,
                                boolean followRedirects,
                                int timeout)
                         throws java.io.IOException

Throws:

java.io.IOException

URLtoInputStream

protected java.io.InputStream URLtoInputStream(java.lang.String location,
                                               Http.Method method,
                                               java.util.Map<java.lang.String,java.lang.String> headers,
                                               javax.servlet.http.Cookie[] cookies,
                                               Http.Auth auth,
                                               Http.Body body,
                                               java.util.List<Http.FilePart> fileParts,
                                               java.util.Map<java.lang.String,java.lang.String> parts,
                                               Http.Response response,
                                               boolean followRedirects)
                                        throws java.io.IOException

Throws:

java.io.IOException

URLtoInputStream

protected java.io.InputStream URLtoInputStream(java.lang.String location,
                                               Http.Method method,
                                               java.util.Map<java.lang.String,java.lang.String> headers,
                                               javax.servlet.http.Cookie[] cookies,
                                               Http.Auth auth,
                                               Http.Body body,
                                               java.util.List<Http.FilePart> fileParts,
                                               java.util.Map<java.lang.String,java.lang.String> parts,
                                               Http.Response response,
                                               boolean followRedirects,
                                               int timeout)
                                        throws java.io.IOException

Throws:

java.io.IOException