Package org.wiremock.url

Interface ServersideAbsoluteUrl

All Superinterfaces:

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

All Known Subinterfaces:

BaseUrl, Origin

All Known Implementing Classes:

BaseUrlValue

public interface ServersideAbsoluteUrl
extends AbsoluteUrl

Represents an Absolute URL (a URL without an Fragment) as defined in RFC 3986 Section 4.3. The name ServersideAbsoluteUrl is used in preference to AbsoluteUrl because AbsoluteUrl is more familiarly used by developers to mean a URL that is not relative, rather than in the RFC 3986 sense of a complete URL without a fragment.

An ServersideAbsoluteUrl is a URL with no fragment, suitable for making requests for a representation over the network.

Implementations must be immutable and thread-safe.

See Also:

• RFC 3986 Section 4.3

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 Fragment	getFragment()	Deprecated. This always returns null so you have no reason to ever call it
default ServersideAbsoluteUrl	getServersideAbsoluteUrl()	Deprecated.
ServersideAbsoluteUrl	normalise()	Returns a normalised form of this absolute URL.
static ServersideAbsoluteUrl	parse(String absoluteUrl)	Parses a string into an absolute URL.

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, toBaseUrl, transform

Methods inherited from interface org.wiremock.stringparser.ParsedString

toString

Methods inherited from interface org.wiremock.url.Uri

getPath, getPort, getQuery, getQueryOrEmpty, getResolvedPort, getUserInfo, toJavaUri

Methods inherited from interface org.wiremock.url.Url

getPathAndQuery

Method Details

getFragment

@Deprecated
default @Nullable Fragment getFragment()

Deprecated.

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

Implementations must ALWAYS return null

Specified by:

getFragment in interface Uri

Returns:

null

normalise

ServersideAbsoluteUrl normalise()

Returns a normalised form of this absolute URL.

Specified by:

normalise in interface AbsoluteUri

Specified by:

normalise in interface AbsoluteUrl

Specified by:

normalise in interface Normalisable<AbsoluteUri>

Returns:

a normalised absolute URL

getServersideAbsoluteUrl

@Deprecated
default ServersideAbsoluteUrl getServersideAbsoluteUrl()

Deprecated.

Returns this.

Specified by:

getServersideAbsoluteUrl in interface AbsoluteUrl

Returns:

this

parse

static ServersideAbsoluteUrl parse(String absoluteUrl)
                            throws IllegalServersideAbsoluteUrl

Parses a string into an absolute URL.

Parameters:

absoluteUrl - the string to parse

Returns:

the parsed absolute URL

Throws:

IllegalServersideAbsoluteUrl - if the string is not a valid absolute URL