Package org.wiremock.url

Interface Username

All Superinterfaces:

Normalisable<Username>, org.wiremock.stringparser.ParsedString, PercentEncoded<Username>

public interface Username
extends PercentEncoded<Username>, org.wiremock.stringparser.ParsedString

Represents the username portion of user information in a URI authority.

The username is the part before the colon in user information (username:password). Usernames may contain percent-encoded characters.

Implementations must be immutable and thread-safe.

See Also:

• UserInfo

Method Summary

Static Methods

Modifier and Type	Method	Description
static Username	encode(String unencoded)	Encodes a string into a valid username with proper percent-encoding.
static Username	parse(String username)	Parses a string into a username.

Methods inherited from interface org.wiremock.url.Normalisable

isNormalForm, normalise

Methods inherited from interface org.wiremock.stringparser.ParsedString

toString

Methods inherited from interface org.wiremock.url.PercentEncoded

decode, isEmpty, length

Method Details

parse

static Username parse(String username)
               throws IllegalUsername

Parses a string into a username.

Parameters:

username - the string to parse

Returns:

the parsed username

Throws:

IllegalUsername - if the string is not a valid username

encode

static Username encode(String unencoded)

Encodes a string into a valid username with proper percent-encoding.

Parameters:

unencoded - the unencoded string

Returns:

the encoded username