org.pac4j.oauth.client

Class WindowsLiveClient

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.BaseClient<OAuthCredentials,U>

org.pac4j.oauth.client.BaseOAuthClient<U>

org.pac4j.oauth.client.BaseOAuth20Client<WindowsLiveProfile>

org.pac4j.oauth.client.WindowsLiveClient

All Implemented Interfaces:

Cloneable, Client<OAuthCredentials,WindowsLiveProfile>

public class WindowsLiveClient
extends BaseOAuth20Client<WindowsLiveProfile>

This class is the OAuth client to authenticate users in Windows Live (SkyDrive, Hotmail and Messenger).

It returns a WindowsLiveProfile.

More information at http://msdn.microsoft.com/en-us/library/live/hh243641.aspx

Since:

1.1.0

Author:

Jerome Leleu

See Also:

WindowsLiveProfile

Field Summary

Fields inherited from class org.pac4j.oauth.client.BaseOAuth20Client

logger, OAUTH_CODE

Fields inherited from class org.pac4j.oauth.client.BaseOAuthClient

connectTimeout, key, proxyHost, proxyPort, readTimeout, secret, service, tokenAsHeader

Fields inherited from class org.pac4j.core.client.BaseClient

ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, NEEDS_CLIENT_REDIRECTION_PARAMETER

Constructor Summary

Constructors

Constructor and Description
WindowsLiveClient()
WindowsLiveClient(String key, String secret)

Method Summary

Modifier and Type	Method and Description
protected WindowsLiveProfile	extractUserProfile(String body) Extract the user profile from the response (JSON, XML...) of the profile url.
protected String	getProfileUrl(org.scribe.model.Token accessToken) Retrieve the url of the profile of the authenticated user for the provider.
protected boolean	hasBeenCancelled(WebContext context) Return if the authentication has been cancelled.
protected void	internalInit()
protected WindowsLiveClient	newClient()
protected boolean	requiresStateParameter() Return if this client requires a state parameter.

Methods inherited from class org.pac4j.oauth.client.BaseOAuth20Client

getAccessToken, getOAuthCredentials, getStateParameter, isDirectRedirection, retrieveAuthorizationUrl

Methods inherited from class org.pac4j.oauth.client.BaseOAuthClient

addAccessTokenToProfile, clone, createProxyRequest, getConnectTimeout, getKey, getMechanism, getProxyHost, getProxyPort, getReadTimeout, getSecret, getUserProfile, isTokenAsHeader, retrieveCredentials, retrieveRedirectAction, retrieveUserProfile, retrieveUserProfileFromToken, sendRequestForData, sendRequestForData, setConnectTimeout, setKey, setProxyHost, setProxyPort, setReadTimeout, setSecret, setTokenAsHeader

Methods inherited from class org.pac4j.core.client.BaseClient

addAuthorizationGenerator, getAuthenticator, getAuthorizationGenerators, getCallbackUrl, getContextualCallbackUrl, getCredentials, getName, getProfileCreator, getRedirectAction, getRedirectionUrl, getUserProfile, isEnableContextualRedirects, isIncludeClientNameInCallbackUrl, prependHostToUrlIfNotPresent, redirect, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setCallbackUrl, setEnableContextualRedirects, setIncludeClientNameInCallbackUrl, setName, setProfileCreator, toString

Methods inherited from class org.pac4j.core.util.InitializableObject

init, reinit

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowsLiveClient

public WindowsLiveClient()

WindowsLiveClient

public WindowsLiveClient(String key,
                         String secret)

Method Detail

newClient

protected WindowsLiveClient newClient()

Specified by:

newClient in class BaseClient<OAuthCredentials,WindowsLiveProfile>

internalInit

protected void internalInit()

Overrides:

internalInit in class BaseOAuthClient<WindowsLiveProfile>

getProfileUrl

protected String getProfileUrl(org.scribe.model.Token accessToken)

Description copied from class: BaseOAuthClient

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

Specified by:

getProfileUrl in class BaseOAuthClient<WindowsLiveProfile>

Parameters:

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

Returns:

the url of the user profile given by the provider

extractUserProfile

protected WindowsLiveProfile extractUserProfile(String body)

Description copied from class: BaseOAuthClient

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

Specified by:

extractUserProfile in class BaseOAuthClient<WindowsLiveProfile>

Parameters:

body - the response body

Returns:

the user profile object

requiresStateParameter

protected boolean requiresStateParameter()

Description copied from class: BaseOAuth20Client

Return if this client requires a state parameter.

Specified by:

requiresStateParameter in class BaseOAuth20Client<WindowsLiveProfile>

Returns:

if this client requires a state parameter.

hasBeenCancelled

protected boolean hasBeenCancelled(WebContext context)

Description copied from class: BaseOAuthClient

Return if the authentication has been cancelled.

Specified by:

hasBeenCancelled in class BaseOAuthClient<WindowsLiveProfile>

Parameters:

context - the web context.

Returns:

if the authentication has been cancelled.