HttpURL (Norconex Commons Lang 1.15.2 API)

java.lang.Object
- com.norconex.commons.lang.url.HttpURL

All Implemented Interfaces:

Serializable
```
public class HttpURL
extends Object
implements Serializable
```
This class act as a mutable URL, which could be a replacement or "wrapper" to the URL class. It can also be used as a safer way to build a URL or a URI instance as it will properly escape appropriate characters before creating those.

Author:

Pascal Essiembre

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_HTTP_PORT` Default URL HTTP Port.
`static int`	`DEFAULT_HTTPS_PORT` Default Secure URL HTTP Port.
`static String`	`PROTOCOL_HTTP` Constant for "http" protocol.
`static String`	`PROTOCOL_HTTPS` Constant for "https" protocol.

Constructor Summary

Constructors
Constructor and Description
`HttpURL()` Creates a blank HttpURL using UTF-8 for URL encoding.
`HttpURL(String url)` Creates a new HttpURL from the URL string using UTF-8 for URL encoding.
`HttpURL(String url, String encoding)` Creates a new HttpURL from the URL string using the provided encoding for URL encoding.
`HttpURL(URL url)` Creates a new HttpURL from the URL object using UTF-8 for URL encoding.
`HttpURL(URL url, String encoding)` Creates a new HttpURL from the URL object using the provided encoding for URL encoding.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`encodePath(String path)` URL-Encodes a URL path.
`static String`	`encodeQueryString(String queryString)` URL-Encodes the query string portion of a URL.
`boolean`	`equals(Object obj)`
`String`	`getEncoding()` Gets the character encoding.
`String`	`getFragment()` Gets the URL fragment.
`String`	`getHost()` Gets the host portion of the URL.
`String`	`getLastPathSegment()` Gets the last URL path segment without the query string.
`String`	`getPath()` Gets the URL path.
`int`	`getPort()` Gets the URL port.
`String`	`getProtocol()` Gets the protocol portion of the URL (e.g.
`QueryString`	`getQueryString()` Gets the URL query string.
`String`	`getRoot()` Gets the root of this HttpUrl.
`static String`	`getRoot(String url)` Gets the root of a URL.
`int`	`hashCode()`
`boolean`	`isPortDefault()` Whether this URL uses the default port for the protocol.
`boolean`	`isSecure()` Whether this URL is secure (e.g.
`void`	`setFragment(String fragment)` Sets the URL fragment.
`void`	`setHost(String host)` Sets the host portion of the URL.
`void`	`setPath(String path)` Sets the URL path.
`void`	`setPort(int port)` Sets the URL port.
`void`	`setProtocol(String protocol)` Sets the protocol portion of the URL.
`void`	`setQueryString(QueryString queryString)` Sets the URL query string.
`static String`	`toAbsolute(String baseURL, String relativeURL)` Converts a relative URL to an absolute one, based on the supplied base URL.
`String`	`toString()` Returns a string representation of this URL, properly encoded.
`URI`	`toURI()` Converts this HttpURL to a `URI`, making sure appropriate characters are escaped properly.
`static URI`	`toURI(String url)` Converts the supplied URL to a `URI`, making sure appropriate characters are encoded properly using UTF-8.
`URL`	`toURL()` Converts this HttpURL to a regular `URL`, making sure appropriate characters are escaped properly.
`static URL`	`toURL(String url)` Converts the supplied URL to a `URL`, making sure appropriate characters are encoded properly using UTF-8.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_HTTP_PORT
```
public static final int DEFAULT_HTTP_PORT
```
    Default URL HTTP Port.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HTTPS_PORT
```
public static final int DEFAULT_HTTPS_PORT
```
    Default Secure URL HTTP Port.
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTP
```
public static final String PROTOCOL_HTTP
```
    Constant for "http" protocol.
    
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTPS
```
public static final String PROTOCOL_HTTPS
```
    Constant for "https" protocol.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpURL
```
public HttpURL()
```
    Creates a blank HttpURL using UTF-8 for URL encoding.
  - HttpURL
```
public HttpURL(URL url)
```
    Creates a new HttpURL from the URL object using UTF-8 for URL encoding.
    
    Parameters:
    
    url - a URL
  - HttpURL
```
public HttpURL(String url)
```
    Creates a new HttpURL from the URL string using UTF-8 for URL encoding.
    
    Parameters:
    
    url - a URL
  - HttpURL
```
public HttpURL(URL url,
               String encoding)
```
    Creates a new HttpURL from the URL object using the provided encoding for URL encoding.
    
    Parameters:
    
    url - a URL
    
    encoding - character encoding
    
    Since:
    
    1.7.0
  - HttpURL
```
public HttpURL(String url,
               String encoding)
