org.gatein.security.oauth.facebook

Class GateInFacebookProcessorImpl

java.lang.Object

org.gatein.security.oauth.facebook.GateInFacebookProcessorImpl

All Implemented Interfaces:

GateInFacebookProcessor, OAuthProviderProcessor<FacebookAccessTokenContext>

public class GateInFacebookProcessorImpl
extends Object
implements GateInFacebookProcessor

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor and Description
GateInFacebookProcessorImpl(org.exoplatform.container.ExoContainerContext context, org.exoplatform.container.xml.InitParams params, SecureRandomService secureRandomService)

Method Summary

Methods

Modifier and Type	Method and Description
FacebookAccessTokenContext	getAccessTokenFromUserProfile(org.exoplatform.services.organization.UserProfile userProfile, OAuthCodec codec) Obtain needed data from given userProfile and create accessToken from them
<C> C	getAuthorizedSocialApiObject(FacebookAccessTokenContext accessToken, Class<C> socialApiObjectType) Return object, which can be used to call some operations on this Social network.
String	getAvatar(FacebookAccessTokenContext accessTokenContext)
FacebookPrincipal	getPrincipal(FacebookAccessTokenContext accessTokenContext) Obtain informations about user from Facebook and wrap them into FacebookPrincipal object
InteractionState<FacebookAccessTokenContext>	processOAuthInteraction(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Process OAuth workflow for this OAuth provider (social network).
InteractionState<FacebookAccessTokenContext>	processOAuthInteraction(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String scope) Possibility to create new OAuth interaction with custom scope (not just the scope which is provided in configuration of this OAuth processor)
protected InteractionState<FacebookAccessTokenContext>	processOAuthInteractionImpl(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, FacebookProcessor facebookProcessor)
void	removeAccessTokenFromUserProfile(org.exoplatform.services.organization.UserProfile userProfile) Remove data about access token from this user profile
void	revokeToken(FacebookAccessTokenContext accessToken) Revoke given access token on OAuth provider side, so application is removed from list of supported applications for given user
void	saveAccessTokenAttributesToUserProfile(org.exoplatform.services.organization.UserProfile userProfile, OAuthCodec codec, FacebookAccessTokenContext accessTokenContext) Save accessToken data to given userProfile.
FacebookAccessTokenContext	validateTokenAndUpdateScopes(FacebookAccessTokenContext accessToken) Send request to OAuth Provider to validate if given access token is valid and ask for scopes, which are available for given accessToken.

Methods inherited from class java.lang.Object

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

Constructor Detail

GateInFacebookProcessorImpl

public GateInFacebookProcessorImpl(org.exoplatform.container.ExoContainerContext context,
                           org.exoplatform.container.xml.InitParams params,
                           SecureRandomService secureRandomService)

Method Detail

processOAuthInteraction

public InteractionState<FacebookAccessTokenContext> processOAuthInteraction(javax.servlet.http.HttpServletRequest httpRequest,
                                                                   javax.servlet.http.HttpServletResponse httpResponse,
                                                                   String scope)
                                                                     throws IOException

Description copied from interface: OAuthProviderProcessor

Possibility to create new OAuth interaction with custom scope (not just the scope which is provided in configuration of this OAuth processor)

Specified by:

processOAuthInteraction in interface OAuthProviderProcessor<FacebookAccessTokenContext>

scope - custom scope, which contains all scopes in single String divided by AccessTokenContext.DELIMITER

Returns:

Throws:

IOException

See Also:

#processOAuthInteraction(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)}

processOAuthInteraction

public InteractionState<FacebookAccessTokenContext> processOAuthInteraction(javax.servlet.http.HttpServletRequest httpRequest,
                                                                   javax.servlet.http.HttpServletResponse httpResponse)
                                                                     throws IOException

Description copied from interface: OAuthProviderProcessor

Process OAuth workflow for this OAuth provider (social network). Workflow is finished if returned InteractionState is in state InteractionState.State.FINISH and in this case, InteractionState should also have accessToken filled. If InteractionState is in state InteractionState.State.AUTH, then more redirections are needed. In this case, given HttpServletResponse should be already committed and prepared for redirection.

Specified by:

processOAuthInteraction in interface OAuthProviderProcessor<FacebookAccessTokenContext>

Returns:

InteractionState with state of OAuth interaction

Throws:

IOException - if IO error occured (for example if httpResponse.sendRedirect failed)

processOAuthInteractionImpl

protected InteractionState<FacebookAccessTokenContext> processOAuthInteractionImpl(javax.servlet.http.HttpServletRequest httpRequest,
                                                                       javax.servlet.http.HttpServletResponse httpResponse,
                                                                       FacebookProcessor facebookProcessor)
                                                                            throws IOException

Throws:

IOException

getPrincipal

public FacebookPrincipal getPrincipal(FacebookAccessTokenContext accessTokenContext)

Description copied from interface: GateInFacebookProcessor

Obtain informations about user from Facebook and wrap them into FacebookPrincipal object

Specified by:

getPrincipal in interface GateInFacebookProcessor

Parameters:

accessTokenContext - Facebook access token

Returns:

FacebookPrincipal

getAvatar

public String getAvatar(FacebookAccessTokenContext accessTokenContext)

Specified by:

getAvatar in interface GateInFacebookProcessor

saveAccessTokenAttributesToUserProfile

public void saveAccessTokenAttributesToUserProfile(org.exoplatform.services.organization.UserProfile userProfile,
                                          OAuthCodec codec,
                                          FacebookAccessTokenContext accessTokenContext)

Description copied from interface: OAuthProviderProcessor

Save accessToken data to given userProfile. Note that we are not calling any DB save operations, just filling data into given userProfile

Specified by:

saveAccessTokenAttributesToUserProfile in interface OAuthProviderProcessor<FacebookAccessTokenContext>

Parameters:

userProfile - where data about access token will be filled

codec - to encode some attributes (sensitive data) before save them to user profile

accessTokenContext - specific access token for this OAuth processor

getAccessTokenFromUserProfile

public FacebookAccessTokenContext getAccessTokenFromUserProfile(org.exoplatform.services.organization.UserProfile userProfile,
                                                       OAuthCodec codec)

Description copied from interface: OAuthProviderProcessor

Obtain needed data from given userProfile and create accessToken from them

Specified by:

getAccessTokenFromUserProfile in interface OAuthProviderProcessor<FacebookAccessTokenContext>

Parameters:

userProfile - where data from access token will be obtained

codec - to decode data from userProfile

Returns:

accesstoken or null if accessToken is not found in persistent storage

removeAccessTokenFromUserProfile

public void removeAccessTokenFromUserProfile(org.exoplatform.services.organization.UserProfile userProfile)

Description copied from interface: OAuthProviderProcessor

Remove data about access token from this user profile

Specified by:

removeAccessTokenFromUserProfile in interface OAuthProviderProcessor<FacebookAccessTokenContext>

Parameters:

userProfile - from which data will be removed

revokeToken

public void revokeToken(FacebookAccessTokenContext accessToken)

Description copied from interface: OAuthProviderProcessor

Revoke given access token on OAuth provider side, so application is removed from list of supported applications for given user

Specified by:

revokeToken in interface OAuthProviderProcessor<FacebookAccessTokenContext>

Parameters:

accessToken - access token to revoke

validateTokenAndUpdateScopes

public FacebookAccessTokenContext validateTokenAndUpdateScopes(FacebookAccessTokenContext accessToken)
                                                        throws OAuthException

Description copied from interface: OAuthProviderProcessor

Send request to OAuth Provider to validate if given access token is valid and ask for scopes, which are available for given accessToken. Returned access token should be always valid and prepared for invoke other operations

Specified by:

validateTokenAndUpdateScopes in interface OAuthProviderProcessor<FacebookAccessTokenContext>

Parameters:

accessToken - accessToken which will be used to ask OAuthProvider about validation and for available scopes

Returns:

accessTokenContext, which will be quite same as the one from accessToken parameter. It could have some info updated (like scopes)

Throws:

OAuthException - usually with codes: - OAuthExceptionCode.ACCESS_TOKEN_ERROR if invalid access is used as argument - OAuthExceptionCode.IO_ERROR if IO error occurs

getAuthorizedSocialApiObject

public <C> C getAuthorizedSocialApiObject(FacebookAccessTokenContext accessToken,
                                 Class<C> socialApiObjectType)

Description copied from interface: OAuthProviderProcessor

Return object, which can be used to call some operations on this Social network. For example "Plus" object for Google+ network

Specified by:

getAuthorizedSocialApiObject in interface OAuthProviderProcessor<FacebookAccessTokenContext>

Parameters:

accessToken - access token used to initialize object

socialApiObjectType - Type of object, which we wanted to return. Method will return null if this type is not supported by this processor

Returns:

initialized object of required type or null if type wasn't found (supported) by this processor