org.brickred.socialauth.provider

Class YahooImpl

java.lang.Object

org.brickred.socialauth.AbstractProvider

org.brickred.socialauth.provider.YahooImpl

All Implemented Interfaces:

Serializable, AuthProvider

public class YahooImpl
extends AbstractProvider
implements AuthProvider, Serializable

Provider implementation for Yahoo. This uses the oAuth API provided by Yahoo

Author:

abhinavm@brickred.com, tarunn@brickred.com

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.brickred.socialauth.AuthProvider

COUNTRY, DOB, EMAIL, EXT_NAMESPACE, FIRST_NAME, FULL_NAME, GENDER, LANGUAGE, LAST_NAME, NICK_NAME, POSTCODE

Constructor Summary

Constructors

Constructor and Description
YahooImpl(OAuthConfig providerConfig) Stores configuration for the provider

Method Summary

Methods

Modifier and Type	Method and Description
Response	api(String url, String methodType, Map<String,String> params, Map<String,String> headerParams, String body) Makes OAuth signed HTTP request to a given URL.
AccessGrant	getAccessGrant() Retrieves the AccessGrant object.
List<Contact>	getContactList() Gets the list of contacts of the user and their email.
String	getLoginRedirectURL(String successUrl) This is the most important action.
protected OAuthStrategyBase	getOauthStrategy() Returns the OAuthStrategyBase of a provider.
protected List<String>	getPluginsList() Returns the list of plugins of a provider.
String	getProviderId() Retrieves the provider id
Profile	getUserProfile() Retrieves the user profile.
void	logout() Logout
void	setAccessGrant(AccessGrant accessGrant) Stores access grant for the provider
void	setPermission(Permission p)
Response	updateStatus(String msg) Updates the status on the chosen provider if available.
Response	uploadImage(String message, String fileName, InputStream inputStream) Updates the image and message on the chosen provider if available.
Profile	verifyResponse(Map<String,String> requestParams) Verifies the user when the external provider redirects back to our application.

Methods inherited from class org.brickred.socialauth.AbstractProvider

getPlugin, getPluginsScope, isSupportedPlugin, refreshToken, registerPlugins

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.brickred.socialauth.AuthProvider

getPlugin, isSupportedPlugin, refreshToken, registerPlugins

Constructor Detail

YahooImpl

public YahooImpl(OAuthConfig providerConfig)
          throws Exception

Stores configuration for the provider

Parameters:

providerConfig - It contains the configuration of application like consumer key and consumer secret

Throws:

Exception

Method Detail

setAccessGrant

public void setAccessGrant(AccessGrant accessGrant)
                    throws AccessTokenExpireException

Stores access grant for the provider

Specified by:

setAccessGrant in interface AuthProvider

Parameters:

accessGrant - It contains the access token and other information

Throws:

AccessTokenExpireException

getLoginRedirectURL

public String getLoginRedirectURL(String successUrl)
                           throws Exception

This is the most important action. It redirects the browser to an appropriate URL which will be used for authentication with the provider that has been set using setId()

Specified by:

getLoginRedirectURL in interface AuthProvider

Throws:

Exception

verifyResponse

public Profile verifyResponse(Map<String,String> requestParams)
                       throws Exception

Verifies the user when the external provider redirects back to our application.

Specified by:

verifyResponse in interface AuthProvider

Parameters:

requestParams - request parameters, received from the provider

Returns:

Profile object containing the profile information

Throws:

Exception

getContactList

public List<Contact> getContactList()
                             throws Exception

Gets the list of contacts of the user and their email.

Specified by:

getContactList in interface AuthProvider

Returns:

List of contact objects representing Contacts. Only name and email will be available

Throws:

Exception

updateStatus

public Response updateStatus(String msg)
                      throws Exception

Updates the status on the chosen provider if available. This may not be implemented for all providers.

Specified by:

updateStatus in interface AuthProvider

Parameters:

msg - Message to be shown as user's status

Throws:

Exception

logout

public void logout()

Logout

Specified by:

logout in interface AuthProvider

setPermission

public void setPermission(Permission p)

Specified by:

setPermission in interface AuthProvider

Parameters:

p - Permission object which can be Permission.AUHTHENTICATE_ONLY, Permission.ALL, Permission.DEFAULT

api

public Response api(String url,
           String methodType,
           Map<String,String> params,
           Map<String,String> headerParams,
           String body)
             throws Exception

Makes OAuth signed HTTP request to a given URL. It attaches GUID in URL and Authorization header to make HTTP request. URL string should contain "format specifier" for GUID.

Specified by:

api in interface AuthProvider

Parameters:

url - URL to make HTTP request. It should contain format specifier to pass GUID. E.g. "http://social.yahooapis.com/v1/user/%1$s/profile?format=json" . This URL contains format specifier "%1$s", which will be replaced by GUID.

methodType - Method type can be GET, POST or PUT

params - Any additional parameters whose signature we want to compute. Only used in case of "POST" and "PUT" method type.

headerParams - Any additional parameters need to pass as Header Parameters.

body - Request Body

Returns:

Response object

Throws:

Exception

getUserProfile

public Profile getUserProfile()
                       throws Exception

Retrieves the user profile.

Specified by:

getUserProfile in interface AuthProvider

Returns:

Profile object containing the profile information.

Throws:

Exception

getAccessGrant

public AccessGrant getAccessGrant()

Description copied from interface: AuthProvider

Retrieves the AccessGrant object.

Specified by:

getAccessGrant in interface AuthProvider

Returns:

AccessGrant object.

getProviderId

public String getProviderId()

Description copied from interface: AuthProvider

Retrieves the provider id

Specified by:

getProviderId in interface AuthProvider

Returns:

provider id.

uploadImage

public Response uploadImage(String message,
                   String fileName,
                   InputStream inputStream)
                     throws Exception

Description copied from interface: AuthProvider

Updates the image and message on the chosen provider if available. This is implemented only for Facebook and Twitter.

Specified by:

uploadImage in interface AuthProvider

Parameters:

message - Status Message

fileName - Image file name

inputStream - Input Stream of image

Returns:

Response object

Throws:

Exception

getPluginsList

protected List<String> getPluginsList()

Description copied from class: AbstractProvider

Returns the list of plugins of a provider.

Specified by:

getPluginsList in class AbstractProvider

Returns:

List of plugins of a provider

getOauthStrategy

protected OAuthStrategyBase getOauthStrategy()

Description copied from class: AbstractProvider

Returns the OAuthStrategyBase of a provider.

Specified by:

getOauthStrategy in class AbstractProvider

Returns:

OAuthStrategyBase of a provider.