Class/Object

securesocial.core.providers

GitHubProvider

Related Docs: object GitHubProvider | package providers

Permalink

class GitHubProvider extends OAuth2Provider

A GitHub provider

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GitHubProvider
  2. OAuth2Provider
  3. IdentityProvider
  4. Registrable
  5. Plugin
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GitHubProvider(application: Application)

    Permalink

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 AccessToken: String

    Permalink
  5. val AvatarUrl: String

    Permalink
  6. val Dot: String

    Permalink
    Definition Classes
    IdentityProvider
  7. val Email: String

    Permalink
  8. val GetAuthenticatedUser: String

    Permalink
  9. val Id: String

    Permalink
  10. val Message: String

    Permalink
  11. val Name: String

    Permalink
  12. val SecureSocialKey: String

    Permalink
    Definition Classes
    IdentityProvider
  13. val TokenType: String

    Permalink
  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  15. def authMethod: AuthenticationMethod

    Permalink

    Subclasses need to implement this to specify the authentication method

    Subclasses need to implement this to specify the authentication method

    Definition Classes
    OAuth2ProviderIdentityProvider
  16. def authenticate[A]()(implicit request: Request[A]): Either[Result, Identity]

    Permalink

    Authenticates the user and fills the profile information.

    Authenticates the user and fills the profile information. Returns either a User if all went ok or a Result that the controller sends to the browser (eg: in the case of OAuth for example where the user needs to be redirected to the service provider)

    Definition Classes
    IdentityProvider
  17. def authenticationUrl: String

    Permalink

    The url for this provider.

    The url for this provider. This is used in the login page template to point each icon to the provider url.

    Definition Classes
    IdentityProvider
  18. def awaitResult(future: Future[WSResponse]): WSResponse

    Permalink
    Attributes
    protected
    Definition Classes
    IdentityProvider
  19. def buildInfo(response: WSResponse): OAuth2Info

    Permalink
    Attributes
    protected
    Definition Classes
    GitHubProviderOAuth2Provider
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def doAuth[A]()(implicit request: Request[A]): Either[Result, SocialUser]

    Permalink

    Subclasses need to implement the authentication logic.

    Subclasses need to implement the authentication logic. This method needs to return a User object that then gets passed to the fillProfile method

    returns

    Either a Result or a User

    Definition Classes
    OAuth2ProviderIdentityProvider
  22. def enabled: Boolean

    Permalink
    Definition Classes
    Plugin
  23. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  25. def fillProfile(user: SocialUser): SocialUser

    Permalink

    Subclasses need to implement this method to populate the User object with profile information from the service provider.

    Subclasses need to implement this method to populate the User object with profile information from the service provider.

    user

    The user object to be populated

    returns

    A copy of the user object with the new values set

    Definition Classes
    GitHubProviderIdentityProvider
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  29. def id: String

    Permalink
    Definition Classes
    GitHubProviderRegistrable
  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  31. def loadProperty(property: String): Option[String]

    Permalink

    Reads a property from the application.conf

    Reads a property from the application.conf

    Definition Classes
    IdentityProvider
  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  35. def onStart(): Unit

    Permalink

    Registers the provider in the Provider Registry

    Registers the provider in the Provider Registry

    Definition Classes
    IdentityProvider → Plugin
  36. def onStop(): Unit

    Permalink

    Unregisters the provider

    Unregisters the provider

    Definition Classes
    IdentityProvider → Plugin
  37. def propertyKey: String

    Permalink

    The property key used for all the provider properties.

    The property key used for all the provider properties.

    Definition Classes
    IdentityProvider
  38. val settings: OAuth2Settings

    Permalink
    Definition Classes
    OAuth2Provider
  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  40. def throwMissingPropertiesException(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    IdentityProvider
  41. def toString(): String

    Permalink

    Returns the provider name

    Returns the provider name

    Definition Classes
    IdentityProvider → AnyRef → Any
  42. final def wait(): Unit

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

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

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

Inherited from OAuth2Provider

Inherited from IdentityProvider

Inherited from Registrable

Inherited from Plugin

Inherited from AnyRef

Inherited from Any

Ungrouped