jsimple.oauth.oauth

Class OAuth20ServiceImpl

java.lang.Object

jsimple.oauth.oauth.OAuth20ServiceImpl

All Implemented Interfaces:

OAuthService

public class OAuth20ServiceImpl
extends java.lang.Object
implements OAuthService

Constructor Summary

Constructors

Constructor and Description
OAuth20ServiceImpl(DefaultOAuthApi20 api, OAuthConfig config) Default constructor

Method Summary

Modifier and Type	Method and Description
Token	getAccessToken(Token requestToken, Verifier verifier) Retrieve the access token
java.lang.String	getAuthorizationUrl(Token requestToken) Returns the URL where you should redirect your users to authenticate your application.
Token	getRequestToken() Retrieve the request token.
java.lang.String	getVersion() Returns the OAuth version of the service.
Token	refreshAccessToken(Token refreshOrAccessToken, boolean includeSecret) Refresh the access token to extend its expiration date.
void	signRequest(Token accessToken, OAuthRequest request) Signs am OAuth request

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth20ServiceImpl

public OAuth20ServiceImpl(DefaultOAuthApi20 api,
                          OAuthConfig config)

Default constructor

Parameters:

api - OAuth2.0 api information

config - OAuth 2.0 configuration param object

Method Detail

getAccessToken

public Token getAccessToken(@Nullable
                            Token requestToken,
                            Verifier verifier)

Retrieve the access token

Specified by:

getAccessToken in interface OAuthService

Parameters:

requestToken - request token (obtained previously; not required for OAuth 2)

verifier - verifier code

Returns:

access token

refreshAccessToken

public Token refreshAccessToken(Token refreshOrAccessToken,
                                boolean includeSecret)

Refresh the access token to extend its expiration date.

For the token in parameter, Facebook needs the access_token, while Live needs the refresh_token (which can be found only in the Token.getRawResponse() returned by OAuthService.getAccessToken(jsimple.oauth.model.Token, jsimple.oauth.model.Verifier))

As for the client secret, for some providers in some scenarios it's not required. In particular, for Live Connect (taken from http://msdn.microsoft.com/en-us/library/live/hh243647.aspx): "Because apps must also refresh access tokens, the Live Connect app management site allows apps to be marked as mobile client apps. When this marker is specified and the special redirect URL (https://login.live.com/oauth20_desktop.srf) is used, the client secret is not required to refresh the access token.".

Specified by:

refreshAccessToken in interface OAuthService

Parameters:

refreshOrAccessToken - access or refresh token, depending on the OAuth provider

includeSecret - whether or not to include the client secret; Windows Live, for mobile apps, doesn't require it

Returns:

fresh access token

getRequestToken

public Token getRequestToken()

Retrieve the request token.

Specified by:

getRequestToken in interface OAuthService

Returns:

request token

getVersion

public java.lang.String getVersion()

Returns the OAuth version of the service.

Specified by:

getVersion in interface OAuthService

Returns:

oauth version as string

signRequest

public void signRequest(Token accessToken,
                        OAuthRequest request)

Signs am OAuth request

Specified by:

signRequest in interface OAuthService

Parameters:

accessToken - access token (obtained previously)

request - request to sign

getAuthorizationUrl

public java.lang.String getAuthorizationUrl(@Nullable
                                            Token requestToken)

Returns the URL where you should redirect your users to authenticate your application.

Specified by:

getAuthorizationUrl in interface OAuthService

Parameters:

requestToken - the request token you need to authorize; not used for OAuth2

Returns:

the URL where you should redirect your users