Package com.activeviam.web.core.api

Interface IUrlBuilder

public interface IUrlBuilder

Definition of a URL builder following Atoti conventions.

This can be used to create full URLs or just parts of it.
It offers a much more detailed API than url(String...).

Author:

ActiveViam

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IUrlBuilder.IBuildable	Interface representing a builder with enough information and options to build an URL.
static interface	IUrlBuilder.IBuildableApi	Interface for a buildable builder with at least API type.
static interface	IUrlBuilder.IBuildablePrefix	Interface for a buildable builder with at least prefix.
static interface	IUrlBuilder.IBuildableService	Interface for a buildable builder with at least service name.
static interface	IUrlBuilder.IBuildableWithPath	Interface for a buildable builder with at least path information.
static interface	IUrlBuilder.IBuildableWithVersion	Interface for a buildable builder with at least API version.
static interface	IUrlBuilder.IBuilder	Base interface for an URL Builder.
static interface	IUrlBuilder.IForHost	Interface offering to set the hostname in an URL.
static interface	IUrlBuilder.IForPath	Interface allowing to define the path parts of the URL.
static interface	IUrlBuilder.IForPrefix	Recursive interface allowing to define prefix for the URL.
static interface	IUrlBuilder.IForService	Interface to define the name of the service API exposed.
static interface	IUrlBuilder.IForVersion	Interface offering a method to define the version of an API.
static interface	IUrlBuilder.IWebApi	Interface allowing to choose the type of API to target.
static interface	IUrlBuilder.IWithSlashOption	Interface offering option for a trailing / in the URL.

Method Summary

Static Methods

Modifier and Type	Method	Description
static IUrlBuilder.IBuilder	create()	Creates a new builder for URLs following Atoti conventions.
static String	normalizeUrl(String url, boolean withTrailingSlash)	Normalizes a URL, removing extra "/" characters.
static String	url(boolean withTrailingSlash, String... parts)	Build an url by joining the different given parts separated by /.
static String	url(String... parts)	Build an url by joining the different given parts separated by /.

Method Details

create

static IUrlBuilder.IBuilder create()

Creates a new builder for URLs following Atoti conventions.

url

static String url(String... parts)

Build an url by joining the different given parts separated by /.

The url starts with /.

 E.g:  - url("a", "/b", "/c/") returns /a/b/c
       - url("http://localhost:9090", "a", "/b", "/c/") returns http://localhost:9090/a/b/c
 

url

static String url(boolean withTrailingSlash,
 String... parts)

Build an url by joining the different given parts separated by /.

The url start with / and may end with /.

 E.g:  - url("a", "/b", "/c") returns /a/b/c/
       - url("http://localhost:9090", "a", "/b", "/c") returns http://localhost:9090/a/b/c/
 

Parameters:

withTrailingSlash - true if the url need to end with "/", false otherwise.

normalizeUrl

static String normalizeUrl(String url,
 boolean withTrailingSlash)

Normalizes a URL, removing extra "/" characters.

Parameters:

url - the url to normalize.

withTrailingSlash - true if the url wants to end with "/", false otherwise.

If true and the trailing / is missing, it is added to the url. If false and present, it is removed.

Returns:

the normalized url.