UniformResourceLocator (PF-All 7.4.0 API)

java.lang.Object
- org.pfsw.net.UniformResourceLocator

All Implemented Interfaces:

java.io.Serializable
```
public class UniformResourceLocator
extends java.lang.Object
implements java.io.Serializable
```
Helper class to parse and manipulate URLs in a convenient way.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected static CollectionUtil`	`CU`
`protected static int`	`DEFAULT_PORT`
`protected static java.lang.String`	`DEFAULT_SCHEME`
`static int`	`HTTP_DEFAULT_PORT`
`static java.lang.String`	`HTTP_SCHEME_PREFIX` "http://"
`static int`	`HTTPS_DEFAULT_PORT`
`static java.lang.String`	`HTTPS_SCHEME_PREFIX` "https://"
`protected static NetUtil`	`NU`
`static java.lang.String`	`SCHEME_HOST_SEPARATOR` "://"
`static java.lang.String`	`SCHEME_HTTP`
`static java.lang.String`	`SCHEME_HTTPS`
`static java.lang.String`	`SLASH` The character '/' that is used to separate naming elements of the URL
`protected static StringUtil`	`SU`
`static java.lang.String`	`URL_PARAM_ASSIGN` The character '=' that is used to separate name and value of query parameters
`static java.lang.String`	`URL_PARAM_SEPARATOR` The character '&' that is used to separate consecutive query parameters from each other
`static java.lang.String`	`URL_PORT_SEPARATOR` The character ':' that is used to separate hostname from the port
`static java.lang.String`	`URL_QUERY_SEPARATOR` The character '?' that is used to separate the query parameters from the URL

Constructor Summary

Constructors
Constructor and Description
`UniformResourceLocator()` Initialize the new instance with default values.
`UniformResourceLocator(java.lang.String url)` Initialize the new instance with the given URL
`UniformResourceLocator(java.lang.String scheme, java.lang.String serverName, int port, java.lang.String requestURI, java.lang.String... queryParams)` Initialize the new instance with the various parts of a URL.
`UniformResourceLocator(java.lang.String scheme, java.lang.String serverName, java.lang.String requestURI, java.lang.String... queryParams)` Initialize the new instance with the various parts of a URL.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAllQueryParameterDefinitions(java.lang.String[] queryParams)`
`UniformResourceLocator`	`addToParameter(IStringRepresentation name, IStringRepresentation... values)` Adds the given value to the parameter with the specified name.
`UniformResourceLocator`	`addToParameter(IStringRepresentation name, java.lang.String... values)` Adds the given value to the parameter with the specified name.
`UniformResourceLocator`	`addToParameter(java.lang.String name, java.lang.String... values)` Adds the given value to the parameter with the specified name.
`protected void`	`addValuesToParameter(NamedValue<java.util.List<java.lang.String>> param, java.lang.String... values)`
`UniformResourceLocator`	`appendPath(java.lang.String path)` Appends the given path to the end of the current requestURI.
`protected void`	`appendServerNameAndPort(java.lang.StringBuffer buffer)`
`java.lang.String`	`asString()` Returns the full URL including parameters as string representation.
`protected void`	`checkIfValidURL(java.lang.String urlStr)`
`UniformResourceLocator`	`clearParameters()` Remove all query parameters from this URL.
`UniformResourceLocator`	`copy()` Creates a copy of this object.
`protected NamedValue<java.util.List<java.lang.String>>[]`	`copyParameters()`
`static UniformResourceLocator`	`create()` Creates a new instance.
`static UniformResourceLocator`	`create(java.lang.String url)` Creates a new instance on the given URL string.
`static UniformResourceLocator`	`create(java.net.URI uri)` Creates a new instance on the given URI.
`static UniformResourceLocator`	`create(java.net.URL url)` Creates a new instance on the given URL.
`protected NamedValue<java.util.List<java.lang.String>>`	`createParameter(java.lang.String name)`
`protected NamedValue<java.util.List<java.lang.String>>`	`createParameterObject(java.lang.String name)`
`static int`	`getDefaultPortForScheme(java.lang.String scheme)` Returns the default port for scheme HTTP (80) or HTTPS (443).
`int`	`getNumberOfParameters()` Returns the number of query parameters
`protected NamedValue<java.util.List<java.lang.String>>`	`getOrCreateParameter(java.lang.String name)`
`java.lang.String`	`getParameter(IStringRepresentation name)` Returns the (first) value of the parameter with the given name or null.
`java.lang.String`	`getParameter(java.lang.String name)` Returns the (first) value of the parameter with the given name or null.
`java.util.Enumeration<java.lang.String>`	`getParameterNames()` Returns the names of all query parameters as Enumeration.
`protected NamedValueList<java.util.List<java.lang.String>>`	`getParameters()`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getParametersMap()` Returns all query parameters or this URL in a map.
`java.util.List<java.lang.String>`	`getParameterValues(IStringRepresentation name)` Returns the values of the parameter with the given name or null if the parameter is not present.
`java.util.List<java.lang.String>`	`getParameterValues(java.lang.String name)` Returns the values of the parameter with the given name or null if the parameter is not present.
`int`	`getPort()` Return the defined port.
`java.util.List<java.lang.String>`	`getQueryParameterNames()` Returns the names of all query parameters as List.
`java.lang.String`	`getQueryString()` Returns the query string, that is everything following the '?'.
`java.lang.String`	`getRequestURI()` Returns the request URI
`java.lang.String`	`getScheme()`
`java.lang.String`	`getServerName()` Return the server name
`java.lang.String`	`getServerNameAndPort()` Returns a string containing the server name and optionally the port number, separated by a colon (':').
`protected void`	`handleException(java.lang.Exception ex)`
`boolean`	`hasQueryParameter()` Returns true if this URL contains at least one query parameter
`boolean`	`hasQueryParameter(IStringRepresentation name)` Returns true if this URL contains the query parameter with the given name.
`boolean`	`hasQueryParameter(java.lang.String name)` Returns true if this URL contains the query parameter with the given name.
`boolean`	`isAbsolute()` Returns true if this is an absolute URL
`boolean`	`isDefaultPort()` Returns true, if the port is not explicitly set which means the default port has to be used.
`boolean`	`isRelative()` Returns true if this is a relative URL
`protected boolean`	`isRelativeToHost(java.lang.String urlStr)`
`protected UniformResourceLocator`	`newInstance()`
`protected void`	`parseQueryString(java.lang.String queryString)`
`protected void`	`parseURL(java.lang.String urlStr)`
`protected int`	`port()`
`protected void`	`port(int newValue)`
`UniformResourceLocator`	`removeParameter(IStringRepresentation name)` Remove the parameter with the given named from the list of query parameters.
`UniformResourceLocator`	`removeParameter(java.lang.String name)` Remove the parameter with the given named from the list of query parameters.
`protected java.lang.String`	`requestURI()`
`protected void`	`requestURI(java.lang.String newValue)`
`protected java.lang.String`	`scheme()`
`protected void`	`scheme(java.lang.String newValue)`
`protected java.lang.String`	`serverName()`
`protected void`	`serverName(java.lang.String newValue)`
`UniformResourceLocator`	`setFilename(java.lang.String filename)` Sets the given filename to the end of the requestURI.
`UniformResourceLocator`	`setParameter(IStringRepresentation name, IStringRepresentation... values)` Sets the parameter with the given name to the specified value.
`UniformResourceLocator`	`setParameter(IStringRepresentation name, java.lang.String... values)` Sets the parameter with the given name to the specified value.
`UniformResourceLocator`	`setParameter(java.lang.String name, java.lang.String... values)` Sets the parameter with the given name to the specified value.
`UniformResourceLocator`	`setPathRelative(java.lang.String path)` Sets the given path relative to the current requestURI.
`UniformResourceLocator`	`setPort(int newValue)` Set the port of the URL
`UniformResourceLocator`	`setQueryString(java.lang.String query)`
`UniformResourceLocator`	`setRequestURI(java.lang.String uri)`
`UniformResourceLocator`	`setScheme(java.lang.String scheme)`
`UniformResourceLocator`	`setServerName(java.lang.String name)`
`java.lang.String`	`toString()` Returns the full URL including parameters as string representation
`java.net.URI`	`toURI()`
`java.net.URL`	`toURL()`

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

- Field Detail
  - SU
```
protected static final StringUtil SU
```
  - CU
```
protected static final CollectionUtil CU
```
  - NU
```
protected static final NetUtil NU
```
  - SCHEME_HTTP
```
public static final java.lang.String SCHEME_HTTP
```
    See Also:
    
    Constant Field Values
  - SCHEME_HTTPS
```
public static final java.lang.String SCHEME_HTTPS
```
    See Also:
    
    Constant Field Values
  - HTTP_DEFAULT_PORT
```
public static final int HTTP_DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - HTTPS_DEFAULT_PORT
```
public static final int HTTPS_DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
protected static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCHEME
```
protected static final java.lang.String DEFAULT_SCHEME
```
    See Also:
    
    Constant Field Values
  - SCHEME_HOST_SEPARATOR
```
public static final java.lang.String SCHEME_HOST_SEPARATOR
```
    "://"
    
    See Also:
    
    Constant Field Values
  - HTTP_SCHEME_PREFIX
```
public static final java.lang.String HTTP_SCHEME_PREFIX
```
    "http://"
    
    See Also:
    
    Constant Field Values
  - HTTPS_SCHEME_PREFIX
```
public static final java.lang.String HTTPS_SCHEME_PREFIX
```
    "https://"
    
    See Also:
    
    Constant Field Values
  - URL_QUERY_SEPARATOR
```
public static final java.lang.String URL_QUERY_SEPARATOR
```
    The character '?' that is used to separate the query parameters from the URL
    
    See Also:
    
    Constant Field Values
  - URL_PARAM_SEPARATOR
```
public static final java.lang.String URL_PARAM_SEPARATOR
```
    The character '&' that is used to separate consecutive query parameters from each other
    
    See Also:
    
    Constant Field Values
  - URL_PARAM_ASSIGN
```
public static final java.lang.String URL_PARAM_ASSIGN
```
    The character '=' that is used to separate name and value of query parameters
    
    See Also:
    
    Constant Field Values
  - URL_PORT_SEPARATOR
```
public static final java.lang.String URL_PORT_SEPARATOR
```
    The character ':' that is used to separate hostname from the port
    
    See Also:
    
    Constant Field Values
  - SLASH
```
public static final java.lang.String SLASH
```
    The character '/' that is used to separate naming elements of the URL
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UniformResourceLocator
```
public UniformResourceLocator(java.lang.String url)
                       throws java.net.MalformedURLException
