trait RequestTarget extends AnyRef

The target of a request, as defined in RFC 7230 section 5.3, i.e. the URI or path that has been requested by the client.

Self Type
RequestTarget
Source
RequestTarget.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestTarget
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def path: String

    The path that was requested.

    The path that was requested. If a URI was provided this will be its path component.

  2. abstract def queryMap: Map[String, Seq[String]]

    The query component of the URI parsed into a map of parameters and values.

  3. abstract def uri: URI

    The parsed URI of the request.

    The parsed URI of the request. In rare circumstances, the URI may be unparseable and accessing this value will throw an exception.

  4. abstract def uriString: String

    The complete request URI, containing both path and query string.

    The complete request URI, containing both path and query string. The URI is what was on the status line after the request method. E.g. in "GET /foo/bar?q=s HTTP/1.1" the URI should be /foo/bar?q=s. It could be absolute, some clients send absolute URLs, especially proxies, e.g. http://www.example.org/foo/bar?q=s.

Concrete Value Members

  1. def getQueryParameter(key: String): Option[String]

    Helper method to access a query parameter.

    Helper method to access a query parameter.

    returns

    The query parameter's value if the parameter is present and there is only one value. If the parameter is absent or there is more than one value for that parameter then None is returned.

  2. def queryString: String

    The query component of the URI as an unparsed string.

  3. def withPath(newPath: String): RequestTarget

    Return a copy of this object with a new path.

  4. def withQueryString(newQueryString: Map[String, Seq[String]]): RequestTarget

    Return a copy of this object with a new query string.

  5. def withUri(newUri: URI): RequestTarget

    Return a copy of this object with a new URI.

  6. def withUriString(newUriString: String): RequestTarget

    Return a copy of this object with a new URI.