Package org.wiremock.url

Interface Origin

All Superinterfaces:

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

public interface Origin
extends BaseUrl

Represents a web origin as defined in HTML Living Standard.

An origin consists of a scheme, host, and port. It represents the security context of a web resource and is used for same-origin policy enforcement. Origins have no path, query, or fragment components.

The component parts of an origin (scheme, host and port) are always normalised. The origin itself is not the normal form of the URL it represents, since it has an empty path rather than an absolute root path. Origin.parse("https://example.org").normalise().toString() will return https://example.org/ .

Implementations must be immutable and thread-safe.

See Also:

• HTML Living Standard - Origin

Nested Class Summary

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

AbsoluteUrl.Builder, AbsoluteUrl.Transformer

Method Summary

Modifier and Type	Method	Description
HostAndPort	getAuthority()	Returns the authority component of this origin.
default Origin	getOrigin()	Deprecated.
default Path	getPath()	Deprecated. This always returns empty so you have no reason to ever call it
default PathAndQuery	getPathAndQuery()	Deprecated. This always returns empty so you have no reason to ever call it
default @Nullable Query	getQuery()	Deprecated. This always returns null so you have no reason to ever call it
default Origin	getServersideAbsoluteUrl()	Deprecated.
BaseUrl	normalise()	Returns a normalised form of this origin by setting the path to / .
static Origin	of(Scheme scheme, HostAndPort hostAndPort)	Creates an origin from a scheme and host/port.
static Origin	parse(String origin)	Parses a string into an origin.

Methods inherited from interface org.wiremock.url.AbsoluteUri

getScheme, isAbsolute, isNormalForm, resolve, resolve

Methods inherited from interface org.wiremock.url.AbsoluteUrl

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

Methods inherited from interface org.wiremock.url.BaseUrl

toBaseUrl

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

getPort, getQueryOrEmpty, getResolvedPort, getUserInfo, toJavaUri

Method Details

getAuthority

HostAndPort getAuthority()

Returns the authority component of this origin.

Origins always have an authority that is a HostAndPort (no user info).

Specified by:

getAuthority in interface AbsoluteUrl

Specified by:

getAuthority in interface Uri

Specified by:

getAuthority in interface UrlWithAuthority

Returns:

the authority component, never null

getPathAndQuery

@Deprecated
default PathAndQuery getPathAndQuery()

Deprecated.

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

Implementations must ALWAYS return PathAndQuery.EMPTY

Specified by:

getPathAndQuery in interface Url

Returns:

PathAndQuery.EMPTY

getPath

@Deprecated
default Path getPath()

Deprecated.

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

Implementations must ALWAYS return Path.EMPTY

Specified by:

getPath in interface Uri

Returns:

Path.EMPTY

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 BaseUrl

Specified by:

getQuery in interface Uri

Returns:

null

normalise

BaseUrl normalise()

Returns a normalised form of this origin by setting the path to / .

Specified by:

normalise in interface AbsoluteUri

Specified by:

normalise in interface AbsoluteUrl

Specified by:

normalise in interface BaseUrl

Specified by:

normalise in interface Normalisable<AbsoluteUri>

Specified by:

normalise in interface ServersideAbsoluteUrl

Returns:

a normalised origin (as a URL)

getOrigin

@Deprecated
default Origin getOrigin()

Deprecated.

Returns this.

Specified by:

getOrigin in interface AbsoluteUrl

Returns:

this

getServersideAbsoluteUrl

@Deprecated
default Origin getServersideAbsoluteUrl()

Deprecated.

Returns this.

Specified by:

getServersideAbsoluteUrl in interface AbsoluteUrl

Specified by:

getServersideAbsoluteUrl in interface BaseUrl

Specified by:

getServersideAbsoluteUrl in interface ServersideAbsoluteUrl

Returns:

this

of

static Origin of(Scheme scheme,
 HostAndPort hostAndPort)
          throws IllegalOrigin

Creates an origin from a scheme and host/port.

Parameters:

scheme - the scheme

hostAndPort - the host and port

Returns:

the origin

Throws:

IllegalOrigin - if any of the scheme, host and port are not normalised

parse

static Origin parse(String origin)
             throws IllegalOrigin

Parses a string into an origin.

Parameters:

origin - the string to parse

Returns:

the parsed origin

Throws:

IllegalOrigin - if the string is not a valid origin