```
    Creates a new HttpURL from the URL string using the provided encoding for URL encoding.
    
    Parameters:
    
    url - a URL string
    
    encoding - character encoding
    
    Since:
    
    1.7.0
- Method Detail
  - getEncoding
```
public String getEncoding()
```
    Gets the character encoding. Default is UTF-8.
    
    Returns:
    
    character encoding
    
    Since:
    
    1.7.0
  - getPath
```
public String getPath()
```
    Gets the URL path.
    
    Returns:
    
    URL path
  - setPath
```
public void setPath(String path)
```
    Sets the URL path.
    
    Parameters:
    
    path - url path
  - getQueryString
```
public QueryString getQueryString()
```
    Gets the URL query string.
    
    Returns:
    
    URL query string, or null if none
  - setQueryString
```
public void setQueryString(QueryString queryString)
```
    Sets the URL query string.
    
    Parameters:
    
    queryString - the query string
  - getHost
```
public String getHost()
```
    Gets the host portion of the URL.
    
    Returns:
    
    the host portion of the URL
  - setHost
```
public void setHost(String host)
```
    Sets the host portion of the URL.
    
    Parameters:
    
    host - the host portion of the URL
  - getProtocol
```
public String getProtocol()
```
    Gets the protocol portion of the URL (e.g. http, https);
    
    Returns:
    
    the protocol portion of the URL
  - setProtocol
```
public void setProtocol(String protocol)
```
    Sets the protocol portion of the URL.
    
    Parameters:
    
    protocol - the protocol portion of the URL
  - isSecure
```
public boolean isSecure()
```
    Whether this URL is secure (e.g. https).
    
    Returns:
    
    true if protocol is secure
  - getPort
```
public int getPort()
```
    Gets the URL port. If the protocol is other than http or https, the port is -1 when not specified.
    
    Returns:
    
    the URL port
  - setPort
```
public void setPort(int port)
```
    Sets the URL port.
    
    Parameters:
    
    port - the URL port
  - getFragment
```
public String getFragment()
```
    Gets the URL fragment.
    
    Returns:
    
    the fragment
    
    Since:
    
    1.8.0
  - setFragment
```
public void setFragment(String fragment)
```
    Sets the URL fragment.
    
    Parameters:
    
    fragment - the fragment to set
    
    Since:
    
    1.8.0
  - getLastPathSegment
```
public String getLastPathSegment()
```
    Gets the last URL path segment without the query string. If there are segment to return, an empty string will be returned instead.
    
    Returns:
    
    the last URL path segment
  - toURL
```
public URL toURL()
```
    Converts this HttpURL to a regular URL, making sure appropriate characters are escaped properly.
    
    Returns:
    
    a URL
    
    Throws:
    
    URLException - when URL is malformed
  - getRoot
```
public String getRoot()
```
    Gets the root of this HttpUrl. That is the left part of a URL up to and including the host name. A null or empty string returns a null document root.
    
    Returns:
    
    left part of a URL up to (and including the host name
    
    Throws:
    
    URLException - when URL is malformed
    
    Since:
    
    1.8.0
  - toURI
```
public URI toURI()
```
    Converts this HttpURL to a URI, making sure appropriate characters are escaped properly.
    
    Returns:
    
    a URI
    
    Throws:
    
    URLException - when URL is malformed
    
    Since:
    
    1.7.0
  - toURL
```
public static URL toURL(String url)
```
    Converts the supplied URL to a URL, making sure appropriate characters are encoded properly using UTF-8. This method is a short form of:
    new HttpURL("http://example.com").toURL();
    
    Parameters:
    
    url - a URL string
    
    Returns:
    
    a URL object
    
    Throws:
    
    URLException - when URL is malformed
    
    Since:
    
    1.7.0
  - toURI
```
public static URI toURI(String url)
```
    Converts the supplied URL to a URI, making sure appropriate characters are encoded properly using UTF-8. This method is a short form of:
    new HttpURL("http://example.com").toURI();
    
    Parameters:
    
    url - a URL string
    
    Returns:
    
    a URI object
    
    Throws:
    
    URLException - when URL is malformed
    
    Since:
    
    1.7.0
  - getRoot
```
public static String getRoot(String url)
```
    Gets the root of a URL. That is the left part of a URL up to and including the host name. A null or empty string returns a null document root. This method is a short form of:
    new HttpURL("http://example.com/path").getRoot();
    
    Parameters:
    
    url - a URL string
    
    Returns:
    
    left part of a URL up to (and including the host name
    
    Since:
    
    1.8.0
  - toString
```
public String toString()
```
    Returns a string representation of this URL, properly encoded.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    URL as a string
  - isPortDefault
```
public boolean isPortDefault()
```
    Whether this URL uses the default port for the protocol. The default port is 80 for "http" protocol, and 443 for "https". Other protocols are not supported and this method will always return false for them.
    
    Returns:
    
    true if the URL is using the default port.
    
    Since:
    
    1.8.0
  - encodeQueryString
```
public static String encodeQueryString(String queryString)
```
    URL-Encodes the query string portion of a URL. The entire string supplied is assumed to be a query string.
    
    Parameters:
    
    queryString - URL query string
    
    Returns:
    
    encoded path
    
    Since:
    
    1.8.0
  - encodePath
```
public static String encodePath(String path)
```
    URL-Encodes a URL path. The entire string supplied is assumed to be a URL path. Unsafe characters are percent-encoded using UTF-8 (as specified by W3C standard).
    
    Parameters:
    
    path - path portion of a URL
    
    Returns:
    
    encoded path
    
    Since:
    
    1.7.0
  - toAbsolute
```
public static String toAbsolute(String baseURL,
                                String relativeURL)
```
    Converts a relative URL to an absolute one, based on the supplied base URL. The base URL is assumed to be a valid URL. Behavior is unexpected when base URL is invalid.
    
    Parameters:
    
    baseURL - URL to the reference is relative to
    
    relativeURL - the relative URL portion to transform to absolute
    
    Returns:
    
    absolute URL
    
    Since:
    
    1.8.0
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class HttpURL

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HTTP_PORT

DEFAULT_HTTPS_PORT

PROTOCOL_HTTP

PROTOCOL_HTTPS

Constructor Detail

HttpURL

HttpURL

HttpURL

HttpURL

HttpURL

Method Detail

getEncoding

getPath

setPath

getQueryString

setQueryString

getHost

setHost

getProtocol

setProtocol

isSecure

getPort

setPort

getFragment

setFragment

getLastPathSegment

toURL

getRoot

toURI

toURL

toURI

getRoot

toString

isPortDefault

encodeQueryString

encodePath

toAbsolute

hashCode

equals