Package ai.vespa.http

Class HttpURL

java.lang.Object

ai.vespa.http.HttpURL

public class HttpURL
extends Object

This is the best class for creating, manipulating and inspecting HTTP URLs, because:

• It is more restrictive than URI, but with a richer construction API, reducing risk of blunder.
  • Scheme must be HTTP or HTTPS.
  • Authority must be a DomainName, with an optional port.
  • HttpURL.Path must be normalized at all times.
  • Only HttpURL.Query is allowed, in addition to the above.
• It contains all those helpful builder methods that URI has none of.
  • HttpURL.Path can be parsed, have segments or other paths appended, and cut.
  • HttpURL.Query can be parsed, and keys and key-value pairs can be inserted or removed.
  All these (except the parse methods) operate on decoded values.
• It makes it super-easy to use a StringWrapper for validation of path and query segments.

Author:

jonmv

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpURL.Path
static class	HttpURL.Query
static enum	HttpURL.Scheme

Method Summary

Modifier and Type	Method	Description
HttpURL	appendPath(HttpURL.Path path)	Returns a copy of this with the given path appended.
HttpURL	appendQuery(HttpURL.Query query)	Returns a copy of this with all entries of the query appended.
URI	asURI()	Returns an absolute, hierarchical URI representing this HTTP URL.
static HttpURL	create(HttpURL.Scheme scheme, DomainName domain)
static HttpURL	create(HttpURL.Scheme scheme, DomainName domain, int port)
static HttpURL	create(HttpURL.Scheme scheme, DomainName domain, int port, HttpURL.Path path)
static HttpURL	create(HttpURL.Scheme scheme, DomainName domain, int port, HttpURL.Path path, HttpURL.Query query)
DomainName	domain()
boolean	equals(Object o)
static HttpURL	from(URI uri)
static HttpURL	from(URI uri, Consumer<String> pathValidator, Consumer<String> queryValidator)
int	hashCode()
HttpURL.Path	path()
OptionalInt	port()
HttpURL.Query	query()
static String	requirePathSegment(String value)	Require that the given string (possibly decoded multiple times) contains none of '/', '?', '#', and isn't either of "", ".", "..".
HttpURL.Scheme	scheme()
String	toString()
HttpURL	withDomain(DomainName domain)	Returns a copy of this with the given domain.
HttpURL	withoutPort()	Returns a copy of this with no port specified.
HttpURL	withPath(HttpURL.Path path)	Returns a copy of this with only the given path.
HttpURL	withPort(int port)	Returns a copy of this with the given non-negative port.
HttpURL	withQuery(HttpURL.Query query)	Returns a copy of this with only the given query.
HttpURL	withScheme(HttpURL.Scheme scheme)	Returns a copy of this with the given scheme.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

create

public static HttpURL create(HttpURL.Scheme scheme,
 DomainName domain,
 int port,
 HttpURL.Path path,
 HttpURL.Query query)

create

public static HttpURL create(HttpURL.Scheme scheme,
 DomainName domain,
 int port,
 HttpURL.Path path)

create

public static HttpURL create(HttpURL.Scheme scheme,
 DomainName domain,
 int port)

create

public static HttpURL create(HttpURL.Scheme scheme,
 DomainName domain)

from

public static HttpURL from(URI uri)

from

public static HttpURL from(URI uri,
 Consumer<String> pathValidator,
 Consumer<String> queryValidator)

withScheme

public HttpURL withScheme(HttpURL.Scheme scheme)

Returns a copy of this with the given scheme.

withDomain

public HttpURL withDomain(DomainName domain)

Returns a copy of this with the given domain.

withPort

public HttpURL withPort(int port)

Returns a copy of this with the given non-negative port.

withoutPort

public HttpURL withoutPort()

Returns a copy of this with no port specified.

withPath

public HttpURL withPath(HttpURL.Path path)

Returns a copy of this with only the given path.

appendPath

public HttpURL appendPath(HttpURL.Path path)

Returns a copy of this with the given path appended.

withQuery

public HttpURL withQuery(HttpURL.Query query)

Returns a copy of this with only the given query.

appendQuery

public HttpURL appendQuery(HttpURL.Query query)

Returns a copy of this with all entries of the query appended.

scheme

public HttpURL.Scheme scheme()

domain

public DomainName domain()

port

public OptionalInt port()

path

public HttpURL.Path path()

query

public HttpURL.Query query()

asURI

public URI asURI()

Returns an absolute, hierarchical URI representing this HTTP URL.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

requirePathSegment

public static String requirePathSegment(String value)

Require that the given string (possibly decoded multiple times) contains none of '/', '?', '#', and isn't either of "", ".", "..".