facebook4j.auth

Class OAuthAuthorization

java.lang.Object

facebook4j.auth.OAuthAuthorization

All Implemented Interfaces:

Authorization, OAuthSupport, Security, java.io.Serializable

public class OAuthAuthorization
extends java.lang.Object
implements Authorization, OAuthSupport, Security, java.io.Serializable

Author:

Ryuji Yamashita - roundrop at gmail.com

See Also:

OAuth Core 1.0a, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	appId
private java.lang.String	appSecret
private facebook4j.internal.util.z_F4JLRUCache<java.lang.String,java.lang.String>	appSecretProofCache
private boolean	appSecretProofEnabled
private java.lang.String	callbackURL
private Configuration	conf
static java.lang.String	HMAC_SHA_256
private static facebook4j.internal.http.HttpClientWrapper	http
private static facebook4j.internal.logging.Logger	logger
private AccessToken	oauthToken
private java.lang.String	permissions
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
OAuthAuthorization(Configuration conf)

Method Summary

Modifier and Type	Method and Description
private void	ensureTokenIsAvailable()
boolean	equals(java.lang.Object obj)
AccessToken	extendTokenExpiration() Extends this instance's short-lived-token expiration.
AccessToken	extendTokenExpiration(java.lang.String shortLivedToken) Extends the short-lived-token expiration.
java.lang.String	generateAppSecretProof() Computes a appsecret_proof value using the HMAC method.
protected java.lang.String	getAccessTokenInfoURL(java.lang.String accessToken)
private java.lang.String	getAppAccessTokenURL()
private java.lang.String	getDeviceCodeURL()
private java.lang.String	getDeviceTokenURL(java.lang.String deviceCode)
protected java.lang.String	getExchangeAccessTokenURL(java.lang.String oauthCode)
protected java.lang.String	getExtendTokenURL(java.lang.String shortLivedToken)
AccessToken	getOAuthAccessToken() Returns an access token associated with this instance.
AccessToken	getOAuthAccessToken(java.lang.String oauthCode) Exchange the code for a User Access Token.
AccessToken	getOAuthAccessToken(java.lang.String oauthCode, java.lang.String callbackURL) Exchange the code for a User Access Token.
AccessToken	getOAuthAccessTokenInfo() Returns the access token information.
AccessToken	getOAuthAccessTokenInfo(java.lang.String accessToken) Returns the access token information.
AccessToken	getOAuthAppAccessToken() Returns an App Access Token.
java.lang.String	getOAuthAuthorizationURL(java.lang.String callbackURL)
java.lang.String	getOAuthAuthorizationURL(java.lang.String callbackURL, AuthOption authOption)
java.lang.String	getOAuthAuthorizationURL(java.lang.String callbackURL, java.lang.String state)
java.lang.String	getOAuthCallbackURL() Sets the access token and callback URL
DeviceCode	getOAuthDeviceCode() Returns a generated device code.
AccessToken	getOAuthDeviceToken(DeviceCode deviceCode) Returns a Device Access Token.
java.lang.String	getOAuthReAuthenticationURL(java.lang.String callbackURL, java.lang.String nonce) Returns the URL that asks the person to re-authenticate unconditionally.
int	hashCode()
boolean	isAppSecretProofEnabled()
boolean	isEnabled() #{inheritDoc}
void	setAppSecretProofEnabled(boolean enabled)
void	setOAuthAccessToken(AccessToken accessToken) Sets the access token
void	setOAuthAccessToken(AccessToken accessToken, java.lang.String callbackURL)
void	setOAuthAppId(java.lang.String appId, java.lang.String appSecret) sets the OAuth AppID and App secret
void	setOAuthCallbackURL(java.lang.String callbackURL) Sets the access token
void	setOAuthPermissions(java.lang.String permissions) sets the permissions
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

logger

private static final facebook4j.internal.logging.Logger logger

HMAC_SHA_256

public static final java.lang.String HMAC_SHA_256

See Also:

Constant Field Values

conf

private final Configuration conf

http

private static transient facebook4j.internal.http.HttpClientWrapper http

