com.mulesoft.mule.runtime.gw.client.uri

Interface UriBuilder

All Known Implementing Classes:

HttpClientUriBuilder

public interface UriBuilder

UriBuilder interface designed to have our own custom set of java.net.URI builders.

Method Summary

Modifier and Type	Method and Description
UriBuilder	appendPath(String path) Append to the path of the URI.
URI	build(Object... params) Builds the URI based on the URI members previously load.
UriBuilder	fromUri(String path) Sets the base uri that the builder will use to start constructing the uri from.
UriBuilder	queryParam(String name, String value) Add a query string parameter to the URI.

Method Detail

fromUri

UriBuilder fromUri(String path)

Sets the base uri that the builder will use to start constructing the uri from.

Parameters:

path - specifies the base uri

Returns:

the same instance of the builder.

appendPath

UriBuilder appendPath(String path)

Append to the path of the URI. This can have named placeholders of the form {param}, that will be filled out at the moment of the building of the URI (@see "build"). Take into account that this will *not* remove double slashes on the resulting path. Example of path: "/service/{applicationName}/get"

Parameters:

path - specifies the path to be appended to the URI.

Returns:

the same instance of the builder.

queryParam

UriBuilder queryParam(String name,
                      String value)

Add a query string parameter to the URI.

Parameters:

name - specifies the name of the query string param.

value - specifies the value of the query string param.

Returns:

the same instance of the builder.

build

URI build(Object... params)

Builds the URI based on the URI members previously load. You can also specify values for each of the placeholders you specified in the path.

Parameters:

params - specifies a list of objects representing the values of the placeholders within the path.

Returns:

the fully constructed java.net.URI based on the URI members previously loaded.