```
    Initialize the new instance with the given URL
    
    Throws:
    
    java.net.MalformedURLException
  - UniformResourceLocator
```
public UniformResourceLocator()
```
    Initialize the new instance with default values.
  - UniformResourceLocator
```
public UniformResourceLocator(java.lang.String scheme,
                              java.lang.String serverName,
                              int port,
                              java.lang.String requestURI,
                              java.lang.String... queryParams)
```
    Initialize the new instance with the various parts of a URL.
  - UniformResourceLocator
```
public UniformResourceLocator(java.lang.String scheme,
                              java.lang.String serverName,
                              java.lang.String requestURI,
                              java.lang.String... queryParams)
```
    Initialize the new instance with the various parts of a URL.
- Method Detail
  - getDefaultPortForScheme
```
public static int getDefaultPortForScheme(java.lang.String scheme)
```
    Returns the default port for scheme HTTP (80) or HTTPS (443). For any other, unknown scheme it returns -1.
    
    Parameters:
    
    scheme - The case-insensitive scheme name (must not be null).
  - create
```
public static UniformResourceLocator create()
```
    Creates a new instance.
  - create
```
public static UniformResourceLocator create(java.lang.String url)
```
    Creates a new instance on the given URL string.
    
    Parameters:
    
    url - The URL string (must not be null).
    
    Returns:
    
    A new UniformResourceLocator based on the given URL string.
    
    Throws:
    
    InvalidUrlException - if the given string is not a valid URL.
  - create
```
public static UniformResourceLocator create(java.net.URL url)
```
    Creates a new instance on the given URL.
    
    Parameters:
    
    url - The URL (must not be null).
    
    Returns:
    
    A new UniformResourceLocator based on the given URL.
  - create
```
public static UniformResourceLocator create(java.net.URI uri)
```
    Creates a new instance on the given URI.
    
    Parameters:
    
    uri - The URI (must not be null).
    
    Returns:
    
    A new UniformResourceLocator based on the given URI.
  - hasQueryParameter
```
public boolean hasQueryParameter()
```
    Returns true if this URL contains at least one query parameter
  - hasQueryParameter
```
public boolean hasQueryParameter(java.lang.String name)
```
    Returns true if this URL contains the query parameter with the given name.
  - hasQueryParameter
```
public boolean hasQueryParameter(IStringRepresentation name)
```
    Returns true if this URL contains the query parameter with the given name.
  - getQueryString
```
public java.lang.String getQueryString()
```
    Returns the query string, that is everything following the '?'.
  - setQueryString
```
public UniformResourceLocator setQueryString(java.lang.String query)
```
  - getServerName
```
public java.lang.String getServerName()
```
    Return the server name
  - setServerName
```
public UniformResourceLocator setServerName(java.lang.String name)
```
  - getPort
```
public int getPort()
```
    Return the defined port. If the port is not defined (i.e zero (0)) it returns the default port for the current scheme.
  - setPort
```
public UniformResourceLocator setPort(int newValue)
```
    Set the port of the URL
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Returns the request URI
  - setRequestURI
```
public UniformResourceLocator setRequestURI(java.lang.String uri)
```
  - setFilename
```
public UniformResourceLocator setFilename(java.lang.String filename)
```
    Sets the given filename to the end of the requestURI. If there is already a filename it will be replaced.
  - setPathRelative
```
public UniformResourceLocator setPathRelative(java.lang.String path)
```
    Sets the given path relative to the current requestURI. Any name after the last slash in the current requestURI will be replaced. Separating slashes will be handled automatically. If the given path is null or blank it will be ignored.
    
    Parameters:
    
    path - The path to be set relative to the current path (may be null).
  - appendPath
```
public UniformResourceLocator appendPath(java.lang.String path)
```
    Appends the given path to the end of the current requestURI. Nothing will be replaced, just appended. The separating slash will be added or removed automatically as needed. If the given path is null or blank it will be ignored (nothing appended). Any leading or trailing whitespace characters will be removed from the path.
    
    Parameters:
    
    path - The path to be appended (may be null).
  - getScheme
```
public java.lang.String getScheme()
```
  - setScheme
```
public UniformResourceLocator setScheme(java.lang.String scheme)
```
  - getParameterNames
```
public java.util.Enumeration<java.lang.String> getParameterNames()
```
    Returns the names of all query parameters as Enumeration.
  - getQueryParameterNames
```
public java.util.List<java.lang.String> getQueryParameterNames()
```
    Returns the names of all query parameters as List.
  - getNumberOfParameters
```
public int getNumberOfParameters()
```
    Returns the number of query parameters
  - getParameter
```
public java.lang.String getParameter(IStringRepresentation name)
```
    Returns the (first) value of the parameter with the given name or null.
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Returns the (first) value of the parameter with the given name or null.
  - getParameterValues
```
public java.util.List<java.lang.String> getParameterValues(IStringRepresentation name)
```
    Returns the values of the parameter with the given name or null if the parameter is not present.
  - getParameterValues
```
public java.util.List<java.lang.String> getParameterValues(java.lang.String name)
```
    Returns the values of the parameter with the given name or null if the parameter is not present.
  - getParametersMap
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParametersMap()
```
    Returns all query parameters or this URL in a map. The returned map is a copy and therefore changes to it will have no impact on the parameters of this object.
    
    Returns:
    
    An (perhaps empty) map of all query parameters.
  - setParameter