appId

private java.lang.String appId

appSecret

private java.lang.String appSecret

oauthToken

private AccessToken oauthToken

permissions

private java.lang.String permissions

callbackURL

private java.lang.String callbackURL

appSecretProofEnabled

private boolean appSecretProofEnabled

appSecretProofCache

private transient facebook4j.internal.util.z_F4JLRUCache<java.lang.String,java.lang.String> appSecretProofCache

Constructor Detail

OAuthAuthorization

public OAuthAuthorization(Configuration conf)

Parameters:

conf - Configuration

Method Detail

ensureTokenIsAvailable

private void ensureTokenIsAvailable()

isEnabled

public boolean isEnabled()

#{inheritDoc}

Specified by:

isEnabled in interface Authorization

Returns:

true if authorization credentials are set

getOAuthAuthorizationURL

public java.lang.String getOAuthAuthorizationURL(java.lang.String callbackURL)

Specified by:

getOAuthAuthorizationURL in interface OAuthSupport

getOAuthAuthorizationURL

public java.lang.String getOAuthAuthorizationURL(java.lang.String callbackURL,
                                                 java.lang.String state)

Specified by:

getOAuthAuthorizationURL in interface OAuthSupport

getOAuthAuthorizationURL

public java.lang.String getOAuthAuthorizationURL(java.lang.String callbackURL,
                                                 AuthOption authOption)

Specified by:

getOAuthAuthorizationURL in interface OAuthSupport

getOAuthReAuthenticationURL

public java.lang.String getOAuthReAuthenticationURL(java.lang.String callbackURL,
                                                    java.lang.String nonce)

Description copied from interface: OAuthSupport

Returns the URL that asks the person to re-authenticate unconditionally.

Specified by:

getOAuthReAuthenticationURL in interface OAuthSupport

Parameters:

callbackURL - callback url

nonce - a completely arbitrary alphanumeric code that your app generates. see: The auth_nonce parameter

Returns:

the url for re-authenticate

See Also:

Re-authentication - Facebook Login

getOAuthAccessToken

public AccessToken getOAuthAccessToken(java.lang.String oauthCode)
                                throws FacebookException

Description copied from interface: OAuthSupport

Exchange the code for a User Access Token.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Parameters:

oauthCode - OAuth code.

Returns:

User Access Token

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

See Also:

Server-Side Authentication

getOAuthAccessToken

public AccessToken getOAuthAccessToken(java.lang.String oauthCode,
                                       java.lang.String callbackURL)
                                throws FacebookException

Description copied from interface: OAuthSupport

Exchange the code for a User Access Token.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Parameters:

oauthCode - OAuth code.

callbackURL - callback URL

Returns:

User Access Token

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

See Also:

Server-Side Authentication

getExchangeAccessTokenURL

protected java.lang.String getExchangeAccessTokenURL(java.lang.String oauthCode)

getOAuthAccessToken

public AccessToken getOAuthAccessToken()

Description copied from interface: OAuthSupport

Returns an access token associated with this instance.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Returns:

access token

See Also:

Server-Side Authentication

getOAuthAppAccessToken

public AccessToken getOAuthAppAccessToken()
                                   throws FacebookException

Description copied from interface: OAuthSupport

Returns an App Access Token.

Specified by:

getOAuthAppAccessToken in interface OAuthSupport

Returns:

App Access Token

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

See Also:

Server-Side Authentication

getAppAccessTokenURL

private java.lang.String getAppAccessTokenURL()

getOAuthDeviceCode

public DeviceCode getOAuthDeviceCode()
                              throws FacebookException

Description copied from interface: OAuthSupport

Returns a generated device code.

Specified by:

getOAuthDeviceCode in interface OAuthSupport

Returns:

Device code

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

See Also:

Facebook Login for Devices

getDeviceCodeURL

private java.lang.String getDeviceCodeURL()

getOAuthDeviceToken

public AccessToken getOAuthDeviceToken(DeviceCode deviceCode)
                                throws FacebookException

Description copied from interface: OAuthSupport

