org.apache.pekko.http.scaladsl.server.directives
SecurityDirectives
Companion trait SecurityDirectives
object SecurityDirectives extends SecurityDirectives
- Source
- SecurityDirectives.scala
- Grouped
- Alphabetic
- By Inheritance
- SecurityDirectives
- SecurityDirectives
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
-    type AsyncAuthenticator[T] = (Credentials) => Future[Option[T]]- Definition Classes
- SecurityDirectives
 
-    type AsyncAuthenticatorPF[T] = PartialFunction[Credentials, Future[T]]- Definition Classes
- SecurityDirectives
 
-    type AuthenticationResult[+T] = Either[HttpChallenge, T]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
 
-    type Authenticator[T] = (Credentials) => Option[T]- Definition Classes
- SecurityDirectives
 
-    type AuthenticatorPF[T] = PartialFunction[Credentials, T]- Definition Classes
- SecurityDirectives
 
Value Members
-   final  def !=(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def ##: Int- Definition Classes
- AnyRef → Any
 
-   final  def ==(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def asInstanceOf[T0]: T0- Definition Classes
- Any
 
-    def authenticateBasic[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]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
 
-    def authenticateBasicAsync[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]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
 
-    def authenticateBasicPF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]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
 
-    def authenticateBasicPFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]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
 
-    def authenticateOAuth2[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]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
 
-    def authenticateOAuth2Async[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]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
 
-    def authenticateOAuth2PF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]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
 
-    def authenticateOAuth2PFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]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
 
-    def authenticateOrRejectWithChallenge[C <: HttpCredentials, T](authenticator: (Option[C]) => Future[AuthenticationResult[T]])(implicit arg0: ClassTag[C]): AuthenticationDirective[T]Lifts an authenticator function into a directive. Lifts an authenticator function into a directive. Same as authenticateOrRejectWithChallengebut only applies the authenticator function with a certain type of credentials.- Definition Classes
- SecurityDirectives
 
-    def authenticateOrRejectWithChallenge[T](authenticator: (Option[HttpCredentials]) => Future[AuthenticationResult[T]]): AuthenticationDirective[T]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 returnsLeft(challenge)the request is rejected with an AuthenticationFailedRejection that contains this challenge to be added to the response.- Definition Classes
- SecurityDirectives
 
-    def authorize(check: (RequestContext) => Boolean): Directive0Applies 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
 
-    def authorize(check: => Boolean): Directive0Applies 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
 
-    def authorizeAsync(check: (RequestContext) => Future[Boolean]): Directive0Asynchronous version of authorize. Asynchronous version of authorize. If the Future fails or is completed with falseauthorization fails and the route is rejected with an AuthorizationFailedRejection.- Definition Classes
- SecurityDirectives
 
-    def authorizeAsync(check: => Future[Boolean]): Directive0Asynchronous version of authorize. Asynchronous version of authorize. If the Future fails or is completed with falseauthorization fails and the route is rejected with an AuthorizationFailedRejection.- Definition Classes
- SecurityDirectives
 
-    def clone(): AnyRef- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
 
-   final  def eq(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-    def equals(arg0: AnyRef): Boolean- Definition Classes
- AnyRef → Any
 
-    def extractCredentials: Directive1[Option[HttpCredentials]]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
 
-    def finalize(): Unit- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
 
-   final  def getClass(): Class[_ <: AnyRef]- Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
-    def hashCode(): Int- Definition Classes
- AnyRef → Any
- Annotations
- @native()
 
-   final  def isInstanceOf[T0]: Boolean- Definition Classes
- Any
 
-   final  def ne(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-   final  def notify(): Unit- Definition Classes
- AnyRef
- Annotations
- @native()
 
-   final  def notifyAll(): Unit- Definition Classes
- AnyRef
- Annotations
- @native()
 
-   final  def synchronized[T0](arg0: => T0): T0- Definition Classes
- AnyRef
 
-    def toString(): String- Definition Classes
- AnyRef → Any
 
-   final  def wait(): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
-   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()