Package org.wiremock.url

Interface BaseUrl

All Superinterfaces:

AbsoluteUri, AbsoluteUrl, Normalisable<AbsoluteUri>, org.wiremock.stringparser.ParsedString, ServersideAbsoluteUrl, Uri, Url, UrlWithAuthority

All Known Subinterfaces:

Origin

All Known Implementing Classes:

BaseUrlValue

public interface BaseUrl
extends ServersideAbsoluteUrl

A base url is a url whose path is either empty or ends with a slash, and which has neither a query nor a fragment.

You can always resolve a relative path (and query and fragment) onto it and it will effectively be appended to the base url:

• https://example.com resolve some/path?q#f == https://example.com/some/path?q#f
• https://example.com/base/path/ resolve some/path?q#f == https://example.com/base/path/some/path?q#f

Nested Class Summary

Nested classes/interfaces inherited from interface org.wiremock.url.AbsoluteUrl

AbsoluteUrl.Builder, AbsoluteUrl.Transformer

Method Summary

Modifier and Type	Method	Description
default @Nullable Query	getQuery()	Deprecated. This always returns null so you have no reason to ever call it
default BaseUrl	getServersideAbsoluteUrl()	Deprecated.
BaseUrl	normalise()	Returns a normalised form of this base url
static BaseUrl	of(Scheme scheme, Authority authority)
static BaseUrl	of(Scheme scheme, Authority authority, Path path)
static BaseUrl	parse(String baseUrl)	Parses a string into a base url.
default BaseUrl	toBaseUrl()	Deprecated.

Methods inherited from interface org.wiremock.url.AbsoluteUri

getScheme, isAbsolute, isNormalForm, resolve, resolve

Methods inherited from interface org.wiremock.url.AbsoluteUrl

getAuthority, getHost, getOrigin, getSchemeRelativeUrl, isAbsoluteUrl, isOpaqueUri, isRelative, resolve, resolve, resolve, thaw, transform

Methods inherited from interface org.wiremock.stringparser.ParsedString

toString

Methods inherited from interface org.wiremock.url.ServersideAbsoluteUrl

getFragment

Methods inherited from interface org.wiremock.url.Uri

getPath, getPort, getQueryOrEmpty, getResolvedPort, getUserInfo, toJavaUri

Methods inherited from interface org.wiremock.url.Url

getPathAndQuery

Method Details

normalise

BaseUrl normalise()

Returns a normalised form of this base url

Specified by:

normalise in interface AbsoluteUri

Specified by:

normalise in interface AbsoluteUrl

Specified by:

normalise in interface Normalisable<AbsoluteUri>

Specified by:

normalise in interface ServersideAbsoluteUrl

Returns:

a normalised base url

getServersideAbsoluteUrl

@Deprecated
default BaseUrl getServersideAbsoluteUrl()

Deprecated.

Returns this.

Specified by:

getServersideAbsoluteUrl in interface AbsoluteUrl

Specified by:

getServersideAbsoluteUrl in interface ServersideAbsoluteUrl

Returns:

this

getQuery

@Deprecated
default @Nullable Query getQuery()

Deprecated.

This always returns null so you have no reason to ever call it

Implementations must ALWAYS return null

Specified by:

getQuery in interface Uri

Returns:

null

toBaseUrl

@Deprecated
default BaseUrl toBaseUrl()

Deprecated.

Returns this.

Specified by:

toBaseUrl in interface AbsoluteUrl

Returns:

this

parse

static BaseUrl parse(String baseUrl)
              throws IllegalBaseUrl

Parses a string into a base url.

Parameters:

baseUrl - the string to parse

Returns:

the parsed base url

Throws:

IllegalBaseUrl - if the string is not a valid base url

of

static BaseUrl of(Scheme scheme,
 Authority authority)

of

static BaseUrl of(Scheme scheme,
 Authority authority,
 Path path)