```
public UniformResourceLocator setParameter(IStringRepresentation name,
                                           java.lang.String... values)
```
    Sets the parameter with the given name to the specified value. If the parameter already existed it will be replaced.
  - setParameter
```
public UniformResourceLocator setParameter(IStringRepresentation name,
                                           IStringRepresentation... values)
```
    Sets the parameter with the given name to the specified value. If the parameter already existed it will be replaced.
  - setParameter
```
public UniformResourceLocator setParameter(java.lang.String name,
                                           java.lang.String... values)
```
    Sets the parameter with the given name to the specified value. If the parameter already existed it will be replaced.
  - addToParameter
```
public UniformResourceLocator addToParameter(IStringRepresentation name,
                                             java.lang.String... values)
```
    Adds the given value to the parameter with the specified name. If the parameter did not yet exist, it will be created. Null values will be skipped.
  - addToParameter
```
public UniformResourceLocator addToParameter(IStringRepresentation name,
                                             IStringRepresentation... values)
```
    Adds the given value to the parameter with the specified name. If the parameter did not yet exist, it will be created. Null values will be skipped.
  - addToParameter
```
public UniformResourceLocator addToParameter(java.lang.String name,
                                             java.lang.String... values)
```
    Adds the given value to the parameter with the specified name. If the parameter did not yet exist, it will be created. Null values will be skipped.
  - removeParameter
