akka.http.scaladsl.server.directives
AuthenticationDirective
Companion object AuthenticationDirective
trait AuthenticationDirective[T] extends Directive1[T]
- Source
- SecurityDirectives.scala
- Alphabetic
- By Inheritance
- AuthenticationDirective
- Directive
- AnyRef
- Any
- by addDirectiveApply
- by SingleValueTransformers
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
tapply(f: ((T)) ⇒ Route): Route
Calls the inner route with a tuple of extracted values of type
L
.Calls the inner route with a tuple of extracted values of type
L
.tapply
is short for "tuple-apply". Usually, you will use the regularapply
method instead, which is added by an implicit conversion (seeDirective.addDirectiveApply
).- Definition Classes
- Directive
Concrete Value Members
-
def
&(magnet: ConjunctionMagnet[(T)]): Out
Joins two directives into one which extracts the concatenation of its base directive extractions.
Joins two directives into one which extracts the concatenation of its base directive extractions. NOTE: Extraction joining is an O(N) operation with N being the number of extractions on the right-side.
- Definition Classes
- Directive
-
def
andThen[A](g: (Route) ⇒ A): (In) ⇒ A
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if an implicit value of type ApplyConverter[(T)] is in scope.
- Definition Classes
- Function1
- Annotations
- @unspecialized()
-
def
apply(v1: In): Route
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if an implicit value of type ApplyConverter[(T)] is in scope.
- Definition Classes
- Function1
-
def
as[A](constructor: ConstructFromTuple[(T), A]): Directive1[A]
Converts this directive into one which, instead of a tuple of type
L
, creates an instance of typeA
(which is usually a case class).Converts this directive into one which, instead of a tuple of type
L
, creates an instance of typeA
(which is usually a case class).- Definition Classes
- Directive
-
def
collect[R](pf: PartialFunction[T, R], rejections: Rejection*)(implicit tupler: Tupler[R]): Directive[Out]
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
-
def
compose[A](g: (A) ⇒ In): (A) ⇒ Route
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if an implicit value of type ApplyConverter[(T)] is in scope.
- Definition Classes
- Function1
- Annotations
- @unspecialized()
-
implicit
val
ev: Tuple[(T)]
- Definition Classes
- Directive
-
def
filter(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive1[T]
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
-
def
flatMap[R](f: (T) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
-
def
map[R](f: (T) ⇒ R)(implicit tupler: Tupler[R]): Directive[Out]
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
-
def
optional: Directive1[Option[T]]
Returns a copy of this AuthenticationDirective that will provide
Some(user)
if credentials were supplied and otherwiseNone
. -
def
recover[R >: (T)](recovery: (Seq[Rejection]) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]
Creates a new directive that is able to recover from rejections that were produced by
this
Directive **before the inner route was applied**.Creates a new directive that is able to recover from rejections that were produced by
this
Directive **before the inner route was applied**.- Definition Classes
- Directive
-
def
recoverPF[R >: (T)](recovery: PartialFunction[Seq[Rejection], Directive[R]])(implicit arg0: Tuple[R]): Directive[R]
Variant of
recover
that only recovers from rejections handled by the given PartialFunction.Variant of
recover
that only recovers from rejections handled by the given PartialFunction.- Definition Classes
- Directive
-
def
require(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive0
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
-
def
tcollect[R](pf: PartialFunction[(T), R], rejections: Rejection*)(implicit tupler: Tupler[R]): Directive[Out]
If the given scala.PartialFunction is defined for the input, maps this directive with the given function, which can produce either a tuple or any other value.
If the given scala.PartialFunction is defined for the input, maps this directive with the given function, which can produce either a tuple or any other value. If it is not defined however, the returned directive will reject with the given rejections.
- Definition Classes
- Directive
-
def
tfilter(predicate: ((T)) ⇒ Boolean, rejections: Rejection*): Directive[(T)]
Creates a new directive of the same type, which passes if the given predicate matches the current extractions or rejects with the given rejections.
Creates a new directive of the same type, which passes if the given predicate matches the current extractions or rejects with the given rejections.
- Definition Classes
- Directive
-
def
tflatMap[R](f: ((T)) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]
Flatmaps this directive using the given function.
Flatmaps this directive using the given function.
- Definition Classes
- Directive
-
def
tmap[R](f: ((T)) ⇒ R)(implicit tupler: Tupler[R]): Directive[Out]
Maps over this directive using the given function, which can produce either a tuple or any other value (which will then we wrapped into a scala.Tuple1).
Maps over this directive using the given function, which can produce either a tuple or any other value (which will then we wrapped into a scala.Tuple1).
- Definition Classes
- Directive
-
def
trequire(predicate: ((T)) ⇒ Boolean, rejections: Rejection*): Directive0
Creates a new akka.http.scaladsl.server.Directive0, which passes if the given predicate matches the current extractions or rejects with the given rejections.
Creates a new akka.http.scaladsl.server.Directive0, which passes if the given predicate matches the current extractions or rejects with the given rejections.
- Definition Classes
- Directive
-
val
underlying: Directive1[T]
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueTransformers[T] performed by method SingleValueTransformers in akka.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
-
def
withAnonymousUser(anonymous: T): Directive1[T]
Returns a copy of this AuthenticationDirective that uses the given object as the anonymous user which will be used if no credentials were supplied in the request.
-
def
|[R >: (T)](that: Directive[R]): Directive[R]
Joins two directives into one which runs the second directive if the first one rejects.
Joins two directives into one which runs the second directive if the first one rejects.
- Definition Classes
- Directive
Shadowed Implicit Value Members
-
def
toString(): String
- Implicit
- This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ Route performed by method addDirectiveApply in akka.http.scaladsl.server.Directive. This conversion will take place only if an implicit value of type ApplyConverter[(T)] is in scope.
- Shadowing
- This implicitly inherited member is shadowed by one or more members in this class.
To access this member you can use a type ascription:(authenticationDirective: (In) ⇒ Route).toString()
- Definition Classes
- Function1 → AnyRef → Any