OAuth2Provider

Type Members

type A = OAuth2Info

The type of the auth info.
The type of the auth info.

Definition Classes
OAuth2Provider → SocialProvider
abstract type Content

The content type to parse a profile from.
The content type to parse a profile from.

Definition Classes
SocialProfileBuilder
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 type Self <: SocialProvider

The type of the concrete implementation of this abstract type.
The type of the concrete implementation of this abstract type.

Definition Classes
SocialProvider
type Settings = OAuth2Settings

The settings type.
The settings type.

Definition Classes
OAuth2Provider → SocialProvider

Abstract Value Members

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
abstract val httpLayer: HTTPLayer

The HTTP layer implementation.
The HTTP layer implementation.

Attributes
protected
Definition Classes
SocialProvider
abstract def id: String

Gets the provider ID.
Gets the provider ID.
returns
The provider ID.

Definition Classes
Provider
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
abstract def settings: Settings

Gets the provider settings.
Gets the provider settings.
returns
The provider settings.

Definition Classes
SocialProvider
abstract val stateProvider: OAuth2StateProvider

The state provider implementation.
The state provider implementation.

Attributes
protected
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
abstract def withSettings(f: (Settings) ⇒ Settings): Self

Gets a provider initialized with a new settings object.
Gets a provider initialized with a new settings object.
f
A function which gets the settings passed and returns different settings.
returns
An instance of the provider initialized with new settings.

Definition Classes
SocialProvider

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def authenticate[B]()(implicit request: ExtractableRequest[B]): Future[Either[Result, OAuth2Info]]

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
OAuth2Provider → SocialProvider
def buildInfo(response: WSResponse): Try[OAuth2Info]

Builds the OAuth2 info from response.
Builds the OAuth2 info from response.
response
The response from the provider.
returns
The OAuth2 info on success, otherwise a failure.

Attributes
protected
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit val executionContext: ExecutionContext

The execution context to handle the asynchronous operations.
The execution context to handle the asynchronous operations.

Definition Classes
SocialProvider → ExecutionContextProvider
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getAccessToken(code: String)(implicit request: RequestHeader): Future[OAuth2Info]

Gets the access token.
Gets the access token.
code
The access code.
request
The current request.
returns
The info containing the access token.

Attributes
protected
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val headers: Seq[(String, String)]

A list with headers to send to the API.
A list with headers to send to the API.

Attributes
protected
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val logger: Logger

A named logger instance.
A named logger instance.

Definition Classes
Logger
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object OAuth2Provider | package providers

trait OAuth2Provider extends SocialProvider with Logger

Type Members

type A = OAuth2Info

abstract type Content

abstract type Profile <: SocialProfile

abstract type Self <: SocialProvider

type Settings = OAuth2Settings

Abstract Value Members

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

abstract val httpLayer: HTTPLayer

abstract def id: String

abstract def profileParser: SocialProfileParser[Content, Profile]

abstract def settings: Settings

abstract val stateProvider: OAuth2StateProvider

abstract def urls: Map[String, String]

abstract def withSettings(f: (Settings) ⇒ Settings): Self

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def authenticate[B]()(implicit request: ExtractableRequest[B]): Future[Either[Result, OAuth2Info]]

def buildInfo(response: WSResponse): Try[OAuth2Info]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit val executionContext: ExecutionContext

def finalize(): Unit

def getAccessToken(code: String)(implicit request: RequestHeader): Future[OAuth2Info]

final def getClass(): Class[_]

def hashCode(): Int

val headers: Seq[(String, String)]

final def isInstanceOf[T0]: Boolean

val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

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

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Logger

Inherited from SocialProvider

Inherited from ExecutionContextProvider

Inherited from SocialProfileBuilder

Inherited from Provider

Inherited from AnyRef

Inherited from Any

Ungrouped