Trait

play.api.mvc

ActionFilter

Related Doc: package mvc

Permalink

trait ActionFilter[R[_]] extends ActionRefiner[R, R]

A simple kind of ActionRefiner which, given a request (of type R), may either immediately produce a Result (for example, an error), or continue its Action block with the same request. The critical (abstract) function is filter.

Source
Action.scala
Linear Supertypes
ActionRefiner[R, R], ActionFunction[R, R], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActionFilter
  2. ActionRefiner
  3. ActionFunction
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def executionContext: ExecutionContext

    Permalink

    Get the execution context to run the request in.

    Get the execution context to run the request in.

    returns

    The execution context

    Attributes
    protected
    Definition Classes
    ActionFunction
  2. abstract def filter[A](request: R[A]): Future[Option[Result]]

    Permalink

    Determine whether to process a request.

    Determine whether to process a request. This is the main method that an ActionFilter has to implement. It can decide to immediately intercept the request and return a Result (Some), or continue processing (None).

    request

    the input request

    returns

    An optional Result with which to abort the request

    Attributes
    protected

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. def andThen[Q[_]](other: ActionFunction[R, Q]): ActionFunction[R, Q]

    Permalink

    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
  5. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def compose[B](other: ActionBuilder[R, B]): ActionBuilder[R, B]

    Permalink
    Definition Classes
    ActionFunction
  8. def compose[Q[_]](other: ActionFunction[Q, R]): ActionFunction[Q, R]

    Permalink

    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
  9. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def invokeBlock[A](request: R[A], block: (R[A]) ⇒ Future[Result]): Future[Result]

    Permalink

    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
    ActionRefinerActionFunction
  15. final def isInstanceOf[T0]: Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  19. final def refine[A](request: R[A]): Future[Product with Serializable with Either[Result, R[A]]]

    Permalink

    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
    Definition Classes
    ActionFilterActionRefiner
  20. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ActionRefiner[R, R]

Inherited from ActionFunction[R, R]

Inherited from AnyRef

Inherited from Any

Ungrouped