net.shibboleth.utilities.java.support.net

Class URLBuilder

java.lang.Object

net.shibboleth.utilities.java.support.net.URLBuilder

public class URLBuilder
extends java.lang.Object

Utility class for building URLs. May also be used to parse a URL into its individual components. All components will be converted UTF-8 encoding and then application/x-www-form-urlencoded when built. This class is not thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	fragement URL fragment.
private java.lang.String	host Host for the URL.
private java.lang.String	password Password in the URL.
private java.lang.String	path URL path.
private java.lang.Integer	port URL port number.
private java.util.List<Pair<java.lang.String,java.lang.String>>	queryParams Parameters in the query string.
private java.lang.String	scheme URL schema (http, https, etc).
private java.lang.String	username User name in the URL.

Constructor Summary

Constructors

Constructor and Description
URLBuilder() Constructor.
URLBuilder(java.lang.String baseURL) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildQueryString() Builds the query string for the URL.
java.lang.String	buildURL() Builds a URL from the given data.
java.lang.String	getFragment() Gets the URL fragment in its decoded form.
java.lang.String	getHost() Gets the host component of the URL.
java.lang.String	getPassword() Gets the user's password in the URL.
java.lang.String	getPath() Gets the path component of the URL.
java.lang.Integer	getPort() Gets the port component of the URL.
java.util.List<Pair<java.lang.String,java.lang.String>>	getQueryParams() Gets the query string parameters for the URL.
java.lang.String	getScheme() Gets the URL scheme (http, https, etc).
java.lang.String	getUsername() Gets the user name component of the URL.
void	setFragment(java.lang.String newFragment) Sets the URL fragment in its decoded form.
void	setHost(java.lang.String newHost) Sets the host component of the URL.
void	setPassword(java.lang.String newPassword) Sets the user's password in the URL.
void	setPath(java.lang.String newPath) Sets the path component of the URL.
void	setPort(java.lang.Integer newPort) Sets the port component of the URL.
void	setScheme(java.lang.String newScheme) Sets the URL scheme (http, https, etc).
void	setUsername(java.lang.String newUsername) Sets the user name component of the URL.

Methods inherited from class java.lang.Object

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

Field Detail

scheme

@Nullable
private java.lang.String scheme

URL schema (http, https, etc).

username

@Nullable
private java.lang.String username

User name in the URL.

password

@Nullable
private java.lang.String password

Password in the URL.

host

@Nullable
private java.lang.String host

Host for the URL.

port

@Nullable
private java.lang.Integer port

URL port number.

path

@Nullable
private java.lang.String path

URL path.

queryParams

@Nonnull
private java.util.List<Pair<java.lang.String,java.lang.String>> queryParams

Parameters in the query string.

fragement

private java.lang.String fragement

URL fragment.

Constructor Detail

URLBuilder

public URLBuilder()

Constructor.

URLBuilder

public URLBuilder(@Nonnull @NotEmpty
                  java.lang.String baseURL)
           throws java.net.MalformedURLException

Constructor.

Parameters:

baseURL - URL to parse and use as basis for creating other URLs

Throws:

java.net.MalformedURLException - thrown if the given base URL is not well formed

Method Detail

getFragment

@Nullable
public java.lang.String getFragment()

Gets the URL fragment in its decoded form.

Returns:

URL fragment in its decoded form

setFragment

public void setFragment(@Nullable
                        java.lang.String newFragment)

Sets the URL fragment in its decoded form.

Parameters:

newFragment - URL fragment in its decoded form

getHost

@Nullable
public java.lang.String getHost()

Gets the host component of the URL.

Returns:

host component of the URL

setHost

public void setHost(@Nullable
                    java.lang.String newHost)

Sets the host component of the URL.

Parameters:

newHost - host component of the URL

getPassword

@Nullable
public java.lang.String getPassword()

Gets the user's password in the URL.

Returns:

user's password in the URL

setPassword

public void setPassword(@Nullable
                        java.lang.String newPassword)

Sets the user's password in the URL.

Parameters:

newPassword - user's password in the URL

getPath

@Nullable
public java.lang.String getPath()

Gets the path component of the URL.

Returns:

path component of the URL

setPath

public void setPath(@Nullable
                    java.lang.String newPath)

Sets the path component of the URL.

Parameters:

newPath - path component of the URL

getPort

@Nullable
public java.lang.Integer getPort()

Gets the port component of the URL.

Returns:

port component of the URL

setPort

public void setPort(@Nullable
                    java.lang.Integer newPort)

Sets the port component of the URL.

Parameters:

newPort - port component of the URL

getQueryParams

@Nonnull
public java.util.List<Pair<java.lang.String,java.lang.String>> getQueryParams()

Gets the query string parameters for the URL. Params may be added and removed through the map interface.

Returns:

query string parameters for the URL

getScheme

@Nullable
public java.lang.String getScheme()

Gets the URL scheme (http, https, etc).

Returns:

URL scheme (http, https, etc)

setScheme

public void setScheme(@Nullable
                      java.lang.String newScheme)

Sets the URL scheme (http, https, etc).

Parameters:

newScheme - URL scheme (http, https, etc)

getUsername

@Nullable
public java.lang.String getUsername()

Gets the user name component of the URL.

Returns:

user name component of the URL

setUsername

public void setUsername(@Nullable
                        java.lang.String newUsername)

Sets the user name component of the URL.

Parameters:

newUsername - user name component of the URL

buildURL

@Nullable
public java.lang.String buildURL()

Builds a URL from the given data. The constructured URL may not be valid if sufficient information is not provided. The returned URL will be appropriately encoded using application/x-www-form-urlencoded with appropriate encoding of UTF-8 characters.

Returns:

URL built from the given data

buildQueryString

@Nullable
public java.lang.String buildQueryString()

Builds the query string for the URL.

Returns:

query string for the URL or null if there are now query parameters