akka.http.scaladsl.server.directives

AuthenticationDirective

trait AuthenticationDirective[T] extends Directive1[T]

Source
SecurityDirectives.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AuthenticationDirective
  2. Directive
  3. AnyRef
  4. Any
Implicitly
  1. by SingleValueModifiers
  2. by addDirectiveApply
  3. by apply
  4. by any2stringadd
  5. by any2stringfmt
  6. by any2ArrowAssoc
  7. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def tapply(f: ((T)) ⇒ (RequestContext) ⇒ Future[RouteResult]): (RequestContext) ⇒ Future[RouteResult]

    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 regular apply method instead, which is added by an implicit conversion (see Directive.addDirectiveApply).

    Definition Classes
    Directive

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. 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
  5. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  6. def ->[B](y: B): (AuthenticationDirective[T], B)

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to ArrowAssoc[AuthenticationDirective[T]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  8. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  9. def andThen[A](g: ((RequestContext) ⇒ Future[RouteResult]) ⇒ A): (In) ⇒ A

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ (RequestContext) ⇒ Future[RouteResult] 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()
  10. def apply(v1: In): (RequestContext) ⇒ Future[RouteResult]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ (RequestContext) ⇒ Future[RouteResult] 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
  11. 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 type A (which is usually a case class).

    Converts this directive into one which, instead of a tuple of type L, creates an instance of type A (which is usually a case class).

    Definition Classes
    Directive
  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def compose[A](g: (A) ⇒ In): (A) ⇒ (RequestContext) ⇒ Future[RouteResult]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ (RequestContext) ⇒ Future[RouteResult] 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()
  15. def ensuring(cond: (AuthenticationDirective[T]) ⇒ Boolean, msg: ⇒ Any): AuthenticationDirective[T]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to Ensuring[AuthenticationDirective[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (AuthenticationDirective[T]) ⇒ Boolean): AuthenticationDirective[T]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to Ensuring[AuthenticationDirective[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): AuthenticationDirective[T]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to Ensuring[AuthenticationDirective[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): AuthenticationDirective[T]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to Ensuring[AuthenticationDirective[T]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  21. implicit val ev: Tuple[(T)]

    Definition Classes
    Directive
  22. def filter(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive1[T]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueModifiers
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def flatMap[R](f: (T) ⇒ Directive[R])(implicit arg0: Tuple[R]): Directive[R]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueModifiers
  25. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  26. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  29. def map[R](f: (T) ⇒ R)(implicit tupler: Tupler[R]): Directive[Out]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueModifiers
  30. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  33. def optional: Directive1[Option[T]]

    Returns a copy of this AuthenticationDirective that will provide Some(user) if credentials were supplied and otherwise None.

  34. 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
  35. 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
  36. def require(predicate: (T) ⇒ Boolean, rejections: Rejection*): Directive0

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to SingleValueModifiers[T] performed by method SingleValueModifiers in akka.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueModifiers
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  38. 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
  39. 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
  40. 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 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 Tuple1).

    Definition Classes
    Directive
  41. def toString(): String

    Definition Classes
    AnyRef → Any
  42. def trequire(predicate: ((T)) ⇒ Boolean, rejections: Rejection*): Directive0

    Creates a new Directive0, which passes if the given predicate matches the current extractions or rejects with the given rejections.

    Creates a new Directive0, which passes if the given predicate matches the current extractions or rejects with the given rejections.

    Definition Classes
    Directive
  43. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. 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.

  47. 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
  48. def [B](y: B): (AuthenticationDirective[T], B)

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to ArrowAssoc[AuthenticationDirective[T]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. 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.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).&(magnet)
    Definition Classes
    Directive
  2. 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 type A (which is usually a case class).

    Converts this directive into one which, instead of a tuple of type L, creates an instance of type A (which is usually a case class).

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).as(constructor)
    Definition Classes
    Directive
  3. implicit val ev: Tuple[(T)]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).ev
    Definition Classes
    Directive
  4. def optional: Directive1[Option[T]]

    Returns a copy of this AuthenticationDirective that will provide Some(user) if credentials were supplied and otherwise None.

    Returns a copy of this AuthenticationDirective that will provide Some(user) if credentials were supplied and otherwise None.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).optional
  5. 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**.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).recover(recovery)(arg0)
    Definition Classes
    Directive
  6. 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.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).recoverPF(recovery)(arg0)
    Definition Classes
    Directive
  7. val self: Any

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (authenticationDirective: StringAdd).self
    Definition Classes
    StringAdd
  8. val self: Any

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (authenticationDirective: StringFormat).self
    Definition Classes
    StringFormat
  9. def tapply(f: ((T)) ⇒ (RequestContext) ⇒ Future[RouteResult]): (RequestContext) ⇒ Future[RouteResult]

    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 regular apply method instead, which is added by an implicit conversion (see Directive.addDirectiveApply).

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).tapply(f)
    Definition Classes
    Directive
  10. 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.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).tfilter(predicate, rejections)
    Definition Classes
    Directive
  11. 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.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).tflatMap(f)(arg0)
    Definition Classes
    Directive
  12. 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 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 Tuple1).

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).tmap(f)(tupler)
    Definition Classes
    Directive
  13. def toString(): String

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to (In) ⇒ (RequestContext) ⇒ Future[RouteResult] 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) ⇒ (RequestContext) ⇒ Future[RouteResult]).toString()
    Definition Classes
    Function1 → AnyRef → Any
  14. def trequire(predicate: ((T)) ⇒ Boolean, rejections: Rejection*): Directive0

    Creates a new Directive0, which passes if the given predicate matches the current extractions or rejects with the given rejections.

    Creates a new Directive0, which passes if the given predicate matches the current extractions or rejects with the given rejections.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).trequire(predicate, rejections)
    Definition Classes
    Directive
  15. 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.

    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.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).withAnonymousUser(anonymous)
  16. 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.

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to AuthenticationDirective[T] performed by method apply in akka.http.scaladsl.server.directives.AuthenticationDirective.
    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: AuthenticationDirective[T]).|(that)
    Definition Classes
    Directive

Deprecated Value Members

  1. def x: AuthenticationDirective[T]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to ArrowAssoc[AuthenticationDirective[T]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (authenticationDirective: ArrowAssoc[AuthenticationDirective[T]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AuthenticationDirective[T]

    Implicit information
    This member is added by an implicit conversion from AuthenticationDirective[T] to Ensuring[AuthenticationDirective[T]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (authenticationDirective: Ensuring[AuthenticationDirective[T]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Directive[(T)]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion SingleValueModifiers from AuthenticationDirective[T] to SingleValueModifiers[T]

Inherited by implicit conversion addDirectiveApply from AuthenticationDirective[T] to (In) ⇒ (RequestContext) ⇒ Future[RouteResult]

Inherited by implicit conversion apply from AuthenticationDirective[T] to AuthenticationDirective[T]

Inherited by implicit conversion any2stringadd from AuthenticationDirective[T] to StringAdd

Inherited by implicit conversion any2stringfmt from AuthenticationDirective[T] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from AuthenticationDirective[T] to ArrowAssoc[AuthenticationDirective[T]]

Inherited by implicit conversion any2Ensuring from AuthenticationDirective[T] to Ensuring[AuthenticationDirective[T]]

Ungrouped