Trait/Object

play.api.mvc.request

RequestTarget

Related Docs: object RequestTarget | package request

Permalink

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. All

Abstract Value Members

  1. abstract def path: String

    Permalink

    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]]

    Permalink

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

  3. abstract def uri: URI

    Permalink

    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

    Permalink

    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. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getQueryParameter(key: String): Option[String]

    Permalink

    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.

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. def queryString: String

    Permalink

    The query component of the URI as an unparsed string.

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

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def withPath(newPath: String): RequestTarget

    Permalink

    Return a copy of this object with a new path.

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

    Permalink

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

  24. def withUri(newUri: URI): RequestTarget

    Permalink

    Return a copy of this object with a new URI.

  25. def withUriString(newUriString: String): RequestTarget

    Permalink

    Return a copy of this object with a new URI.

Inherited from AnyRef

Inherited from Any

Ungrouped