Package akka.http.javadsl.model
Class Uri
- java.lang.Object
-
- akka.http.javadsl.model.Uri
-
- Direct Known Subclasses:
JavaUri
public abstract class Uri extends java.lang.Object
Represents an Uri. Use methods on the class to create modified copies of a given instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Uri.ParsingMode
-
Field Summary
Fields Modifier and Type Field Description static Uri
EMPTY
Creates a default Uri to be modified using the modification methods.static Uri.ParsingMode
RELAXED
static Uri.ParsingMode
STRICT
-
Constructor Summary
Constructors Constructor Description Uri()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract Uri
addPathSegment(java.lang.String segment)
Returns a copy of this instance with a path segment added at the end.abstract Uri
asScala()
Returns the Scala DSL representation of this Uri.static Uri
create(Uri uri)
Returns the Java DSL representation of a Scala DSL Uri.static Uri
create(java.lang.String uri)
Returns a Uri created by parsing the given string representation.static Uri
create(java.lang.String uri, Uri.ParsingMode parsingMode)
Returns a Uri created by parsing the given string representation with the provided parsing mode.static Uri
create(java.lang.String uri, java.nio.charset.Charset charset, Uri.ParsingMode parsingMode)
Returns a Uri created by parsing the given string representation with the provided charset and parsing mode.abstract java.util.Optional<java.lang.String>
fragment()
Returns the fragment part of this Uri.abstract Uri
fragment(java.lang.String fragment)
Returns a copy of this instance with a new fragment.abstract Uri
fragment(java.util.Optional<java.lang.String> fragment)
Returns a copy of this instance with a new optional fragment.abstract Host
getHost()
Returns the host of this instanceabstract java.lang.String
getPathString()
Returns the path of this instanceabstract int
getPort()
Returns the port of this instanceabstract java.lang.String
getScheme()
Returns the scheme of this instanceabstract java.lang.String
getUserInfo()
Returns the user info of this instanceabstract Host
host()
Returns the Host of this Uri.abstract Uri
host(Host host)
Returns a copy of this instance with a new Host.abstract Uri
host(java.lang.String host)
Returns a copy of this instance with a new host.abstract boolean
isAbsolute()
Returns if this is an absolute Uri.abstract boolean
isEmpty()
Returns if this is an empty Uri.abstract boolean
isRelative()
Returns if this is a relative Uri.abstract java.lang.String
path()
Returns a String representation of the path of this Uri.abstract Uri
path(java.lang.String path)
Returns a copy of this instance with a new path.abstract java.lang.Iterable<java.lang.String>
pathSegments()
Returns the path segments of this Uri as an Iterable.abstract int
port()
Returns the port of this Uri.abstract Uri
port(int port)
Returns a copy of this instance with a new port.abstract Query
query()
Returns the parsed Query instance of this Uri.abstract Uri
query(Query query)
Returns a copy of this instance with a new query.abstract Query
query(java.nio.charset.Charset charset, Uri.ParsingMode mode)
Returns the parsed Query instance of this Uri using the given charset and parsing mode.abstract java.util.Optional<java.lang.String>
queryString(java.nio.charset.Charset charset)
Returns a decoded String representation of the query of this Uri.abstract java.util.Optional<java.lang.String>
rawQueryString()
Returns an undecoded String representation of the query of this Uri.abstract Uri
rawQueryString(java.lang.String rawQuery)
Returns a copy of this instance with a new query.abstract Uri
rawQueryString(java.lang.String rawQuery, boolean strict)
Returns a copy of this instance with a new query.abstract java.lang.String
scheme()
Returns the scheme of this Uri.abstract Uri
scheme(java.lang.String scheme)
Returns a copy of this instance with a new scheme.abstract Uri
toRelative()
Returns a copy of this instance that is relative.abstract java.lang.String
userInfo()
Returns the user-info of this Uri.abstract Uri
userInfo(java.lang.String userInfo)
Returns a copy of this instance with new user-info.
-
-
-
Field Detail
-
STRICT
public static final Uri.ParsingMode STRICT
-
RELAXED
public static final Uri.ParsingMode RELAXED
-
EMPTY
public static final Uri EMPTY
Creates a default Uri to be modified using the modification methods.
-
-
Method Detail
-
isAbsolute
public abstract boolean isAbsolute()
Returns if this is an absolute Uri.
-
isRelative
public abstract boolean isRelative()
Returns if this is a relative Uri.
-
isEmpty
public abstract boolean isEmpty()
Returns if this is an empty Uri.
-
scheme
public abstract java.lang.String scheme()
Returns the scheme of this Uri.
-
host
public abstract Host host()
Returns the Host of this Uri.
-
port
public abstract int port()
Returns the port of this Uri.
-
userInfo
public abstract java.lang.String userInfo()
Returns the user-info of this Uri.
-
path
public abstract java.lang.String path()
Returns a String representation of the path of this Uri.
-
pathSegments
public abstract java.lang.Iterable<java.lang.String> pathSegments()
Returns the path segments of this Uri as an Iterable.
-
queryString
public abstract java.util.Optional<java.lang.String> queryString(java.nio.charset.Charset charset)
Returns a decoded String representation of the query of this Uri.
-
rawQueryString
public abstract java.util.Optional<java.lang.String> rawQueryString()
Returns an undecoded String representation of the query of this Uri.
-
query
public abstract Query query()
Returns the parsed Query instance of this Uri.
-
query
public abstract Query query(java.nio.charset.Charset charset, Uri.ParsingMode mode)
Returns the parsed Query instance of this Uri using the given charset and parsing mode.
-
fragment
public abstract java.util.Optional<java.lang.String> fragment()
Returns the fragment part of this Uri.
-
scheme
public abstract Uri scheme(java.lang.String scheme)
Returns a copy of this instance with a new scheme.
-
host
public abstract Uri host(java.lang.String host)
Returns a copy of this instance with a new host.
-
port
public abstract Uri port(int port)
Returns a copy of this instance with a new port.
-
userInfo
public abstract Uri userInfo(java.lang.String userInfo)
Returns a copy of this instance with new user-info.
-
path
public abstract Uri path(java.lang.String path)
Returns a copy of this instance with a new path.
-
addPathSegment
public abstract Uri addPathSegment(java.lang.String segment)
Returns a copy of this instance with a path segment added at the end.
-
rawQueryString
public abstract Uri rawQueryString(java.lang.String rawQuery)
Returns a copy of this instance with a new query. Characters that are not within the range described at https://tools.ietf.org/html/rfc3986#section-3.4 should be percent-encoded. Characters that are in that range may or may not be percent-encoded, and depending on how the query string is parsed this might be relevant: for example, when interpreting the query string as 'key=value' pairs you could use the percent-encoded '=' ('%22) to include a '=' in the key or value. When characters are encountered that are outside of the RFC3986 range they are automatically percent-encoded, but be aware that relying on this is usually a programming error.
-
rawQueryString
public abstract Uri rawQueryString(java.lang.String rawQuery, boolean strict)
Returns a copy of this instance with a new query. Characters that are not within the range described at https://tools.ietf.org/html/rfc3986#section-3.4 should be percent-encoded. Characters that are in that range may or may not be percent-encoded, and depending on how the query string is parsed this might be relevant: for example, when interpreting the query string as 'key=value' pairs you could use the percent-encoded '=' ('%22) to include a '=' in the key or value.- Parameters:
strict
- depending on the 'strict' flag, characters outside of the range allowed by RFC3986 will either cause a `IllegalUriException` or be automatically percent-encoded. Be aware that relying on automatic percent-encoding is usually a programming error.
-
toRelative
public abstract Uri toRelative()
Returns a copy of this instance that is relative.
-
fragment
public abstract Uri fragment(java.lang.String fragment)
Returns a copy of this instance with a new fragment.
-
fragment
public abstract Uri fragment(java.util.Optional<java.lang.String> fragment)
Returns a copy of this instance with a new optional fragment.
-
getScheme
public abstract java.lang.String getScheme()
Returns the scheme of this instance
-
getHost
public abstract Host getHost()
Returns the host of this instance
-
getPort
public abstract int getPort()
Returns the port of this instance
-
getUserInfo
public abstract java.lang.String getUserInfo()
Returns the user info of this instance
-
getPathString
public abstract java.lang.String getPathString()
Returns the path of this instance
-
asScala
public abstract Uri asScala()
Returns the Scala DSL representation of this Uri.
-
create
public static Uri create(java.lang.String uri)
Returns a Uri created by parsing the given string representation.
-
create
public static Uri create(java.lang.String uri, Uri.ParsingMode parsingMode)
Returns a Uri created by parsing the given string representation with the provided parsing mode.
-
create
public static Uri create(java.lang.String uri, java.nio.charset.Charset charset, Uri.ParsingMode parsingMode)
Returns a Uri created by parsing the given string representation with the provided charset and parsing mode.
-
-