act.social

Class SocialProvider

java.lang.Object

act.social.SocialProvider

Direct Known Subclasses:

OAuth2Provider

public abstract class SocialProvider
extends Object

Base class for all itendity providers

The code is modified from https://github.com/jaliss/securesocial

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocialProvider.Manager
static class	SocialProvider.Resolver

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthenticationMethod	authMethod The authentication method used by this provider
protected String	callbackUrl
protected Config	config The configuration for the provider
protected String	id The provider ID.
protected org.osgl.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
SocialProvider(String id, AuthenticationMethod authMethod) Creates a new IdentityProvider

Method Summary

Methods

Modifier and Type	Method and Description
protected static StringBuilder	appendParam(StringBuilder sb, String key, String val)
protected static StringBuilder	appendParams(StringBuilder sb, Map<String,String> args)
abstract String	authUrl(String callback, String payload) Returns the authentication URL of this provider
protected String	callbackUrl()
protected String	callbackUrl(String callback, String payload)
void	checkCsrfToken(String csrfToken)
abstract SocialProfile	doAuth(String code, String act_callback, String act_payload) Subclasses must implement the authentication logic in this method
abstract void	fillProfile(SocialProfile user) Once the user is authenticated this method is called to retrieve profile information from the provider.
protected okhttp3.Request	finishBuildingRequest(okhttp3.Request.Builder builder, Map<String,String> params)
String	getId()
protected com.alibaba.fastjson.JSONObject	readUrlAsJson(String url, Map<String,String> params, boolean post)
protected String	readUrlAsString(String url, Map<String,String> params, boolean post)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.osgl.logging.Logger logger

id

protected String id

The provider ID.

config

protected Config config

The configuration for the provider

authMethod

protected AuthenticationMethod authMethod

The authentication method used by this provider

callbackUrl

protected String callbackUrl

Constructor Detail

SocialProvider

public SocialProvider(String id,
              AuthenticationMethod authMethod)

Creates a new IdentityProvider

Parameters:

id - The type for this provider

authMethod - The authentication method used by this provider

Method Detail

getId

public String getId()

toString

public String toString()

Overrides:

toString in class Object

checkCsrfToken

public void checkCsrfToken(String csrfToken)

doAuth

public abstract SocialProfile doAuth(String code,
                   String act_callback,
                   String act_payload)

Subclasses must implement the authentication logic in this method

Parameters:

act_callback - the url to which the user is redirected once social authentication process finished

act_payload - the addtional data app would like to pass through the social authentication process

code - the auth code

Returns:

SocialProfile the authenticated user

appendParam

protected static StringBuilder appendParam(StringBuilder sb,
                        String key,
                        String val)

appendParams

protected static StringBuilder appendParams(StringBuilder sb,
                         Map<String,String> args)

fillProfile

public abstract void fillProfile(SocialProfile user)

Once the user is authenticated this method is called to retrieve profile information from the provider.

Parameters:

user - A SocialProfile

authUrl

public abstract String authUrl(String callback,
             String payload)

Returns the authentication URL of this provider

Parameters:

callback - the callback URL to which user is redirected once social authentication process is done

payload - the additional data user app might want to passed through the social link process

Returns:

the authentication URL

callbackUrl

protected String callbackUrl(String callback,
                 String payload)

callbackUrl

protected String callbackUrl()

readUrlAsString

protected String readUrlAsString(String url,
                     Map<String,String> params,
                     boolean post)

readUrlAsJson

protected com.alibaba.fastjson.JSONObject readUrlAsJson(String url,
                                            Map<String,String> params,
                                            boolean post)

finishBuildingRequest

protected okhttp3.Request finishBuildingRequest(okhttp3.Request.Builder builder,
                                    Map<String,String> params)