org.brickred.socialauth.provider
Class LinkedInImpl

java.lang.Object
  org.brickred.socialauth.AbstractProvider
      org.brickred.socialauth.provider.LinkedInImpl

All Implemented Interfaces:

Serializable, AuthProvider

public class LinkedInImpl
extends AbstractProvider
implements AuthProvider, Serializable

Implementation of Hotmail provider. This implementation is based on the sample provided by Microsoft. Currently no elements in profile are available and this implements only getContactList() properly

Author:

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

LinkedInImpl(Properties props)

Method Summary

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.
List<Contact>	getContactList() Gets the list of contacts of the user and their email.
String	getLoginRedirectURL(String returnTo) This is the most important action.
Profile	getUserProfile() Retrieves the user profile.
void	logout() Logout
void	setPermission(Permission p)
void	updateStatus(String msg) Updates the status on the chosen provider if available.
Profile	verifyResponse(javax.servlet.http.HttpServletRequest request) Verifies the user when the external provider redirects back to our application.

Methods inherited from class org.brickred.socialauth.AbstractProvider

isProviderState, setProviderState

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkedInImpl

public LinkedInImpl(Properties props)
             throws Exception

Throws:

Exception

Method Detail

getLoginRedirectURL

public String getLoginRedirectURL(String returnTo)
                           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(javax.servlet.http.HttpServletRequest request)
                       throws Exception

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

Specified by:

verifyResponse in interface AuthProvider

Parameters:

request - Request object the request is 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 profile objects representing Contacts. Only name and email will be available

Throws:

Exception

updateStatus

public void updateStatus(String msg)
                  throws Exception

Description copied from interface: AuthProvider

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 Authorization header with HTTP request.

Specified by:

api in interface AuthProvider

Parameters:

url - URL to make HTTP request.

methodType - Method type can be GET, POST or PUT

params - Any additional parameters whose signature need 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()

Retrieves the user profile.

Specified by:

getUserProfile in interface AuthProvider

Returns:

Profile object containing the profile information.