deadbolt-scala
API
Generated with
deadbolt-scala/be.objectify.deadbolt.scala/DeadboltHandler

DeadboltHandler

be.objectify.deadbolt.scala.DeadboltHandler
trait DeadboltHandler

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def beforeAuthCheck[A](request: Request[A]): Future[Option[Result]]

Invoked prior to a constraint's test. If Option.None is returned, the constraint is applied. If the option contains a result, the constraint will not be applied and the wrapped action will not be invoked.

Invoked prior to a constraint's test. If Option.None is returned, the constraint is applied. If the option contains a result, the constraint will not be applied and the wrapped action will not be invoked.

Attributes

Returns

an option possible containing a Result.

def getDynamicResourceHandler[A](request: Request[A]): Future[Option[DynamicResourceHandler]]

Gets the handler used for dealing with resources restricted to specific users/groups.

Gets the handler used for dealing with resources restricted to specific users/groups.

Attributes

Returns

an option containing the handler for restricted resources

def getSubject[A](request: AuthenticatedRequest[A]): Future[Option[Subject]]

Gets the current subject e.g. the current user.

Gets the current subject e.g. the current user.

Attributes

Returns

a future for an option containing the current subject

def onAuthFailure[A](request: AuthenticatedRequest[A]): Future[Result]

Invoked when an authorization failure is detected for the request.

Invoked when an authorization failure is detected for the request.

Value parameters

request

the authenticated request

Attributes

Returns

the action

Concrete methods

def getPermissionsForRole(roleName: String): Future[List[String]]

Get the permissions associated with a role.

Get the permissions associated with a role.

Value parameters

roleName

the role the permissions are associated with

Attributes

Returns

a non-null list containing the permissions associated with the role

def handlerName: String

Gets the canonical name of the handler. Defaults to the class name.

Gets the canonical name of the handler. Defaults to the class name.

Attributes

Returns

whatever the implementor considers the canonical name of the handler to be

def onAuthSuccess[A](request: AuthenticatedRequest[A], constraintType: String, constraintPoint: ConstraintPoint): Unit

Invoked when authorization succeeds.

Invoked when authorization succeeds.

Value parameters

constraintPoint

the point at which the constraint was applied

constraintType

the type of constraint, e.g. dynamic, restrict, etc

request

the authenticated request

Attributes

Since

2.5.1

Generated with