Class

securesocial.core

UserServicePlugin

Related Doc: package core

Permalink

abstract class UserServicePlugin extends Plugin with UserService

Base class for the classes that implement UserService. Since this is a plugin it gets loaded at application start time. Only one plugin of this type must be specified in the play.plugins file.

Linear Supertypes
UserService, Plugin, AnyRef, Any
Known Subclasses
BaseUserService
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UserServicePlugin
  2. UserService
  3. Plugin
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UserServicePlugin(application: Application)

    Permalink

Abstract Value Members

  1. abstract def deleteExpiredTokens(): Unit

    Permalink

    Deletes all expired tokens

    Deletes all expired tokens

    Note: If you do not plan to use the UsernamePassword provider just provide en empty implementation

    Definition Classes
    UserService

  2. abstract def deleteToken(uuid: String): Unit

    Permalink

    Deletes a token

    Deletes a token

    Note: If you do not plan to use the UsernamePassword provider just provide en empty implementation

    uuid

    the token id

    Definition Classes
    UserService

  3. abstract def find(id: IdentityId): Option[Identity]

    Permalink

    Finds a SocialUser that maches the specified id

    Finds a SocialUser that maches the specified id

    id

    the user id

    returns

    an optional user

    Definition Classes
    UserService

  4. abstract def findByEmailAndProvider(email: String, providerId: String): Option[Identity]

    Permalink

    Finds a Social user by email and provider id.

    Finds a Social user by email and provider id.

    Note: If you do not plan to use the UsernamePassword provider just provide en empty implementation.

    email

    - the user email

    providerId

    - the provider id

    Definition Classes
    UserService

  5. abstract def findToken(token: String): Option[Token]

    Permalink

    Finds a token

    Finds a token

    Note: If you do not plan to use the UsernamePassword provider just provide en empty implementation

    token

    the token id

    Definition Classes
    UserService

  6. abstract def save(token: Token): Unit

    Permalink

    Saves a token.

    Saves a token. This is needed for users that are creating an account in the system instead of using one in a 3rd party system.

    Note: If you do not plan to use the UsernamePassword provider just provide en empty implementation

    token

    The token to save

    Definition Classes
    UserService

  7. abstract def save(user: Identity): Identity

    Permalink

    Saves the user.

    Saves the user. This method gets called when a user logs in. This is your chance to save the user information in your backing store.

    Definition Classes
    UserService

Concrete 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. val DefaultInterval: Int

    Permalink

  5. val DeleteIntervalKey: String

    Permalink

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. var cancellable: Option[Cancellable]

    Permalink

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def enabled: Boolean

    Permalink
    Definition Classes
    Plugin

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

    Permalink
    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. def onStart(): Unit

    Permalink

    Registers this object so SecureSocial can invoke it.

    Registers this object so SecureSocial can invoke it.

    Definition Classes
    UserServicePlugin → Plugin

  20. def onStop(): Unit

    Permalink
    Definition Classes
    UserServicePlugin → Plugin

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  23. final def wait(): Unit

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

  24. final def wait(arg0: Long, arg1: Int): Unit

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

  25. final def wait(arg0: Long): Unit

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

Inherited from UserService

Inherited from Plugin

Inherited from AnyRef

Inherited from Any

Ungrouped