org.pac4j.oauth.profile.windowslive

Class WindowsLiveProfileDefinition

java.lang.Object

org.pac4j.core.profile.definition.ProfileDefinition<P>

org.pac4j.core.profile.definition.CommonProfileDefinition<P>

org.pac4j.oauth.profile.definition.OAuthProfileDefinition<P,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

org.pac4j.oauth.profile.definition.OAuth20ProfileDefinition<WindowsLiveProfile>

org.pac4j.oauth.profile.windowslive.WindowsLiveProfileDefinition

public class WindowsLiveProfileDefinition
extends OAuth20ProfileDefinition<WindowsLiveProfile>

This class is the Windows Live profile definition.

Since:

1.1.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAST_NAME
static String	LINK
static String	NAME
static String	UPDATED_TIME

Fields inherited from class org.pac4j.core.profile.definition.CommonProfileDefinition

DISPLAY_NAME, EMAIL, FAMILY_NAME, FIRST_NAME, GENDER, LOCALE, LOCATION, PICTURE_URL, PROFILE_URL

Fields inherited from class org.pac4j.core.profile.definition.ProfileDefinition

logger, newProfile

Constructor Summary

Constructors

Constructor and Description
WindowsLiveProfileDefinition()

Method Summary

Modifier and Type	Method and Description
WindowsLiveProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
String	getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken, OAuth20Configuration configuration) Retrieve the url of the profile of the authenticated user for the provider.

Methods inherited from class org.pac4j.oauth.profile.definition.OAuthProfileDefinition

getProfileVerb

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinition

convertAndAdd, convertAndAdd, getConverters, getPrimaryAttributes, getSecondaryAttributes, newProfile, primary, secondary, setProfileFactory

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

LINK

public static final String LINK

See Also:

Constant Field Values

UPDATED_TIME

public static final String UPDATED_TIME

See Also:

Constant Field Values

Constructor Detail

WindowsLiveProfileDefinition

public WindowsLiveProfileDefinition()

Method Detail

getProfileUrl

public String getProfileUrl(com.github.scribejava.core.model.OAuth2AccessToken accessToken,
                            OAuth20Configuration configuration)

Description copied from class: OAuthProfileDefinition

Retrieve the url of the profile of the authenticated user for the provider.

Specified by:

getProfileUrl in class OAuthProfileDefinition<WindowsLiveProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

accessToken - only used when constructing dynamic urls from data in the token

configuration - the current configuration

Returns:

the url of the user profile given by the provider

extractUserProfile

public WindowsLiveProfile extractUserProfile(String body)
                                      throws HttpAction

Description copied from class: OAuthProfileDefinition

Extract the user profile from the response (JSON, XML...) of the profile url.

Specified by:

extractUserProfile in class OAuthProfileDefinition<WindowsLiveProfile,com.github.scribejava.core.model.OAuth2AccessToken,OAuth20Configuration>

Parameters:

body - the response body

Returns:

the returned profile

Throws:

HttpAction - whether an extra HTTP action is required