core

Type Members

1. case class AccessDeniedException() extends Exception with Product with Serializable

   

   An exception thrown when the user denies access to the application in the login page of the 3rd party service

2. case class AuthenticationException() extends Exception with Product with Serializable

   

   An exception thrown when there is an error in the authentication flow

3. case class AuthenticationMethod(method: String) extends Product with Serializable

   

   A class representing an authentication method

4. case class Authenticator(id: String, identityId: IdentityId, creationDate: DateTime, lastUsed: DateTime, expirationDate: DateTime) extends Product with Serializable

   

   An authenticator tracks an authenticated user.

   An authenticator tracks an authenticated user.

   id

   The authenticator id

   identityId

   The user id

   creationDate

   The creation timestamp

   lastUsed

   The last used timestamp

   expirationDate

   The expiration time

5. abstract class AuthenticatorStore extends Plugin

   

   The authenticator store is in charge of persisting authenticators

6. trait Authorization extends AnyRef

   

   A trait to define Authorization objects that let you hook an authorization implementation in SecuredActions

7. class DefaultAuthenticatorStore extends AuthenticatorStore

   

   A default implementation of the AuthenticationStore that uses the Play cache.

   A default implementation of the AuthenticationStore that uses the Play cache. Note: if deploying to multiple nodes the caches will need to synchronize.

8. class DefaultIdGenerator extends IdGenerator

   

   The default id generator

9. sealed trait Event extends AnyRef

   

   A trait to model SecureSocial events

10. abstract class EventListener extends Plugin with Registrable

    

    The event listener interface

11. abstract class IdGenerator extends Plugin

    

    A plugin that generates an authenticator id

12. trait Identity extends AnyRef

    

    This trait represents a user.

    This trait represents a user. Using this trait you can return your own object from the UserService. Find methods if you need to instead of returning a SocialUser.

    In your controller actions you can then convert this Identity to your own class using pattern matching in Scala or a cast in Java.

    Important: your controllers will receive the instance you created, but this won't work the same for the UserService.save method. In that case, SecureSocial will pass an instance created by itself (a SocialUser) so do not try to cast the Identity to your own model within your method implementation.

13. case class IdentityId(userId: String, providerId: String) extends Product with Serializable

    

    The ID of an Identity

    The ID of an Identity

    userId

    the user id on the provider the user came from (eg: twitter, facebook)

    providerId

    the provider used to sign in

14. abstract class IdentityProvider extends Plugin with Registrable

    

    Base class for all Identity Providers.

    Base class for all Identity Providers. All providers are plugins and are loaded automatically at application start time.

15. case class LoginEvent(user: Identity) extends Event with Product with Serializable

    

    The event fired when a users logs in

16. case class LogoutEvent(user: Identity) extends Event with Product with Serializable

    

    The event fired when a user logs out

17. case class OAuth1Info(token: String, secret: String) extends Product with Serializable

    

    The OAuth 1 details

    The OAuth 1 details

    token

    the token

    secret

    the secret

18. abstract class OAuth1Provider extends IdentityProvider

    

    Base class for all OAuth1 providers

19. case class OAuth2Info(accessToken: String, tokenType: Option[String] = None, expiresIn: Option[Int] = None, refreshToken: Option[String] = None) extends Product with Serializable

    

    The Oauth2 details

    The Oauth2 details

    accessToken

    the access token

    tokenType

    the token type

    expiresIn

    the number of seconds before the token expires

    refreshToken

    the refresh token

20. abstract class OAuth2Provider extends IdentityProvider

    

    Base class for all OAuth2 providers

21. case class OAuth2Settings(authorizationUrl: String, accessTokenUrl: String, clientId: String, clientSecret: String, scope: Option[String]) extends Product with Serializable

    

22. case class PasswordChangeEvent(user: Identity) extends Event with Product with Serializable

    

    The event fired when a user changes his password

23. case class PasswordInfo(hasher: String, password: String, salt: Option[String] = None) extends Product with Serializable

    

    The password details

    The password details

    hasher

    the id of the hasher used to hash this password

    password

    the hashed password

    salt

    the optional salt used when hashing

24. case class PasswordResetEvent(user: Identity) extends Event with Product with Serializable

    

    The event fired when a user completes a password reset

25. class PluginRegistry[T <: Registrable] extends AnyRef

    

26. trait Registrable extends AnyRef

    

27. case class RequestWithUser[A](user: Option[Identity], request: Request[A]) extends WrappedRequest[A] with Product with Serializable

    

    A request that adds the User for the current call

28. trait SecureSocial extends Controller

    

    Provides the actions that can be used to protect controllers and retrieve the current user if available.

    Provides the actions that can be used to protect controllers and retrieve the current user if available.

    object MyController extends SecureSocial { def protectedAction = SecuredAction { implicit request => Ok("Hello %s".format(request.user.displayName)) }

29. case class SecuredRequest[A](user: Identity, request: Request[A]) extends WrappedRequest[A] with Product with Serializable

    

    A request that adds the User for the current call

30. case class SignUpEvent(user: Identity) extends Event with Product with Serializable

    

    The event fired when a user sings up with the Username and Password Provider

31. case class SocialUser(identityId: IdentityId, firstName: String, lastName: String, fullName: String, email: Option[String], avatarUrl: Option[String], authMethod: AuthenticationMethod, oAuth1Info: Option[OAuth1Info] = None, oAuth2Info: Option[OAuth2Info] = None, passwordInfo: Option[PasswordInfo] = None) extends Identity with Product with Serializable

    

    An implementation of Identity.

    An implementation of Identity. Used by SecureSocial to gather user information when users sign up and/or sign in.

32. trait UserService extends AnyRef

    

    A trait that provides the means to find and save users for the SecureSocial module.

    A trait that provides the means to find and save users for the SecureSocial module.

    See also

    DefaultUserService

33. abstract class UserServicePlugin extends Plugin with UserService

    

    Base class for the classes that implement 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.