com.box.restclientv2.httpclientsupport

Class HttpClientURIBuilder

java.lang.Object

com.box.restclientv2.httpclientsupport.HttpClientURIBuilder

public class HttpClientURIBuilder
extends Object

URI builder for HTTP requests.

Since:

4.2

Constructor Summary

Constructors

Constructor and Description
HttpClientURIBuilder() Constructs an empty instance.
HttpClientURIBuilder(String string) Construct an instance from the string which must be a valid URI.
HttpClientURIBuilder(URI uri) Construct an instance from the provided URI.

Method Summary

Methods

Modifier and Type	Method and Description
HttpClientURIBuilder	addParameter(String param, String value) Adds parameter to URI query.
URI	build() Builds a URI instance.
String	getFragment()
String	getHost()
String	getPath()
int	getPort()
List<org.apache.http.NameValuePair>	getQueryParams()
String	getScheme()
String	getUserInfo()
HttpClientURIBuilder	removeQuery() Removes URI query.
HttpClientURIBuilder	setFragment(String fragment) Sets URI fragment.
HttpClientURIBuilder	setHost(String host) Sets URI host.
HttpClientURIBuilder	setParameter(String param, String value) Sets parameter of URI query overriding existing value if set.
HttpClientURIBuilder	setPath(String path) Sets URI path.
HttpClientURIBuilder	setPort(int port) Sets URI port.
HttpClientURIBuilder	setQuery(String query) Sets URI query.
HttpClientURIBuilder	setScheme(String scheme) Sets URI scheme.
HttpClientURIBuilder	setUserInfo(String userInfo) Sets URI user info.
HttpClientURIBuilder	setUserInfo(String username, String password) Sets URI user info as a combination of username and password.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientURIBuilder

public HttpClientURIBuilder()

Constructs an empty instance.

HttpClientURIBuilder

public HttpClientURIBuilder(String string)
                     throws URISyntaxException

Construct an instance from the string which must be a valid URI.

Parameters:

string - a valid URI in string form

Throws:

URISyntaxException - if the input is not a valid URI

HttpClientURIBuilder

public HttpClientURIBuilder(URI uri)
                     throws URISyntaxException

Construct an instance from the provided URI.

Parameters:

uri -

Throws:

URISyntaxException

Method Detail

build

public URI build()
          throws URISyntaxException

Builds a URI instance.

Throws:

URISyntaxException

setScheme

public HttpClientURIBuilder setScheme(String scheme)

Sets URI scheme.

setUserInfo

public HttpClientURIBuilder setUserInfo(String userInfo)

Sets URI user info. The value is expected to be unescaped and may contain non ASCII characters.

setUserInfo

public HttpClientURIBuilder setUserInfo(String username,
                               String password)

Sets URI user info as a combination of username and password. These values are expected to be unescaped and may contain non ASCII characters.

setHost

public HttpClientURIBuilder setHost(String host)

Sets URI host.

setPort

public HttpClientURIBuilder setPort(int port)

Sets URI port.

setPath

public HttpClientURIBuilder setPath(String path)

Sets URI path. The value is expected to be unescaped and may contain non ASCII characters.

removeQuery

public HttpClientURIBuilder removeQuery()

Removes URI query.

setQuery

public HttpClientURIBuilder setQuery(String query)
                              throws URISyntaxException

Sets URI query.

The value is expected to be encoded form data.

Throws:

URISyntaxException

addParameter

public HttpClientURIBuilder addParameter(String param,
                                String value)

Adds parameter to URI query. The parameter name and value are expected to be unescaped and may contain non ASCII characters.

setParameter

public HttpClientURIBuilder setParameter(String param,
                                String value)

Sets parameter of URI query overriding existing value if set. The parameter name and value are expected to be unescaped and may contain non ASCII characters.

setFragment

public HttpClientURIBuilder setFragment(String fragment)

Sets URI fragment. The value is expected to be unescaped and may contain non ASCII characters.

getScheme

public String getScheme()

getUserInfo

public String getUserInfo()

getHost

public String getHost()

getPort

public int getPort()

getPath

public String getPath()

getQueryParams

public List<org.apache.http.NameValuePair> getQueryParams()

getFragment

public String getFragment()

toString

public String toString()

Overrides:

toString in class Object