trait AuthenticationDirective[T] extends Directive1[T]

Source
SecurityDirectives.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuthenticationDirective
  2. Directive
  3. AnyRef
  4. Any
Implicitly
  1. by SingleValueTransformers
  2. by addDirectiveApply
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

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

    Definition Classes
    Directive

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. 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.

    Alias for and.

    Definition Classes
    Directive
  4. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toany2stringadd[AuthenticationDirective[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ->[B](y: B): (AuthenticationDirective[T], B)
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toArrowAssoc[AuthenticationDirective[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. def and(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
  8. 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 org.apache.pekko.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()
  9. 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 org.apache.pekko.http.scaladsl.server.Directive.This conversion will take place only if an implicit value of type ApplyConverter[(T)] is in scope.
    Definition Classes
    Function1
  10. 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
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  13. 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] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueTransformers
  14. 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 org.apache.pekko.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
    This member is added by an implicit conversion from AuthenticationDirective[T] toEnsuring[AuthenticationDirective[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (AuthenticationDirective[T]) => Boolean): AuthenticationDirective[T]
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toEnsuring[AuthenticationDirective[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): AuthenticationDirective[T]
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toEnsuring[AuthenticationDirective[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): AuthenticationDirective[T]
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toEnsuring[AuthenticationDirective[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): 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
    This member is added by an implicit conversion from AuthenticationDirective[T] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueTransformers
  23. def finalize(): Unit
    Attributes
    protected[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
    This member is added by an implicit conversion from AuthenticationDirective[T] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueTransformers
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def map[R](f: (T) => R)(implicit tupler: Tupler[R]): Directive[Out]
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueTransformers
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def optional: Directive1[Option[T]]

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

  33. def or[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
  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
    This member is added by an implicit conversion from AuthenticationDirective[T] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueTransformers
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. 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
  39. 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
  40. 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
  41. 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
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. def trequire(predicate: ((T)) => Boolean, rejections: Rejection*): Directive0

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

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

    Definition Classes
    Directive
  44. val underlying: Directive1[T]
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
    Definition Classes
    SingleValueTransformers
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  48. 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.

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

    Alias for or.

    Definition Classes
    Directive

Shadowed Implicit Value Members

  1. def toString(): String
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] to(In) => Route performed by method addDirectiveApply in org.apache.pekko.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

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toStringFormat[AuthenticationDirective[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (AuthenticationDirective[T], B)
    Implicit
    This member is added by an implicit conversion from AuthenticationDirective[T] toArrowAssoc[AuthenticationDirective[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Directive[(T)]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion SingleValueTransformers fromAuthenticationDirective[T] to SingleValueTransformers[T]

Inherited by implicit conversion addDirectiveApply fromAuthenticationDirective[T] to (In) => Route

Inherited by implicit conversion any2stringadd fromAuthenticationDirective[T] to any2stringadd[AuthenticationDirective[T]]

Inherited by implicit conversion StringFormat fromAuthenticationDirective[T] to StringFormat[AuthenticationDirective[T]]

Inherited by implicit conversion Ensuring fromAuthenticationDirective[T] to Ensuring[AuthenticationDirective[T]]

Inherited by implicit conversion ArrowAssoc fromAuthenticationDirective[T] to ArrowAssoc[AuthenticationDirective[T]]

Ungrouped