Class/Object

securesocial.core

OAuth1Provider

Related Docs: object OAuth1Provider | package core

Permalink

abstract class OAuth1Provider extends IdentityProvider

Base class for all OAuth1 providers

Linear Supertypes
IdentityProvider, Registrable, Plugin, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OAuth1Provider
  2. IdentityProvider
  3. Registrable
  4. Plugin
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OAuth1Provider(application: Application)

    Permalink

Abstract Value Members

  1. abstract 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
    IdentityProvider
  2. abstract def id: String

    Permalink
    Definition Classes
    Registrable

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

    Permalink
    Definition Classes
    IdentityProvider
  5. val SecureSocialKey: String

    Permalink
    Definition Classes
    IdentityProvider
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. 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
    OAuth1ProviderIdentityProvider
  8. 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
  9. 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
  10. def awaitResult(future: Future[WSResponse]): WSResponse

    Permalink
    Attributes
    protected
    Definition Classes
    IdentityProvider
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def createServiceInfo(key: String): ServiceInfo

    Permalink
  13. 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
    OAuth1ProviderIdentityProvider
  14. def enabled: Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Reads a property from the application.conf

    Reads a property from the application.conf

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

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

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

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

    Permalink

    Registers the provider in the Provider Registry

    Registers the provider in the Provider Registry

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

    Permalink

    Unregisters the provider

    Unregisters the provider

    Definition Classes
    IdentityProvider → Plugin
  27. 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
  28. val service: OAuth

    Permalink
  29. val serviceInfo: ServiceInfo

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

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

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

    Permalink

    Returns the provider name

    Returns the provider name

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

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

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

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

Inherited from IdentityProvider

Inherited from Registrable

Inherited from Plugin

Inherited from AnyRef

Inherited from Any

Ungrouped