Liferay 6.2.0

com.liferay.portal.kernel.util
Interface Http

All Known Implementing Classes:
HttpImpl

public interface Http


Nested Class Summary
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
static String HTTP
           
static int HTTP_PORT
           
static String HTTP_WITH_SLASH
           
static String HTTPS
           
static int HTTPS_PORT
           
static String HTTPS_WITH_SLASH
           
static String PROTOCOL_DELIMITER
           
static int URL_MAXIMUM_LENGTH
           
 
Method Summary
abstract  String addParameter(String url, String name, boolean value)
           
abstract  String addParameter(String url, String name, double value)
           
abstract  String addParameter(String url, String name, int value)
           
abstract  String addParameter(String url, String name, long value)
           
abstract  String addParameter(String url, String name, short value)
           
abstract  String addParameter(String url, String name, String value)
           
abstract  String decodePath(String path)
           
abstract  String decodeURL(String url)
           
abstract  String decodeURL(String url, boolean unescapeSpaces)
           
abstract  String encodeParameters(String url)
           
abstract  String encodePath(String path)
           
abstract  String encodeURL(String url)
           
abstract  String encodeURL(String url, boolean escapeSpaces)
           
abstract  String fixPath(String path)
           
abstract  String fixPath(String path, boolean leading, boolean trailing)
           
abstract  String getCompleteURL(javax.servlet.http.HttpServletRequest request)
           
abstract  javax.servlet.http.Cookie[] getCookies()
           
abstract  String getDomain(String url)
           
abstract  String getIpAddress(String url)
           
abstract  String getParameter(String url, String name)
           
abstract  String getParameter(String url, String name, boolean escaped)
           
abstract  Map<String,String[]> getParameterMap(String queryString)
           
abstract  String getPath(String url)
           
abstract  String getProtocol(ActionRequest actionRequest)
           
abstract  String getProtocol(boolean secure)
           
abstract  String getProtocol(javax.servlet.http.HttpServletRequest request)
           
abstract  String getProtocol(RenderRequest renderRequest)
           
abstract  String getProtocol(String url)
           
abstract  String getQueryString(String url)
           
abstract  String getRequestURL(javax.servlet.http.HttpServletRequest request)
           
abstract  boolean hasDomain(String url)
           
abstract  boolean hasProtocol(String url)
           
abstract  boolean hasProxyConfig()
           
abstract  boolean isNonProxyHost(String host)
           
abstract  boolean isProxyHost(String host)
           
abstract  boolean isSecure(String url)
           
abstract  Map<String,String[]> parameterMapFromString(String queryString)
           
abstract  String parameterMapToString(Map<String,String[]> parameterMap)
           
abstract  String parameterMapToString(Map<String,String[]> parameterMap, boolean addQuestion)
           
abstract  String protocolize(String url, ActionRequest actionRequest)
           
abstract  String protocolize(String url, boolean secure)
           
abstract  String protocolize(String url, javax.servlet.http.HttpServletRequest request)
           
abstract  String protocolize(String url, int port, boolean secure)
           
abstract  String protocolize(String url, RenderRequest renderRequest)
           
abstract  String removeDomain(String url)
           
abstract  String removeParameter(String url, String name)
           
abstract  String removeProtocol(String url)
           
abstract  String sanitizeHeader(String header)
           
abstract  String setParameter(String url, String name, boolean value)
           
abstract  String setParameter(String url, String name, double value)
           
abstract  String setParameter(String url, String name, int value)
           
abstract  String setParameter(String url, String name, long value)
           
abstract  String setParameter(String url, String name, short value)
           
abstract  String setParameter(String url, String name, String value)
           
abstract  String shortenURL(String url, int count)
           
abstract  byte[] URLtoByteArray(Http.Options options)
           
abstract  byte[] URLtoByteArray(String location)
           
abstract  byte[] URLtoByteArray(String location, boolean post)
           
abstract  String URLtoString(Http.Options options)
           
abstract  String URLtoString(String location)
           
abstract  String URLtoString(String location, boolean post)
           
abstract  String URLtoString(URL url)
          This method only uses the default Commons HttpClient implementation when the URL object represents a HTTP resource.
 

Field Detail

HTTP

static final String HTTP
See Also:
Constant Field Values

HTTP_PORT

static final int HTTP_PORT
See Also:
Constant Field Values

HTTP_WITH_SLASH

static final String HTTP_WITH_SLASH
See Also:
Constant Field Values

HTTPS

static final String HTTPS
See Also:
Constant Field Values

HTTPS_PORT

static final int HTTPS_PORT
See Also:
Constant Field Values

HTTPS_WITH_SLASH

static final String HTTPS_WITH_SLASH
See Also:
Constant Field Values

PROTOCOL_DELIMITER

static final 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

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

addParameter

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

addParameter

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

addParameter

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

addParameter

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

addParameter

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

decodePath

String decodePath(String path)

decodeURL

String decodeURL(String url)

decodeURL

String decodeURL(String url,
                 boolean unescapeSpaces)

encodeParameters

String encodeParameters(String url)

encodePath

String encodePath(String path)

encodeURL

String encodeURL(String url)

encodeURL

String encodeURL(String url,
                 boolean escapeSpaces)

fixPath

String fixPath(String path)

fixPath

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

getCompleteURL

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

getCookies

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

getDomain

String getDomain(String url)

getIpAddress

String getIpAddress(String url)

getParameter

String getParameter(String url,
                    String name)

getParameter

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

getParameterMap

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

getPath

String getPath(String url)

getProtocol

String getProtocol(ActionRequest actionRequest)

getProtocol

String getProtocol(boolean secure)

getProtocol

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

getProtocol

String getProtocol(RenderRequest renderRequest)

getProtocol

String getProtocol(String url)

getQueryString

String getQueryString(String url)

getRequestURL

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

hasDomain

boolean hasDomain(String url)

hasProtocol

boolean hasProtocol(String url)

hasProxyConfig

boolean hasProxyConfig()

isNonProxyHost

boolean isNonProxyHost(String host)

isProxyHost

boolean isProxyHost(String host)

isSecure

boolean isSecure(String url)

parameterMapFromString

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

parameterMapToString

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

parameterMapToString

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

protocolize

String protocolize(String url,
                   ActionRequest actionRequest)

protocolize

String protocolize(String url,
                   boolean secure)

protocolize

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

protocolize

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

protocolize

String protocolize(String url,
                   RenderRequest renderRequest)

removeDomain

String removeDomain(String url)

removeParameter

String removeParameter(String url,
                       String name)

removeProtocol

String removeProtocol(String url)

sanitizeHeader

String sanitizeHeader(String header)

setParameter

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

setParameter

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

setParameter

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

setParameter

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

setParameter

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

setParameter

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

shortenURL

String shortenURL(String url,
                  int count)

URLtoByteArray

byte[] URLtoByteArray(Http.Options options)
                      throws IOException
Throws:
IOException

URLtoByteArray

byte[] URLtoByteArray(String location)
                      throws IOException
Throws:
IOException

URLtoByteArray

byte[] URLtoByteArray(String location,
                      boolean post)
                      throws IOException
Throws:
IOException

URLtoString

String URLtoString(Http.Options options)
                   throws IOException
Throws:
IOException

URLtoString

String URLtoString(String location)
                   throws IOException
Throws:
IOException

URLtoString

String URLtoString(String location,
                   boolean post)
                   throws IOException
Throws:
IOException

URLtoString

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

Liferay 6.2.0