```
public UniformResourceLocator removeParameter(IStringRepresentation name)
```
    Remove the parameter with the given named from the list of query parameters.
  - removeParameter
```
public UniformResourceLocator removeParameter(java.lang.String name)
```
    Remove the parameter with the given named from the list of query parameters.
  - clearParameters
```
public UniformResourceLocator clearParameters()
```
    Remove all query parameters from this URL.
  - isDefaultPort
```
public boolean isDefaultPort()
```
    Returns true, if the port is not explicitly set which means the default port has to be used.
  - getServerNameAndPort
```
public java.lang.String getServerNameAndPort()
```
    Returns a string containing the server name and optionally the port number, separated by a colon (':'). The port will NOT be appended to the server name if
    - the port is 0
    - the scheme is http and the port is 80
    - the scheme is https and the port is 443
    In all other cases the port will be appended to the server name.
  - copy
```
public UniformResourceLocator copy()
```
    Creates a copy of this object. Changing the copy has no impact on the original object.
  - isRelative
```
public boolean isRelative()
```
    Returns true if this is a relative URL
  - isAbsolute
```
public boolean isAbsolute()
```
    Returns true if this is an absolute URL
  - toString
```
public java.lang.String toString()
```
    Returns the full URL including parameters as string representation
    
    Overrides:
    
    toString in class java.lang.Object
  - asString
