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

Alphabetic
By Inheritance

Inherited

RequestTarget
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

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.
abstract def queryMap: Map[String, Seq[String]]

The query component of the URI parsed into a map of parameters and values.
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.
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

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
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.
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def queryString: String

The query component of the URI as an unparsed string.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

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

Return a copy of this object with a new path.
def withQueryString(newQueryString: Map[String, Seq[String]]): RequestTarget

Return a copy of this object with a new query string.
def withUri(newUri: URI): RequestTarget

Return a copy of this object with a new URI.
def withUriString(newUriString: String): RequestTarget

Return a copy of this object with a new URI.

Inherited from AnyRef

Inherited from Any

Ungrouped