spray.http

Uri

sealed abstract case class Uri(scheme: String, authority: Authority, path: Path, query: Query, fragment: Option[String]) extends ToStringRenderable with Product with Serializable

An immutable model of an internet URI as defined by http://tools.ietf.org/html/rfc3986. All members of this class represent the *decoded* URI elements (i.e. without percent-encoding).

Linear Supertypes
Serializable, Serializable, Product, Equals, ToStringRenderable, Renderable, AnyRef, Any
Known Subclasses
Empty
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Uri
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ToStringRenderable
  7. Renderable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Uri(scheme: String, authority: Authority, path: Path, query: Query, fragment: Option[String])

Abstract Value Members

  1. abstract def isEmpty: Boolean

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. val authority: Authority

  8. def clone(): AnyRef

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

  9. def copy(scheme: String = scheme, authority: Authority = authority, path: Path = path, query: Query = query, fragment: Option[String] = fragment): Uri

    Returns a copy of this Uri with the given components.

  10. def effectivePort: Int

    The effective port of this Uri given the currently set authority and scheme values.

    The effective port of this Uri given the currently set authority and scheme values. If the authority has an explicitly set port (i.e. a non-zero port value) then this port is the effective port. Otherwise the default port for the current scheme is returned.

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

    Definition Classes
    AnyRef

  12. def finalize(): Unit

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

  13. val fragment: Option[String]

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

    Definition Classes
    AnyRef → Any

  15. def inspect: String

  16. def isAbsolute: Boolean

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. def isRelative: Boolean

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

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. val path: Path

  23. val query: Query

  24. def render[R <: Rendering](r: R, charset: Charset): r.type

    Renders this Uri into the given Renderer as defined by http://tools.

    Renders this Uri into the given Renderer as defined by http://tools.ietf.org/html/rfc3986. All Uri components are encoded and joined as required by the spec. The given charset is used to produce percent-encoded representations of potentially existing non-ASCII characters in the different components.

  25. def render[R <: Rendering](r: R): r.type

    Definition Classes
    Uri → Renderable

  26. def renderWithoutFragment[R <: Rendering](r: R, charset: Charset): r.type

    Renders this Uri (without the fragment component) into the given Renderer as defined by http://tools.

    Renders this Uri (without the fragment component) into the given Renderer as defined by http://tools.ietf.org/html/rfc3986. All Uri components are encoded and joined as required by the spec. The given charset is used to produce percent-encoded representations of potentially existing non-ASCII characters in the different components.

  27. def resolvedAgainst(base: Uri): Uri

    Returns a new absolute Uri that is the result of the resolution process defined by http://tools.

    Returns a new absolute Uri that is the result of the resolution process defined by http://tools.ietf.org/html/rfc3986#section-5.2.2 The given base Uri must be absolute.

  28. val scheme: String

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

    Definition Classes
    AnyRef

  30. def toEffectiveHttpRequestUri(hostHeaderHost: Host, hostHeaderPort: Int, securedConnection: Boolean = false, defaultAuthority: Authority = Authority.Empty): Uri

    Converts this URI to an "effective HTTP request URI" as defined by http://tools.

    Converts this URI to an "effective HTTP request URI" as defined by http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-22#section-5.5.

  31. def toHttpRequestTargetOriginForm: Uri

    Converts this URI into an HTTP request target "origin-form" as defined by https://tools.

    Converts this URI into an HTTP request target "origin-form" as defined by https://tools.ietf.org/html/rfc7230#section-5.3.

    Note that the resulting URI instance is not necessarily a valid RFC 3986 URI! (As it might be a "relative" URI with a part component starting with a double slash.)

  32. def toRelative: Uri

    Converts this URI into a relative URI by keeping the path, query and fragment, but dropping the scheme and authority.

  33. def toString(): String

    Definition Classes
    ToStringRenderable → AnyRef → Any

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. def withAuthority(host: String, port: Int): Uri

    Returns a copy of this Uri with a Authority created using the given host and port.

  38. def withAuthority(host: Host, port: Int, userinfo: String = ""): Uri

    Returns a copy of this Uri with a Authority created using the given host, port and userinfo.

  39. def withAuthority(authority: Authority): Uri

    Returns a copy of this Uri with the given authority.

  40. def withFragment(fragment: String): Uri

    Returns a copy of this Uri with the given fragment.

  41. def withHost(host: String): Uri

    Returns a copy of this Uri with the given host.

  42. def withHost(host: Host): Uri

    Returns a copy of this Uri with the given host.

  43. def withPath(path: Path): Uri

    Returns a copy of this Uri with the given path.

  44. def withPort(port: Int): Uri

    Returns a copy of this Uri with the given port.

  45. def withQuery(map: Map[String, String]): Uri

    Returns a copy of this Uri with a Query created using the given map.

  46. def withQuery(kvp: (String, String)*): Uri

    Returns a copy of this Uri with a Query created using the given (key, value) tuples.

  47. def withQuery(query: String): Uri

    Returns a copy of this Uri with a Query created using the given query string.

  48. def withQuery(query: Query): Uri

    Returns a copy of this Uri with the given query.

  49. def withScheme(scheme: String): Uri

    Returns a copy of this Uri with the given scheme.

    Returns a copy of this Uri with the given scheme. The scheme change of the Uri has the following effect on the port value: - If the Uri has a non-default port for the scheme before the change this port will remain unchanged. - If the Uri has the default port for the scheme before the change it will have the default port for the new scheme after the change.

  50. def withUserInfo(userinfo: String): Uri

    Returns a copy of this Uri with the given userinfo.

  51. def withoutFragment: Uri

    Drops the fragment from this URI

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ToStringRenderable

Inherited from Renderable

Inherited from AnyRef

Inherited from Any

Ungrouped