```
public java.lang.String asString()
```
    Returns the full URL including parameters as string representation.
  - toURL
```
public java.net.URL toURL()
```
  - toURI
```
public java.net.URI toURI()
```
  - parseURL
```
protected void parseURL(java.lang.String urlStr)
                 throws java.net.MalformedURLException
```
    Throws:
    
    java.net.MalformedURLException
  - addValuesToParameter
```
protected void addValuesToParameter(NamedValue<java.util.List<java.lang.String>> param,
                                    java.lang.String... values)
```
  - parseQueryString
```
protected void parseQueryString(java.lang.String queryString)
```
  - appendServerNameAndPort
```
protected void appendServerNameAndPort(java.lang.StringBuffer buffer)
```
  - copyParameters
```
protected NamedValue<java.util.List<java.lang.String>>[] copyParameters()
```
  - isRelativeToHost
```
protected boolean isRelativeToHost(java.lang.String urlStr)
```
  - checkIfValidURL
```
protected void checkIfValidURL(java.lang.String urlStr)
                        throws java.net.MalformedURLException
```
    Throws:
    
    java.net.MalformedURLException
  - addAllQueryParameterDefinitions
```
protected void addAllQueryParameterDefinitions(java.lang.String[] queryParams)
```
  - getOrCreateParameter
```
protected NamedValue<java.util.List<java.lang.String>> getOrCreateParameter(java.lang.String name)
```
  - createParameter
```
protected NamedValue<java.util.List<java.lang.String>> createParameter(java.lang.String name)
```
  - createParameterObject
```
protected NamedValue<java.util.List<java.lang.String>> createParameterObject(java.lang.String name)
```
  - newInstance
```
protected UniformResourceLocator newInstance()
```
  - handleException
```
protected void handleException(java.lang.Exception ex)
```
  - getParameters
```
protected NamedValueList<java.util.List<java.lang.String>> getParameters()
```
  - serverName
```
protected java.lang.String serverName()
```
  - serverName
```
protected void serverName(java.lang.String newValue)
```
  - requestURI
```
protected java.lang.String requestURI()
```
  - requestURI
```
protected void requestURI(java.lang.String newValue)
```
  - scheme
```
protected java.lang.String scheme()
```
  - scheme
```
protected void scheme(java.lang.String newValue)
```
  - port
```
protected int port()
```
  - port
```
protected void port(int newValue)
```

Class UniformResourceLocator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SU

CU

NU

SCHEME_HTTP

SCHEME_HTTPS

HTTP_DEFAULT_PORT

HTTPS_DEFAULT_PORT

DEFAULT_PORT

DEFAULT_SCHEME

SCHEME_HOST_SEPARATOR

HTTP_SCHEME_PREFIX

HTTPS_SCHEME_PREFIX

URL_QUERY_SEPARATOR

URL_PARAM_SEPARATOR

URL_PARAM_ASSIGN

URL_PORT_SEPARATOR

SLASH

Constructor Detail

UniformResourceLocator

UniformResourceLocator

UniformResourceLocator

UniformResourceLocator

Method Detail

getDefaultPortForScheme

create

create

create

create

hasQueryParameter

hasQueryParameter

hasQueryParameter

getQueryString

setQueryString

getServerName

setServerName

getPort

setPort

getRequestURI

setRequestURI

setFilename

setPathRelative

appendPath

getScheme

setScheme

getParameterNames

getQueryParameterNames

getNumberOfParameters

getParameter

getParameter

getParameterValues

getParameterValues

getParametersMap

setParameter

setParameter

setParameter

addToParameter

addToParameter

addToParameter

removeParameter

removeParameter

clearParameters

isDefaultPort

getServerNameAndPort

copy

isRelative

isAbsolute

toString

asString

toURL

toURI

parseURL

addValuesToParameter

parseQueryString

appendServerNameAndPort