Packages

  • package root
    Definition Classes
    root
  • package play

    Play framework.

    Play framework.

    Play

    http://www.playframework.com

    Definition Classes
    root
  • package api

    Contains the public API for Scala developers.

    Contains the public API for Scala developers.

    Read configuration 
    val poolSize = configuration.getInt("engine.pool.size")
    Use the logger 
    Logger.info("Hello!")
    Define a Plugin 
    class MyPlugin(app: Application) extends Plugin
    Create adhoc applications (for testing) 
    val application = Application(new File("."), this.getClass.getClassloader, None, Play.Mode.DEV)
    Definition Classes
    play
  • package mvc

    Contains the Controller/Action/Result API to handle HTTP requests.

    Contains the Controller/Action/Result API to handle HTTP requests.

    For example, a typical controller:

    class HomeController @Inject() (val controllerComponents: ControllerComponents) extends BaseController {

  def index = Action {
    Ok("It works!")
  }

}
    Definition Classes
    api
  • package request
    Definition Classes
    mvc
  • AssignedCell
  • Cell
  • DefaultRequestFactory
  • LazyCell
  • RemoteConnection
  • RequestAttrKey
  • RequestFactory
  • RequestTarget

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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. 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.

  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def queryString: String

    The query component of the URI as an unparsed string.

  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. def withPath(newPath: String): RequestTarget

    Return a copy of this object with a new path.

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

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

  23. def withUri(newUri: URI): RequestTarget

    Return a copy of this object with a new URI.

  24. def withUriString(newUriString: String): RequestTarget

    Return a copy of this object with a new URI.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped