Object/Trait

akka.http.scaladsl.server.directives

SecurityDirectives

Related Docs: trait SecurityDirectives | package directives

Permalink

object SecurityDirectives extends SecurityDirectives

Source
SecurityDirectives.scala
Linear Supertypes
SecurityDirectives, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. SecurityDirectives
  2. SecurityDirectives
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AsyncAuthenticator[T] = (Credentials) ⇒ Future[Option[T]]

    Permalink

    Definition Classes
    SecurityDirectives
  2. type AsyncAuthenticatorPF[T] = PartialFunction[Credentials, Future[T]]

    Permalink

    Definition Classes
    SecurityDirectives
  3. type AuthenticationResult[+T] = Either[HttpChallenge, T]

    Permalink

    The result of an HTTP authentication attempt is either the user object or an HttpChallenge to present to the browser.

    The result of an HTTP authentication attempt is either the user object or an HttpChallenge to present to the browser.

    Definition Classes
    SecurityDirectives
  4. type Authenticator[T] = (Credentials) ⇒ Option[T]

    Permalink

    Definition Classes
    SecurityDirectives
  5. type AuthenticatorPF[T] = PartialFunction[Credentials, T]

    Permalink

    Definition Classes
    SecurityDirectives

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def authenticateBasic[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]

    Permalink

    Wraps the inner route with Http Basic authentication support using a given Authenticator[T].

    Wraps the inner route with Http Basic authentication support using a given Authenticator[T]. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  6. def authenticateBasicAsync[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]

    Permalink

    Wraps the inner route with Http Basic authentication support.

    Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  7. def authenticateBasicPF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]

    Permalink

    A directive that wraps the inner route with Http Basic authentication support.

    A directive that wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  8. def authenticateBasicPFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]

    Permalink

    A directive that wraps the inner route with Http Basic authentication support.

    A directive that wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  9. def authenticateOAuth2[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]

    Permalink

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  10. def authenticateOAuth2Async[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]

    Permalink

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  11. def authenticateOAuth2PF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]

    Permalink

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  12. def authenticateOAuth2PFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]

    Permalink

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support.

    A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.

    Definition Classes
    SecurityDirectives
  13. def authenticateOrRejectWithChallenge[C <: HttpCredentials, T](authenticator: (Option[C]) ⇒ Future[AuthenticationResult[T]])(implicit arg0: ClassTag[C]): AuthenticationDirective[T]

    Permalink

    Lifts an authenticator function into a directive.

    Lifts an authenticator function into a directive. Same as authenticateOrRejectWithChallenge but only applies the authenticator function with a certain type of credentials.

    Definition Classes
    SecurityDirectives
  14. def authenticateOrRejectWithChallenge[T](authenticator: (Option[HttpCredentials]) ⇒ Future[AuthenticationResult[T]]): AuthenticationDirective[T]

    Permalink

    Lifts an authenticator function into a directive.

    Lifts an authenticator function into a directive. The authenticator function gets passed in credentials from the Authorization header of the request. If the function returns Right(user) the user object is provided to the inner route. If the function returns Left(challenge) the request is rejected with an AuthenticationFailedRejection that contains this challenge to be added to the response.

    Definition Classes
    SecurityDirectives
  15. def authorize(check: (RequestContext) ⇒ Boolean): Directive0

    Permalink

    Applies the given authorization check to the request.

    Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  16. def authorize(check: ⇒ Boolean): Directive0

    Permalink

    Applies the given authorization check to the request.

    Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  17. def authorizeAsync(check: (RequestContext) ⇒ Future[Boolean]): Directive0

    Permalink

    Asynchronous version of authorize.

    Asynchronous version of authorize. If the Future fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  18. def authorizeAsync(check: ⇒ Future[Boolean]): Directive0

    Permalink

    Asynchronous version of authorize.

    Asynchronous version of authorize. If the Future fails or is completed with false authorization fails and the route is rejected with an AuthorizationFailedRejection.

    Definition Classes
    SecurityDirectives
  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. def extractCredentials: Directive1[Option[HttpCredentials]]

    Permalink

    Extracts the potentially present HttpCredentials provided with the request's Authorization header.

    Extracts the potentially present HttpCredentials provided with the request's Authorization header.

    Definition Classes
    SecurityDirectives
  23. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]

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

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

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

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SecurityDirectives

Inherited from AnyRef

Inherited from Any

Security directives

Ungrouped