org.picketlink.social.standalone.login

Class ExternalAuthentication

java.lang.Object

org.picketlink.social.standalone.login.ExternalAuthentication

public class ExternalAuthentication
extends Object

Perform external authentication using Facebook Connect and Google OpenID

Since:

Sep 19, 2012

Author:

anil saldhana

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE
protected String	clientID
protected String	clientSecret
protected FacebookProcessor	facebookProcessor
protected String	facebookScope
protected static org.apache.log4j.Logger	log
protected OpenIDProcessor	openidProcessor
protected String	returnURL
protected List<String>	roles
protected boolean	saveRestoreRequest
protected boolean	trace

Constructor Summary

Constructors

Constructor and Description
ExternalAuthentication()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Authenticate the request
Principal	getFacebookPrincipal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected Principal	handleFacebookAuthenticationResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	initialFacebookInteraction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	processFacebook(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Principal	processIncomingAuthResult(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	processOpenID(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected URLConnection	sendFacebookAccessTokenRequest(String returnUrl, String authorizationCode, javax.servlet.http.HttpServletResponse response)
void	setClientID(String clientID) Set the client id for facebook
void	setClientSecret(String clientSecret) Set the client secret for facebook
void	setFacebookScope(String facebookScope) Set the scope for facebook (Default: email)
void	setReturnURL(String returnURL) Set the url where the 3rd party authentication service will redirect after authentication
void	setRoleString(String roleStr) A comma separated string that represents the roles the web app needs to pass authorization
void	setSaveRestoreRequest(boolean saveRestoreRequest)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

trace

protected boolean trace

AUTH_TYPE

public static final String AUTH_TYPE

See Also:

Constant Field Values

facebookProcessor

protected FacebookProcessor facebookProcessor

openidProcessor

protected OpenIDProcessor openidProcessor

returnURL

protected String returnURL

clientID

protected String clientID

clientSecret

protected String clientSecret

facebookScope

protected String facebookScope

saveRestoreRequest

protected boolean saveRestoreRequest

roles

protected List<String> roles

Constructor Detail

ExternalAuthentication

public ExternalAuthentication()

Method Detail

setRoleString

public void setRoleString(String roleStr)

A comma separated string that represents the roles the web app needs to pass authorization

Parameters:

roleStr -

setSaveRestoreRequest

public void setSaveRestoreRequest(boolean saveRestoreRequest)

setReturnURL

public void setReturnURL(String returnURL)

Set the url where the 3rd party authentication service will redirect after authentication

Parameters:

returnURL -

setClientID

public void setClientID(String clientID)

Set the client id for facebook

Parameters:

clientID -

setClientSecret

public void setClientSecret(String clientSecret)

Set the client secret for facebook

Parameters:

clientSecret -

setFacebookScope

public void setFacebookScope(String facebookScope)

Set the scope for facebook (Default: email)

Parameters:

facebookScope -

authenticate

public boolean authenticate(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
                     throws IOException

Authenticate the request

Parameters:

request -

response -

Returns:

Throws:

IOException

{@link - RuntimeException} when the response is not of type catalina response object

processFacebook

protected boolean processFacebook(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
                           throws IOException

Throws:

IOException

processOpenID

protected boolean processOpenID(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
                         throws IOException

Throws:

IOException

initialFacebookInteraction

public boolean initialFacebookInteraction(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                                   throws IOException

Throws:

IOException

getFacebookPrincipal

public Principal getFacebookPrincipal(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)

handleFacebookAuthenticationResponse

protected Principal handleFacebookAuthenticationResponse(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)

sendFacebookAccessTokenRequest

protected URLConnection sendFacebookAccessTokenRequest(String returnUrl,
                                           String authorizationCode,
                                           javax.servlet.http.HttpServletResponse response)

processIncomingAuthResult

public Principal processIncomingAuthResult(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                                    throws IOException

Throws:

IOException