Returns a Device Access Token.

Specified by:

getOAuthDeviceToken in interface OAuthSupport

Returns:

Device Acceess Token

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

See Also:

Facebook Login for Devices

getDeviceTokenURL

private java.lang.String getDeviceTokenURL(java.lang.String deviceCode)

setOAuthAccessToken

public void setOAuthAccessToken(AccessToken accessToken)

Description copied from interface: OAuthSupport

Sets the access token

Specified by:

setOAuthAccessToken in interface OAuthSupport

Parameters:

accessToken - access token

setOAuthAccessToken

public void setOAuthAccessToken(AccessToken accessToken,
                                java.lang.String callbackURL)

getOAuthCallbackURL

public java.lang.String getOAuthCallbackURL()

Description copied from interface: OAuthSupport

Sets the access token and callback URL

Specified by:

getOAuthCallbackURL in interface OAuthSupport

Returns:

Callback URL

setOAuthCallbackURL

public void setOAuthCallbackURL(java.lang.String callbackURL)

Description copied from interface: OAuthSupport

Sets the access token

Specified by:

setOAuthCallbackURL in interface OAuthSupport

Parameters:

callbackURL - Callback URL

setOAuthAppId

public void setOAuthAppId(java.lang.String appId,
                          java.lang.String appSecret)

Description copied from interface: OAuthSupport

sets the OAuth AppID and App secret

Specified by:

setOAuthAppId in interface OAuthSupport

Parameters:

appId - OAuth AppID

appSecret - OAuth App secret

setOAuthPermissions

public void setOAuthPermissions(java.lang.String permissions)

Description copied from interface: OAuthSupport

sets the permissions

Specified by:

setOAuthPermissions in interface OAuthSupport

Parameters:

permissions - comma-separated permission names

See Also:

Permissions Reference

extendTokenExpiration

public AccessToken extendTokenExpiration(java.lang.String shortLivedToken)
                                  throws FacebookException

Description copied from interface: OAuthSupport

Extends the short-lived-token expiration.

Specified by:

extendTokenExpiration in interface OAuthSupport

Parameters:

shortLivedToken - access token

Returns:

extended access token

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

See Also:

Expiration and Extension of Access Tokens - Facebook Login

extendTokenExpiration

public AccessToken extendTokenExpiration()
                                  throws FacebookException

Description copied from interface: OAuthSupport

Extends this instance's short-lived-token expiration.

Specified by:

extendTokenExpiration in interface OAuthSupport

Returns:

extended access token

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

See Also:

Expiration and Extension of Access Tokens - Facebook Login

getExtendTokenURL

protected java.lang.String getExtendTokenURL(java.lang.String shortLivedToken)

getOAuthAccessTokenInfo

public AccessToken getOAuthAccessTokenInfo(java.lang.String accessToken)
                                    throws FacebookException

Description copied from interface: OAuthSupport

Returns the access token information.

Specified by:

getOAuthAccessTokenInfo in interface OAuthSupport

Parameters:

accessToken - access token

Returns:

access token information

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

getOAuthAccessTokenInfo

public AccessToken getOAuthAccessTokenInfo()
                                    throws FacebookException

Description copied from interface: OAuthSupport

Returns the access token information.

Specified by:

getOAuthAccessTokenInfo in interface OAuthSupport

Returns:

access token information

Throws:

FacebookException - when Facebook service or network is unavailable, or the user has not authorized

getAccessTokenInfoURL

protected java.lang.String getAccessTokenInfoURL(java.lang.String accessToken)

setAppSecretProofEnabled

public void setAppSecretProofEnabled(boolean enabled)

isAppSecretProofEnabled

public boolean isAppSecretProofEnabled()

Specified by:

isAppSecretProofEnabled in interface Security

generateAppSecretProof

public java.lang.String generateAppSecretProof()

Computes a appsecret_proof value using the HMAC method.

Specified by:

generateAppSecretProof in interface Security

Returns:

appsecret_proof

See Also:

Verifying Graph API Calls with appsecret_proof

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object