org.agorava.api.oauth

Class OAuthSession.Builder

java.lang.Object

org.agorava.api.oauth.OAuthSession.Builder

Enclosing class:

OAuthSession

public static class OAuthSession.Builder
extends Object

Builder class for OAuthSession

Author:

Antoine Sabot-Durand

Constructor Summary

Constructors

Constructor and Description
OAuthSession.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
OAuthSession.Builder	accessToken(Token accessToken) Set the OAuth Access token for the session
OAuthSession	build() Build the OAuthSession
OAuthSession.Builder	id(String id) Set the id for the session to build.
OAuthSession.Builder	providerName(String providerName) Set the provider qualifier for the session from the provider name
OAuthSession.Builder	qualifier(Annotation qualifier) Set the provider qualifier for the session
OAuthSession.Builder	readFromOAuthSession(OAuthSession session) Configure this builder with an existing OAuthSession.
OAuthSession.Builder	repo(UserSessionRepository repo) Set the User Repository which contains the session to build
OAuthSession.Builder	requestToken(Token requestToken) Set the OAuth Request Token for the session
OAuthSession.Builder	userProfile(UserProfile userProfile) Set the user profile link to the session to build.
OAuthSession.Builder	verifier(String verifier) Set the OAuth Verifier (OAuth 1.0a) or Code (OAuth 2.0a) returned by the provider in the callback

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OAuthSession.Builder

public OAuthSession.Builder()

Method Detail

providerName

public OAuthSession.Builder providerName(String providerName)
                                  throws ProviderMismatchException

Set the provider qualifier for the session from the provider name

Parameters:

providerName - linked to a ProviderRelated qualifier

Returns:

this builder

Throws:

ProviderMismatchException - if parameter is null or if no provider exists for this name

qualifier

public OAuthSession.Builder qualifier(Annotation qualifier)
                               throws ProviderMismatchException

Set the provider qualifier for the session

Parameters:

qualifier - with ProviderRelated meta-annotation

Returns:

this builder

Throws:

ProviderMismatchException - if parameter is null or if no provider exists for this qualifier

requestToken

public OAuthSession.Builder requestToken(Token requestToken)

Set the OAuth Request Token for the session

Parameters:

requestToken - the request Token to set

Returns:

this builder

accessToken

public OAuthSession.Builder accessToken(Token accessToken)

Set the OAuth Access token for the session

Parameters:

accessToken - the access Token to set

Returns:

this builder

verifier

public OAuthSession.Builder verifier(String verifier)

Set the OAuth Verifier (OAuth 1.0a) or Code (OAuth 2.0a) returned by the provider in the callback

Parameters:

verifier - the verifier to set

Returns:

this builder

userProfile

public OAuthSession.Builder userProfile(UserProfile userProfile)

Set the user profile link to the session to build. It's usually added after session creation at the end of OAuth Dance but is provided here to recreate a serialized session

Parameters:

userProfile - the User Profile to set

Returns:

this builder

repo

public OAuthSession.Builder repo(UserSessionRepository repo)

Set the User Repository which contains the session to build

Parameters:

repo - the repository that will contain this session

Returns:

this builder

id

public OAuthSession.Builder id(String id)

Set the id for the session to build.

Parameters:

id - the id to set

Returns:

this builder

readFromOAuthSession

public OAuthSession.Builder readFromOAuthSession(OAuthSession session)

Configure this builder with an existing OAuthSession. Convenient to clone a session or to create an unproxified version of a session

Parameters:

session - the session to read values from

Returns:

this builder

build

public OAuthSession build()

Build the OAuthSession

Returns:

the session we wanted to build