com.mohiva.play.silhouette.impl.providers

OAuth1Provider

Related Docs: object OAuth1Provider | package providers

abstract class OAuth1Provider extends SocialProvider with Logger

Base class for all OAuth1 providers.

Linear Supertypes
Logger, SocialProvider, SocialProfileBuilder, Provider, AnyRef, Any
Known Subclasses
LinkedInProvider, TwitterProvider, XingProvider
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. OAuth1Provider
  2. Logger
  3. SocialProvider
  4. SocialProfileBuilder
  5. Provider
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OAuth1Provider(httpLayer: HTTPLayer, service: OAuth1Service, tokenSecretProvider: OAuth1TokenSecretProvider, settings: OAuth1Settings)

    httpLayer

    The HTTP layer implementation.

    service

    The OAuth1 service implementation.

    tokenSecretProvider

    The OAuth1 token secret provider implementation.

    settings

    The OAuth1 provider settings.

Type Members

  1. type A = OAuth1Info

    The type of the auth info.

    The type of the auth info.

    Definition Classes
    OAuth1Provider → SocialProvider

  2. abstract type Content

    The content type to parse a profile from.

    The content type to parse a profile from.

    Definition Classes
    SocialProfileBuilder

  3. abstract type Profile <: SocialProfile

    The type of the profile a profile builder is responsible for.

    The type of the profile a profile builder is responsible for.

    Definition Classes
    SocialProfileBuilder

Abstract Value Members

  1. abstract def buildProfile(authInfo: A): Future[Profile]

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

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

    authInfo

    The auth info received from the provider.

    returns

    On success the build social profile, otherwise a failure.

    Attributes
    protected
    Definition Classes
    SocialProfileBuilder

  2. abstract def id: String

    Gets the provider ID.

    Gets the provider ID.

    returns

    The provider ID.

    Definition Classes
    Provider

  3. abstract def profileParser: SocialProfileParser[Content, Profile]

    Returns the profile parser implementation.

    Returns the profile parser implementation.

    returns

    The profile parser implementation.

    Attributes
    protected
    Definition Classes
    SocialProfileBuilder

  4. abstract def urls: Map[String, String]

    Gets the URLs that are needed to retrieve the profile data.

    Gets the URLs that are needed to retrieve the profile data.

    Some providers need more than one request to different URLs to query the profile data. So we use a Map here to allow defining multiple URLs.

    returns

    The URLs that are needed to retrieve the profile data.

    Attributes
    protected
    Definition Classes
    SocialProfileBuilder

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[B]()(implicit request: ExtractableRequest[B]): Future[Either[Result, OAuth1Info]]

    Starts the authentication process.

    Starts the authentication process.

    B

    The type of the request body.

    request

    The current request.

    returns

    Either a Result or the auth info from the provider.

    Definition Classes
    OAuth1Provider → SocialProvider

  6. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  13. val logger: Logger

    A named logger instance.

    A named logger instance.

    Definition Classes
    Logger

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

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. def resolveCallbackURL(url: String)(implicit request: RequestHeader): String

    Resolves the url to be absolute relative to the request.

    Resolves the url to be absolute relative to the request.

    This will pass the url through if its already absolute.

    url

    The url to resolve.

    request

    The current request.

    returns

    The absolute url.

    Attributes
    protected
    Definition Classes
    SocialProvider

  18. def retrieveProfile(authInfo: A): Future[Profile]

    Retrieves the user profile for the given auth info.

    Retrieves the user profile for the given auth info.

    This method can be used to retrieve the profile information for an already authenticated identity.

    authInfo

    The auth info for which the profile information should be retrieved.

    returns

    The profile information for the given auth info.

    Definition Classes
    SocialProvider

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

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Logger

Inherited from SocialProvider

Inherited from SocialProfileBuilder

Inherited from Provider

Inherited from AnyRef

Inherited from Any

Ungrouped