groovyx.net.http

Class UriBuilder

java.lang.Object

groovyx.net.http.UriBuilder

public abstract class UriBuilder
extends java.lang.Object

Provides a simple means of creating a request URI and optionally overriding its parts.

def uri = UriBuilder.basic(UriBuilder.root())
.setFull('http://localhost:10101')
.setPath('/foo')
.toURI()

Generally, this class is not instantiated directly, but created by the HttpConfig instance and modified.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
UriBuilder()

Method Summary

Modifier and Type	Method and Description
static UriBuilder	basic(UriBuilder parent) Creates a basic UriBuilder from the provided parent builder.
java.net.URI	forCookie(java.net.HttpCookie cookie)
abstract java.lang.String	getFragment() Retrieves the fragment part of the URI.
abstract java.lang.String	getHost() Retrieves the host part of the URI.
abstract UriBuilder	getParent()
abstract GString	getPath() Retrieves the path part of the URI.
abstract int	getPort() Retrieves the port part of the URI.
abstract java.util.Map<java.lang.String,?>	getQuery() Retrieves the Map of query string parameters for the URI.
abstract java.lang.String	getScheme() Retrieves the scheme part of the URI.
java.lang.Boolean	getUseRawValues()
abstract java.lang.String	getUserInfo() Retrieves the user info part of the URI.
protected void	populateFrom(java.net.URI uri)
static UriBuilder	root()
abstract UriBuilder	setFragment(java.lang.String val) Sets the fragment part of the URI.
UriBuilder	setFull(java.lang.String str) Sets the full URI (all parts) as a String.
UriBuilder	setFull(java.net.URI uri) Sets the full URI (all parts) as a URI object.
abstract UriBuilder	setHost(java.lang.String val) Sets the host part of the URI.
abstract UriBuilder	setPath(GString val) Sets the path part of the URI.
UriBuilder	setPath(java.lang.String str) Sets the path part of the URI.
abstract UriBuilder	setPort(int val) Sets the port part of the URI.
abstract UriBuilder	setQuery(java.util.Map<java.lang.String,?> val) Sets the query string part of the URI from the provided map.
abstract UriBuilder	setScheme(java.lang.String val) Sets the scheme part of the URI.
void	setUseRawValues(boolean useRaw)
abstract UriBuilder	setUserInfo(java.lang.String val) Sets the user info part of the URI.
static UriBuilder	threadSafe(UriBuilder parent) Creates a thread-safe UriBuilder from the provided parent builder.
java.net.URI	toURI() Converts the parts of the UriBuilder to the URI object instance.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

Constructor Detail

UriBuilder

public UriBuilder()

Method Detail

setScheme

public abstract UriBuilder setScheme(java.lang.String val)

Sets the scheme part of the URI.

Parameters:

val - the value to use as the scheme part of the URI

Returns:

a reference to this builder

getScheme

public abstract java.lang.String getScheme()

Retrieves the scheme part of the URI.

Returns:

the URI scheme

setPort

public abstract UriBuilder setPort(int val)

Sets the port part of the URI.

Parameters:

val - the value to use as the port part of the URI

Returns:

a reference to this builder

getPort

public abstract int getPort()

Retrieves the port part of the URI.

Returns:

the port part of the URI

setHost

public abstract UriBuilder setHost(java.lang.String val)

Sets the host part of the URI.

Parameters:

val - the value to use as the host part of the URI

Returns:

a reference to this builder

getHost

public abstract java.lang.String getHost()

Retrieves the host part of the URI.

Returns:

the host part of the URI

setPath

public abstract UriBuilder setPath(GString val)

Sets the path part of the URI.

Parameters:

val - the path part of the URI

Returns:

a reference to the builder

getPath

public abstract GString getPath()

Retrieves the path part of the URI.

Returns:

the path part of the URI

setQuery

public abstract UriBuilder setQuery(java.util.Map<java.lang.String,?> val)

Sets the query string part of the URI from the provided map. The query string key-value pairs will be generated from the key-value pairs of the map and are NOT URL-encoded. Nested maps or other data structures are not supported.

Parameters:

val - the map of query string parameters

Returns:

a reference to the builder

getQuery

public abstract java.util.Map<java.lang.String,?> getQuery()

Retrieves the Map of query string parameters for the URI.

Returns:

the Map of query string parameters for the URI.

setFragment

public abstract UriBuilder setFragment(java.lang.String val)

Sets the fragment part of the URI.

Parameters:

val - the fragment part of the URI

Returns:

a reference to the builder

getFragment

public abstract java.lang.String getFragment()

Retrieves the fragment part of the URI.

Returns:

the fragment part of the URI

setUserInfo

public abstract UriBuilder setUserInfo(java.lang.String val)

Sets the user info part of the URI.

Parameters:

val - the user info part of the URI

Returns:

a reference to the builder

getUserInfo

public abstract java.lang.String getUserInfo()

Retrieves the user info part of the URI.

Returns:

the user info part of the URI

getParent

public abstract UriBuilder getParent()

setPath

public UriBuilder setPath(java.lang.String str)

Sets the path part of the URI.

Parameters:

str - the path part of the URI

Returns:

a reference to the builder

forCookie

public java.net.URI forCookie(java.net.HttpCookie cookie)
                       throws java.net.URISyntaxException

Throws:

java.net.URISyntaxException

toURI

public java.net.URI toURI()
                   throws java.net.URISyntaxException

Converts the parts of the UriBuilder to the URI object instance.

Returns:

the generated URI representing the parts contained in the builder

Throws:

java.net.URISyntaxException

setUseRawValues

public void setUseRawValues(boolean useRaw)

getUseRawValues

public java.lang.Boolean getUseRawValues()

populateFrom

protected final void populateFrom(java.net.URI uri)

setFull

public final UriBuilder setFull(java.lang.String str)

Sets the full URI (all parts) as a String.

Parameters:

str - the full URI to be used by the UriBuilder

Returns:

a reference to the builder

Throws:

java.lang.IllegalArgumentException - if there is a problem with the URI syntax

setFull

public final UriBuilder setFull(java.net.URI uri)

Sets the full URI (all parts) as a URI object.

Parameters:

uri - the full URI to be used by the UriBuilder

Returns:

a reference to the builder

basic

public static UriBuilder basic(UriBuilder parent)

Creates a basic UriBuilder from the provided parent builder. An empty UriBuilder may be created using the root() method as the parent value, otherwise a new UriBuilder may be created from an existing builder:

def parent = UriBuilder.basic(UriBuilder.root()).setFull('http://localhost:10101/foo')
def child = UriBuilder.basic(parent)
child.setPath('/bar').toURI() == new URI('http://localhost:10101/bar')

The UriBuilder implementation generated with this method is not thread-safe.

Parameters:

parent - the UriBuilder parent

Returns:

the created UriBuilder

threadSafe

public static UriBuilder threadSafe(UriBuilder parent)

Creates a thread-safe UriBuilder from the provided parent builder. An empty UriBuilder may be created using the root() method as the parent value, otherwise a new UriBuilder may be created from an existing builder:

def parent = UriBuilder.threadSafe(UriBuilder.root()).setFull('http://localhost:10101/foo')
def child = UriBuilder.threadSafe(parent)
child.setPath('/bar').toURI() == new URI('http://localhost:10101/bar')

The UriBuilder implementation generated with this method is thread-safe.

Parameters:

parent - the UriBuilder parent

Returns:

the created UriBuilder

root

public static UriBuilder root()