Handler

play.api.mvc.Handler
See theHandler companion trait
object Handler

Attributes

Companion
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Handler.type

Members list

Type members

Classlikes

object Stage

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Stage.type
trait Stage extends Handler

A special type of play.api.mvc.Handler which allows custom logic to be inserted during handling. A Stage accepts a RequestHeader then returns a new RequestHeader along with the next Handler to use during request handling. The next handler could be a terminal Handler like an EssentialAction, but it could also be another Stage. This means it's possible to chains of Stages that should each be executed in turn. To automatically execute all Stages you can call play.api.mvc.Handler.applyStages.

A special type of play.api.mvc.Handler which allows custom logic to be inserted during handling. A Stage accepts a RequestHeader then returns a new RequestHeader along with the next Handler to use during request handling. The next handler could be a terminal Handler like an EssentialAction, but it could also be another Stage. This means it's possible to chains of Stages that should each be executed in turn. To automatically execute all Stages you can call play.api.mvc.Handler.applyStages.

Attributes

Companion
object
Supertypes
trait Handler
class Object
trait Matchable
class Any

Value members

Concrete methods

def applyStages(requestHeader: RequestHeader, handler: Handler): (RequestHeader, Handler)

Some handlers are built as a series of stages, with each stage returning a new RequestHeader and another stage, until eventually a terminal handler is returned. This method processes all stages in a handler, if any, returning a terminal handler such as EssentialAction or WebSocket.

Some handlers are built as a series of stages, with each stage returning a new RequestHeader and another stage, until eventually a terminal handler is returned. This method processes all stages in a handler, if any, returning a terminal handler such as EssentialAction or WebSocket.

Value parameters

handler

The input Handler.

requestHeader

The current RequestHeader.

Attributes

Returns

The new RequestHeader and Handler.