akka.http.javadsl.server.values

HttpBasicAuthenticator

abstract class HttpBasicAuthenticator[T] extends AbstractDirective with ExtractionImplBase[T] with RequestVal[T]

Implement this class to provide an HTTP Basic authentication check. The authenticate method needs to be implemented to check if the supplied or missing credentials are authenticated and provide a domain level object representing the user as a RequestVal.

Source
HttpBasicAuthenticator.scala
Linear Supertypes
ExtractionImplBase[T], RequestVal[T], AbstractDirective, Directive, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HttpBasicAuthenticator
  2. ExtractionImplBase
  3. RequestVal
  4. AbstractDirective
  5. Directive
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpBasicAuthenticator(realm: String)

Abstract Value Members

  1. abstract def authenticate(credentials: BasicUserCredentials): Future[Option[T]]

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 +(other: String): String

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

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

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def authenticateAs(user: T): Future[Option[T]]

    Creates a return value for use in authenticate that successfully authenticates the requests and provides the given user.

  10. implicit def classTag: ClassTag[T]

    Attributes
    protected[akka.http]
    Definition Classes
    HttpBasicAuthenticator → ExtractionImplBase
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. final def createRoute(first: Route, others: Array[Route]): Route

    INTERNAL API

    INTERNAL API

    Attributes
    protected[akka.http]
    Definition Classes
    HttpBasicAuthenticatorAbstractDirective
  13. def ensuring(cond: (HttpBasicAuthenticator[T]) ⇒ Boolean, msg: ⇒ Any): HttpBasicAuthenticator[T]

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from HttpBasicAuthenticator[T] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. def get(ctx: RequestContext): T

    An accessor for the value given the RequestContext.

    An accessor for the value given the RequestContext.

    Note, that some RequestVals need to be actively specified in the route structure to be extracted at a particular point during routing. One example is a PathMatcher that needs to used with a directives.PathDirectives to specify which part of the path should actually be extracted. Another example is an HttpBasicAuthenticator that needs to be used in the route explicitly to be activated.

    Definition Classes
    ExtractionImplBase → RequestVal
  22. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  28. val realm: String

  29. def refuseAccess(): Future[Option[T]]

    Refuses access for this user.

  30. def resultClass: Class[T]

    The runtime type of the extracted value.

    The runtime type of the extracted value.

    Definition Classes
    ExtractionImplBase → RequestVal
  31. def route(first: Route, others: <repeated...>[Route]): Route

    Definition Classes
    AbstractDirectiveDirective
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  33. def toString(): String

    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def [B](y: B): (HttpBasicAuthenticator[T], B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from HttpBasicAuthenticator[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:
    (httpBasicAuthenticator: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from HttpBasicAuthenticator[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:
    (httpBasicAuthenticator: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: HttpBasicAuthenticator[T]

    Implicit information
    This member is added by an implicit conversion from HttpBasicAuthenticator[T] to ArrowAssoc[HttpBasicAuthenticator[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:
    (httpBasicAuthenticator: ArrowAssoc[HttpBasicAuthenticator[T]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: HttpBasicAuthenticator[T]

    Implicit information
    This member is added by an implicit conversion from HttpBasicAuthenticator[T] to Ensuring[HttpBasicAuthenticator[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:
    (httpBasicAuthenticator: Ensuring[HttpBasicAuthenticator[T]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from ExtractionImplBase[T]

Inherited from RequestVal[T]

Inherited from AbstractDirective

Inherited from Directive

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped