com.atomizesoftware.spin.auth.SpinAuthenticationComponent

SpinAuthenticationSupport

trait SpinAuthenticationSupport extends ScentrySupport[AuthenticatedUser] with BasicAuthSupport[AuthenticatedUser]

Self Type
(SpinAuthenticationComponent.this)#SpinAuthenticationSupport with ScalatraBase
Linear Supertypes
BasicAuthSupport[AuthenticatedUser], ScentrySupport[AuthenticatedUser], Initializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpinAuthenticationSupport
  2. BasicAuthSupport
  3. ScentrySupport
  4. Initializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Config extends AnyRef

    Definition Classes
    Initializable
  2. abstract type ConfigT

    Definition Classes
    Initializable
  3. abstract type ScentryConfiguration <: ScentryConfig

    Definition Classes
    ScentrySupport

Abstract Value Members

  1. implicit abstract def configWrapper(config: (SpinAuthenticationSupport.this)#ConfigT): (SpinAuthenticationSupport.this)#Config

    Attributes
    protected
    Definition Classes
    Initializable

Concrete Value Members

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

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

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

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

    Definition Classes
    Any
  5. def authenticate()(implicit request: HttpServletRequest, response: HttpServletResponse): Option[AuthenticatedUser]

    Attributes
    protected
    Definition Classes
    ScentrySupport
  6. def authenticateOnLocations(statusCode: Int = 403, haltResponse: Any = None): UserLocations

    Checks if the user has locations associated and if not halts the procedure.

    Checks if the user has locations associated and if not halts the procedure.

    returns

    a UserLocation that has the seesAll boolean and a list of location ids.

  7. def basicAuth()(implicit request: HttpServletRequest, response: HttpServletResponse): Option[AuthenticatedUser]

    Checks if the user can be authenticated through basic http authentication.

    Checks if the user can be authenticated through basic http authentication.

    Checks if the request has basic authentication headers and if it is a basic auth request. If not, halts the processing of the request and returns an error response. If the request supports basic auth, it is tried.

    Attributes
    protected
    Definition Classes
    SpinAuthenticationSupport → BasicAuthSupport
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def configureScentry(): Unit

    Attributes
    protected
    Definition Classes
    SpinAuthenticationSupport → ScentrySupport
  10. implicit def currentUser: AuthenticatedUser

    Gets the username from the authenticated user.

  11. def currentUserId: Long

    Gets the id from the authenticated user.

  12. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  14. def existsInUserLocations(locationId: Option[Long]): Boolean

  15. def existsInUserLocations(locationId: Long): Boolean

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def findTopMostLocationForUser: Option[Long]

    Tries to find a top most location for the current user.

    Tries to find a top most location for the current user.

    If the user can see all locations, None is returned If the user has locations we search for a top most location and return its id.

    returns

    a Long if a top most location was found for the user, None otherwise.

  18. def fromSession: PartialFunction[String, AuthenticatedUser]

    Defines how to get a user from a session by its id.

    Defines how to get a user from a session by its id.

    Attributes
    protected
    Definition Classes
    SpinAuthenticationSupport → ScentrySupport
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def haltIfUserIsNotAllowedIn(locationId: Option[Long]): Unit

    Checks if the user has a particular location id within the one he/she can see.

    Checks if the user has a particular location id within the one he/she can see.

    If the user can see all locations, nothing is done. Otherwise we search for the location id within the user locations.

    returns

    403 with error response if user doesn't have the required location.

  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. def initialize(config: (SpinAuthenticationSupport.this)#ConfigT): Unit

    Definition Classes
    ScentrySupport → Initializable
  23. def isAnonymous(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    ScentrySupport
  24. def isAuthenticated(implicit request: HttpServletRequest): Boolean

    Attributes
    protected
    Definition Classes
    ScentrySupport
  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. def logOut()(implicit request: HttpServletRequest, response: HttpServletResponse): Unit

    Attributes
    protected
    Definition Classes
    ScentrySupport
  27. val logger: Logger

  28. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  31. implicit val onlyFormats: Formats

    Attributes
    protected
  32. val realm: String

    Definition Classes
    SpinAuthenticationSupport → BasicAuthSupport
  33. def registerAuthStrategies(): Unit

    Attributes
    protected
    Definition Classes
    SpinAuthenticationSupport → ScentrySupport
  34. def requirePermission(permission: String): Unit

    Gets the current user and checks if he has permission to do the specified action.

    Gets the current user and checks if he has permission to do the specified action.

    permission

    that needs to be in the user permissions list.

    returns

    403 with error response if user doesn't have the required permission.

  35. def scentry(implicit request: HttpServletRequest): Scentry[AuthenticatedUser]

    Attributes
    protected
    Definition Classes
    ScentrySupport
  36. val scentryConfig: (SpinAuthenticationSupport.this)#ScentryConfiguration

    Attributes
    protected
    Definition Classes
    SpinAuthenticationSupport → ScentrySupport
  37. def scentryOption(implicit request: HttpServletRequest): Option[Scentry[AuthenticatedUser]]

    Attributes
    protected
    Definition Classes
    ScentrySupport
  38. def seesAllLocations(user: User): Boolean

    Checks if the current user is able to see all locations based on its groups.

    Checks if the current user is able to see all locations based on its groups.

    returns

    true if it is able to see all locations, false otherwise

  39. def shutdown(): Unit

    Attributes
    protected
    Definition Classes
    Initializable
  40. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  41. def toSession: PartialFunction[AuthenticatedUser, String]

    Defines how to register a user in a session, only keeping its id.

    Defines how to register a user in a session, only keeping its id.

    Attributes
    protected
    Definition Classes
    SpinAuthenticationSupport → ScentrySupport
  42. def toString(): String

    Definition Classes
    AnyRef → Any
  43. implicit def user(implicit request: HttpServletRequest): AuthenticatedUser

    Attributes
    protected
    Definition Classes
    ScentrySupport
  44. def userOption(implicit request: HttpServletRequest): Option[AuthenticatedUser]

    Attributes
    protected
    Definition Classes
    ScentrySupport
  45. def user_=(user: AuthenticatedUser)(implicit request: HttpServletRequest): String

    Attributes
    protected
    Definition Classes
    ScentrySupport
  46. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BasicAuthSupport[AuthenticatedUser]

Inherited from ScentrySupport[AuthenticatedUser]

Inherited from Initializable

Inherited from AnyRef

Inherited from Any

Ungrouped