facebook4j.auth

Interface OAuthSupport

All Known Subinterfaces:

Facebook

All Known Implementing Classes:

FacebookBaseImpl, FacebookImpl, OAuthAuthorization

public interface OAuthSupport

Author:

Ryuji Yamashita - roundrop at gmail.com

Method Summary

Modifier and Type	Method and Description
AccessToken	extendTokenExpiration() Extends this instance's short-lived-token expiration.
AccessToken	extendTokenExpiration(java.lang.String shortLivedToken) Extends the short-lived-token expiration.
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.
void	setOAuthAccessToken(AccessToken accessToken) Sets the access token
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

Method Detail

setOAuthAppId

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

sets the OAuth AppID and App secret

Parameters:

appId - OAuth AppID

appSecret - OAuth App secret

Throws:

java.lang.IllegalStateException - when OAuth AppId has already been set

setOAuthPermissions

void setOAuthPermissions(java.lang.String permissions)

sets the permissions

Parameters:

permissions - comma-separated permission names

See Also:

Permissions Reference

getOAuthAuthorizationURL

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

getOAuthAuthorizationURL

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

getOAuthAuthorizationURL

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

getOAuthReAuthenticationURL

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

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

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

AccessToken getOAuthAccessToken()

Returns an access token associated with this instance.

Returns:

access token

Throws:

java.lang.IllegalStateException - when this instance has no access token

See Also:

Server-Side Authentication

getOAuthAccessToken

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

Exchange the code for a User Access Token.

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

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

Exchange the code for a User Access Token.

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

getOAuthAppAccessToken

AccessToken getOAuthAppAccessToken()
                            throws FacebookException

Returns an App Access Token.

Returns:

App Access Token

Throws:

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

See Also:

Server-Side Authentication

getOAuthDeviceCode

DeviceCode getOAuthDeviceCode()
                       throws FacebookException

Returns a generated device code.

Returns:

Device code

Throws:

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

See Also:

Facebook Login for Devices

getOAuthDeviceToken

AccessToken getOAuthDeviceToken(DeviceCode deviceCode)
                         throws FacebookException

Returns a Device Access Token.

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

setOAuthAccessToken

void setOAuthAccessToken(AccessToken accessToken)

Sets the access token

Parameters:

accessToken - access token

getOAuthCallbackURL

java.lang.String getOAuthCallbackURL()

Sets the access token and callback URL

Returns:

Callback URL

setOAuthCallbackURL

void setOAuthCallbackURL(java.lang.String callbackURL)

Sets the access token

Parameters:

callbackURL - Callback URL

extendTokenExpiration

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

Extends the short-lived-token expiration.

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

AccessToken extendTokenExpiration()
                           throws FacebookException

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

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

getOAuthAccessTokenInfo

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

Returns the access token information.

Parameters:

accessToken - access token

Returns:

access token information

Throws:

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

getOAuthAccessTokenInfo

AccessToken getOAuthAccessTokenInfo()
                             throws FacebookException

Returns the access token information.

Returns:

access token information

Throws:

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