abstract class BasicAuthStrategy[UserType <: AnyRef] extends ScentryStrategy[UserType] with RemoteAddress
- Alphabetic
 - By Inheritance
 
- BasicAuthStrategy
 - RemoteAddress
 - ScentryStrategy
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - All
 
Instance Constructors
-  new BasicAuthStrategy(app: ScalatraBase, realm: String)
 
Abstract Value Members
- 
      
      
      
        
      
    
      
        abstract 
        def
      
      
        getUserId(user: UserType)(implicit request: HttpServletRequest, response: HttpServletResponse): String
      
      
      
- Attributes
 - protected
 
 - 
      
      
      
        
      
    
      
        abstract 
        def
      
      
        validate(userName: String, password: String)(implicit request: HttpServletRequest, response: HttpServletResponse): Option[UserType]
      
      
      
- Attributes
 - protected
 
 
Concrete 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
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        afterAuthenticate(winningStrategy: String, user: UserType)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff after authentication only run when the module is valid
Perform stuff after authentication only run when the module is valid
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        afterFetch(user: UserType)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff after fetching and serializing the user from session
Perform stuff after fetching and serializing the user from session
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        afterLogout(user: UserType)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff after logging the user out and invalidating the session
Perform stuff after logging the user out and invalidating the session
- Definition Classes
 - BasicAuthStrategy → ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        afterSetUser(user: UserType)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff after setting the user in the session
Perform stuff after setting the user in the session
- Definition Classes
 - BasicAuthStrategy → ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        val
      
      
        app: ScalatraBase
      
      
      
- Attributes
 - protected
 - Definition Classes
 - BasicAuthStrategy → ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        asInstanceOf[T0]: T0
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        authenticate()(implicit request: HttpServletRequest, response: HttpServletResponse): Option[UserType]
      
      
      
Perform the authentication for this strategy
Perform the authentication for this strategy
- returns
 a UserType option where None indicates auth failure
- Definition Classes
 - BasicAuthStrategy → ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        beforeAuthenticate(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff before authenticating, only run when the module is valid
Perform stuff before authenticating, only run when the module is valid
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        beforeFetch[IdType](userId: IdType)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff before fetching and serializing the user from session
Perform stuff before fetching and serializing the user from session
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        beforeLogout(user: UserType)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff before logging the user out and invalidating the session
Perform stuff before logging the user out and invalidating the session
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        beforeSetUser(user: UserType)(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff before setting the user in the session
Perform stuff before setting the user in the session
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        challenge: String
      
      
      
- Attributes
 - protected
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        clone(): AnyRef
      
      
      
- Attributes
 - protected[java.lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        createStrategy(app: ScalatraBase): BasicAuthStrategy.this.type
      
      
      
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        eq(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        equals(arg0: Any): Boolean
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        finalize(): Unit
      
      
      
- Attributes
 - protected[java.lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws( classOf[java.lang.Throwable] )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        getClass(): Class[_]
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        hashCode(): Int
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        isInstanceOf[T0]: Boolean
      
      
      
- Definition Classes
 - Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        isValid(implicit request: HttpServletRequest): Boolean
      
      
      
Indicates if this strategy should be run.
Indicates if this strategy should be run.
- returns
 a Boolean to indicate validity
- Definition Classes
 - BasicAuthStrategy → ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        name: String
      
      
      
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        ne(arg0: AnyRef): Boolean
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notify(): Unit
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        notifyAll(): Unit
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        registerWith(registrar: Scentry[UserType]): Unit
      
      
      
- Definition Classes
 - ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        remoteAddress(implicit request: HttpServletRequest): String
      
      
      
- Attributes
 - protected
 - Definition Classes
 - RemoteAddress
 
 -  implicit def request2BasicAuthRequest(r: HttpServletRequest): BasicAuthRequest
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        synchronized[T0](arg0: ⇒ T0): T0
      
      
      
- Definition Classes
 - AnyRef
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        toString(): String
      
      
      
- Definition Classes
 - AnyRef → Any
 
 - 
      
      
      
        
      
    
      
        
        def
      
      
        unauthenticated()(implicit request: HttpServletRequest, response: HttpServletResponse): Unit
      
      
      
Perform stuff when the request is unauthenticated and the strategy is valid
Perform stuff when the request is unauthenticated and the strategy is valid
- Definition Classes
 - BasicAuthStrategy → ScentryStrategy
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long, arg1: Int): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )
 
 - 
      
      
      
        
      
    
      
        final 
        def
      
      
        wait(arg0: Long): Unit
      
      
      
- Definition Classes
 - AnyRef
 - Annotations
 - @throws( ... )