ActionRefiner

trait ActionRefiner[-R[_], +P[_]] extends ActionFunction[R, P]

A simple kind of ActionFunction which, given a request (of type R), may either immediately produce a Result (for example, an error), or call its Action block with a parameter (of type P). The critical (abstract) function is refine.

Source: Action.scala

Linear Supertypes

ActionFunction[R, P], AnyRef, Any

Known Subclasses

ActionFilter, ActionTransformer

Ordering

Alphabetic
By Inheritance

Inherited

ActionRefiner
ActionFunction
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Abstract Value Members

abstract def executionContext: ExecutionContext
returns
The execution context to run the request in.
Attributes
protected
Definition Classes
ActionFunction
abstract def refine[A](request: R[A]): Future[Either[Result, P[A]]]
Determine how to process a request.
Determine how to process a request. This is the main method than an ActionRefiner has to implement. It can decide to immediately intercept the request and return a Result (Left), or continue processing with a new parameter of type P (Right).
request
the input request
returns
Either a result or a new parameter to pass to the Action block
Attributes
protected

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
def andThen[Q[_]](other: ActionFunction[P, Q]): ActionFunction[R, Q]
Compose this ActionFunction with another, with this one applied first.
Compose this ActionFunction with another, with this one applied first.
other
ActionFunction with which to compose
returns
The new ActionFunction
Definition Classes
ActionFunction
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
def compose[B](other: ActionBuilder[R, B]): ActionBuilder[P, B]
Definition Classes
ActionFunction
def compose[Q[_]](other: ActionFunction[Q, R]): ActionFunction[Q, P]
Compose another ActionFunction with this one, with this one applied last.
Compose another ActionFunction with this one, with this one applied last.
other
ActionFunction with which to compose
returns
The new ActionFunction
Definition Classes
ActionFunction
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def invokeBlock[A](request: R[A], block: (P[A]) => Future[Result]): Future[Result]
Invoke the block.
Invoke the block. This is the main method that an ActionBuilder has to implement, at this stage it can wrap it in any other actions, modify the request object or potentially use a different class to represent the request.
request
The request
block
The block of code to invoke
returns
A future of the result
Definition Classes
ActionRefiner → ActionFunction
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from ActionFunction[R, P]

Value Members

abstract def executionContext: ExecutionContext
returns
The execution context to run the request in.
Attributes
protected
Definition Classes
ActionFunction
def andThen[Q[_]](other: ActionFunction[P, Q]): ActionFunction[R, Q]
Compose this ActionFunction with another, with this one applied first.
Compose this ActionFunction with another, with this one applied first.
other
ActionFunction with which to compose
returns
The new ActionFunction
Definition Classes
ActionFunction
def compose[B](other: ActionBuilder[R, B]): ActionBuilder[P, B]
Definition Classes
ActionFunction
def compose[Q[_]](other: ActionFunction[Q, R]): ActionFunction[Q, P]
Compose another ActionFunction with this one, with this one applied last.
Compose another ActionFunction with this one, with this one applied last.
other
ActionFunction with which to compose
returns
The new ActionFunction
Definition Classes
ActionFunction

Inherited from AnyRef

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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Ungrouped

abstract def executionContext: ExecutionContext
returns
The execution context to run the request in.
Attributes
protected
Definition Classes
ActionFunction
abstract def refine[A](request: R[A]): Future[Either[Result, P[A]]]
Determine how to process a request.
Determine how to process a request. This is the main method than an ActionRefiner has to implement. It can decide to immediately intercept the request and return a Result (Left), or continue processing with a new parameter of type P (Right).
request
the input request
returns
Either a result or a new parameter to pass to the Action block
Attributes
protected
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
def andThen[Q[_]](other: ActionFunction[P, Q]): ActionFunction[R, Q]
Compose this ActionFunction with another, with this one applied first.
Compose this ActionFunction with another, with this one applied first.
other
ActionFunction with which to compose
returns
The new ActionFunction
Definition Classes
ActionFunction
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
def compose[B](other: ActionBuilder[R, B]): ActionBuilder[P, B]
Definition Classes
ActionFunction
def compose[Q[_]](other: ActionFunction[Q, R]): ActionFunction[Q, P]
Compose another ActionFunction with this one, with this one applied last.
Compose another ActionFunction with this one, with this one applied last.
other
ActionFunction with which to compose
returns
The new ActionFunction
Definition Classes
ActionFunction
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate() @native()
final def invokeBlock[A](request: R[A], block: (P[A]) => Future[Result]): Future[Result]
Invoke the block.
Invoke the block. This is the main method that an ActionBuilder has to implement, at this stage it can wrap it in any other actions, modify the request object or potentially use a different class to represent the request.
request
The request
block
The block of code to invoke
returns
A future of the result
Definition Classes
ActionRefiner → ActionFunction
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)

Packages

Play

Read configuration

Use the logger

Define a Plugin

Create adhoc applications (for testing)

ActionRefiner

trait ActionRefiner[-R[_], +P[_]] extends ActionFunction[R, P]

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ActionFunction[R, P]

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Packages

Play

Read configuration

Use the logger

Define a Plugin

Create adhoc applications (for testing)

ActionRefiner

trait ActionRefiner[-R[_], +P[_]] extends ActionFunction[R, P]

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from ActionFunction[R, P]

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

ActionRefiner