Object/Class

akka.http.scaladsl.model

Uri

Related Docs: class Uri | package model

Permalink

object Uri extends Serializable

Source
Uri.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Content Hierarchy
NamedHostIPv6HostIPv4HostNonEmptyHostHost
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Uri
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Authority(host: Host, port: Int = 0, userinfo: String = "") extends javadsl.model.Authority with Product with Serializable

    Permalink

    port

    A port number that may be 0 to signal the default port of for scheme. In general what you want is not the value of this field but Uri.effectivePort.

    userinfo

    The percent decoded userinfo. According to https://tools.ietf.org/html/rfc3986#section-3.2.1 the "user:password" syntax is deprecated and implementations are encouraged to ignore any characters after the colon (:). Therefore, it is not guaranteed that future versions of this class will preserve full userinfo between parsing and rendering (even if it might do so right now).

  2. sealed abstract class Host extends javadsl.model.Host

    Permalink

  3. final case class IPv4Host extends NonEmptyHost with Product with Serializable

    Permalink

  4. final case class IPv6Host extends NonEmptyHost with Product with Serializable

    Permalink

  5. final case class NamedHost(address: String) extends NonEmptyHost with Product with Serializable

    Permalink

  6. sealed abstract class NonEmptyHost extends Host

    Permalink

  7. sealed trait ParsingMode extends javadsl.model.Uri.ParsingMode

    Permalink

  8. sealed abstract class Path extends AnyRef

    Permalink

  9. sealed abstract class Query extends LinearSeq[(String, String)] with LinearSeqOptimized[(String, String), Query]

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. val /: Uri

    Permalink

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  5. object Authority extends Serializable

    Permalink

  6. object Empty extends Uri

    Permalink

  7. object Host

    Permalink

  8. object IPv4Host extends Serializable

    Permalink

  9. object IPv6Host extends Serializable

    Permalink

  10. object ParsingMode

    Permalink

  11. object Path

    Permalink

  12. object Query

    Permalink

  13. def apply(scheme: String = "", authority: Authority = Authority.Empty, path: Path = Path.Empty, queryString: Option[String] = None, fragment: Option[String] = None): Uri

    Permalink

    Creates a new Uri instance from the given components.

    Creates a new Uri instance from the given components. All components are verified and normalized except the authority which is kept as provided. If the given combination of components does not constitute a valid URI as defined by http://tools.ietf.org/html/rfc3986 the method throws an IllegalUriException.

  14. def apply(input: ParserInput, charset: Charset, mode: ParsingMode): Uri

    Permalink

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1.

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1. Percent-encoded octets are decoded using the given charset (where specified by the RFC). If strict is false, accepts unencoded visible 7-bit ASCII characters in addition to the RFC. If the given string is not a valid URI the method throws an IllegalUriException.

  15. def apply(input: ParserInput, mode: ParsingMode): Uri

    Permalink

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1.

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1. Percent-encoded octets are decoded using the given charset (where specified by the RFC). If strict is false, accepts unencoded visible 7-bit ASCII characters in addition to the RFC. If the given string is not a valid URI the method throws an IllegalUriException.

  16. def apply(input: ParserInput): Uri

    Permalink

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1.

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1. Percent-encoded octets are decoded using the given charset (where specified by the RFC). Accepts unencoded visible 7-bit ASCII characters in addition to the rfc. If the given string is not a valid URI the method throws an IllegalUriException.

  17. implicit def apply(input: String): Uri

    Permalink

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1.

    Parses a valid URI string into a normalized URI reference as defined by http://tools.ietf.org/html/rfc3986#section-4.1. Percent-encoded octets are UTF-8 decoded. Accepts unencoded visible 7-bit ASCII characters in addition to the RFC. If the given string is not a valid URI the method throws an IllegalUriException.

  18. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. def effectiveHttpRequestUri(scheme: String, host: Host, port: Int, path: Path, query: Option[String], fragment: Option[String], securedConnection: Boolean, hostHeaderHost: Host, hostHeaderPort: Int, defaultAuthority: Authority = Authority.Empty): Uri

    Permalink

    Converts a set of URI components to an "effective HTTP request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5.

  21. def effectiveRequestUri(scheme: String, host: Host, port: Int, path: Path, query: Option[String], fragment: Option[String], defaultScheme: String, hostHeaderHost: Host, hostHeaderPort: Int, defaultAuthority: Authority = Authority.Empty): Uri

    Permalink

    Converts a set of URI components to an "effective request URI" as defined by http://tools.ietf.org/html/rfc7230#section-5.5.

  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  25. def from(scheme: String = "", userinfo: String = "", host: String = "", port: Int = 0, path: String = "", queryString: Option[String] = None, fragment: Option[String] = None, mode: ParsingMode = Uri.ParsingMode.Relaxed): Uri

    Permalink

    Creates a new Uri instance from the given components.

    Creates a new Uri instance from the given components. All components are verified and normalized. If the given combination of components does not constitute a valid URI as defined by http://tools.ietf.org/html/rfc3986 the method throws an IllegalUriException.

  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  27. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  28. def httpScheme(securedConnection: Boolean = false): String

    Permalink

  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  31. def normalize(uri: ParserInput, charset: Charset = UTF8, mode: ParsingMode = Uri.ParsingMode.Relaxed): String

    Permalink

    Normalizes the given URI string by performing the following normalizations:

    Normalizes the given URI string by performing the following normalizations:

    • the scheme and host components are converted to lowercase
    • a potentially existing port component is removed if it matches one of the defined default ports for the scheme
    • percent-encoded octets are decoded if allowed, otherwise they are converted to uppercase hex notation
    • . and .. path segments are resolved as far as possible

    If strict is false, accepts unencoded visible 7-bit ASCII characters in addition to the RFC. If the given string is not a valid URI the method throws an IllegalUriException.

  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  34. def parseAbsolute(input: ParserInput, charset: Charset = UTF8, mode: ParsingMode = Uri.ParsingMode.Relaxed): Uri

    Permalink

    Parses a string into a normalized absolute URI as defined by http://tools.ietf.org/html/rfc3986#section-4.3.

    Parses a string into a normalized absolute URI as defined by http://tools.ietf.org/html/rfc3986#section-4.3. Percent-encoded octets are decoded using the given charset (where specified by the RFC). If strict is false, accepts unencoded visible 7-bit ASCII characters in addition to the RFC. If the given string is not a valid URI the method throws an IllegalUriException.

  35. def parseAndResolve(string: ParserInput, base: Uri, charset: Charset = UTF8, mode: ParsingMode = Uri.ParsingMode.Relaxed): Uri

    Permalink

    Parses a string into a normalized URI reference that is immediately resolved against the given base URI as defined by http://tools.ietf.org/html/rfc3986#section-5.2.

    Parses a string into a normalized URI reference that is immediately resolved against the given base URI as defined by http://tools.ietf.org/html/rfc3986#section-5.2. Note that the given base Uri must be absolute (i.e. define a scheme). Percent-encoded octets are decoded using the given charset (where specified by the RFC). If strict is false, accepts unencoded visible 7-bit ASCII characters in addition to the RFC. If the given string is not a valid URI the method throws an IllegalUriException.

  36. def parseHttpRequestTarget(requestTarget: ParserInput, charset: Charset = UTF8, mode: ParsingMode = Uri.ParsingMode.Relaxed): Uri

    Permalink

    Parses the given string into an HTTP request target URI as defined by http://tools.ietf.org/html/rfc7230#section-5.3.

    Parses the given string into an HTTP request target URI as defined by http://tools.ietf.org/html/rfc7230#section-5.3. If strict is false, accepts unencoded visible 7-bit ASCII characters in addition to the RFC. If the given string is not a valid URI the method throws an IllegalUriException.

  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  38. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  39. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  40. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. def websocketScheme(securedConnection: Boolean = false): String

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped