facebook4j

Class FacebookBaseImpl

java.lang.Object

facebook4j.FacebookBaseImpl

All Implemented Interfaces:

OAuthSupport, java.io.Serializable

Direct Known Subclasses:

FacebookImpl

abstract class FacebookBaseImpl
extends java.lang.Object
implements java.io.Serializable, OAuthSupport

Base class of Facebook supports OAuth.

Author:

Ryuji Yamashita - roundrop at gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
protected Authorization	auth
protected Configuration	conf
protected facebook4j.internal.json.z_F4JInternalFactory	factory
protected facebook4j.internal.http.HttpClientWrapper	http
protected java.lang.String	id
protected java.lang.String	name
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
FacebookBaseImpl(Configuration conf, Authorization auth)

Method Summary

Modifier and Type	Method and Description
protected void	ensureAuthorizationEnabled()
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.
protected void	fillInIDAndName()
Authorization	getAuthorization()
Configuration	getConfiguration()
java.lang.String	getId()
java.lang.String	getName()
private OAuthSupport	getOAuth()
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()
private void	init()
private void	readObject(java.io.ObjectInputStream stream)
protected void	setFactory()
protected void	setHttp()
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
void	shutdown()
java.lang.String	toString()
private void	writeObject(java.io.ObjectOutputStream out)

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

http

protected transient facebook4j.internal.http.HttpClientWrapper http

factory

protected facebook4j.internal.json.z_F4JInternalFactory factory

conf

protected Configuration conf

auth

protected Authorization auth

id

protected transient java.lang.String id

name

protected transient java.lang.String name

Constructor Detail

FacebookBaseImpl

FacebookBaseImpl(Configuration conf,
                 Authorization auth)

Method Detail

init

private void init()

setHttp

protected void setHttp()

setFactory

protected void setFactory()

getId

public java.lang.String getId()
                       throws FacebookException,
                              java.lang.IllegalStateException

Throws:

FacebookException

java.lang.IllegalStateException

getName

public java.lang.String getName()
                         throws FacebookException,
                                java.lang.IllegalStateException

Throws:

FacebookException

java.lang.IllegalStateException

fillInIDAndName

protected void fillInIDAndName()
                        throws FacebookException

Throws:

FacebookException

getAuthorization

public final Authorization getAuthorization()

getConfiguration

public Configuration getConfiguration()

shutdown

public void shutdown()

ensureAuthorizationEnabled

protected final void ensureAuthorizationEnabled()

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream stream)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

setOAuthAppId

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

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)

sets the permissions

Specified by:

setOAuthPermissions in interface OAuthSupport

Parameters:

permissions - comma-separated permission names

See Also:

Permissions Reference

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()

Returns an access token associated with this instance.

Specified by:

getOAuthAccessToken in interface OAuthSupport

Returns:

access token

See Also:

Server-Side Authentication

getOAuthAccessToken

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

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

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

getOAuthAppAccessToken

public AccessToken getOAuthAppAccessToken()
                                   throws FacebookException

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

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

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

setOAuthAccessToken

public void setOAuthAccessToken(AccessToken accessToken)

Sets the access token

Specified by:

setOAuthAccessToken in interface OAuthSupport

Parameters:

accessToken - access token

getOAuthCallbackURL

public java.lang.String getOAuthCallbackURL()

Sets the access token and callback URL

Specified by:

getOAuthCallbackURL in interface OAuthSupport

Returns:

Callback URL

setOAuthCallbackURL

public void setOAuthCallbackURL(java.lang.String callbackURL)

Sets the access token

Specified by:

setOAuthCallbackURL in interface OAuthSupport

Parameters:

callbackURL - Callback URL

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

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

getOAuth

private OAuthSupport getOAuth()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object