org.apache.pekko.http.scaladsl.server.directives
AuthenticationDirective
Companion object AuthenticationDirective
trait AuthenticationDirective[T] extends Directive1[T]
- Alphabetic
- By Inheritance
- AuthenticationDirective
- Directive
- AnyRef
- Any
- by SingleValueTransformers
- by addDirectiveApply
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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.tapplyis short for "tuple-apply". Usually, you will use the regularapplymethod instead, which is added by an implicit conversion (seeDirective.addDirectiveApply).- Definition Classes
- Directive
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def &(magnet: ConjunctionMagnet[(T)]): Out
Joins two directives into one which extracts the concatenation of its base directive extractions.
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- 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()
- 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
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- 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
- 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()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.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] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def optional: Directive1[Option[T]]
Returns a copy of this AuthenticationDirective that will provide
Some(user)if credentials were supplied and otherwiseNone. - 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
- 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
thisDirective **before the inner route was applied**.Creates a new directive that is able to recover from rejections that were produced by
thisDirective **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
recoverthat only recovers from rejections handled by the given PartialFunction.Variant of
recoverthat 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] toSingleValueTransformers[T] performed by method SingleValueTransformers in org.apache.pekko.http.scaladsl.server.Directive.
- Definition Classes
- SingleValueTransformers
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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 toString(): String
- Definition Classes
- AnyRef → Any
- 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
- 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
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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.
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 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.