org.pac4j.oauth.client.WindowsLiveClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pac4j-oauth Show documentation

There is a newer version: 6.1.0

package org.pac4j.oauth.client;

import com.fasterxml.jackson.databind.JsonNode;
import com.github.scribejava.core.builder.api.BaseApi;
import com.github.scribejava.core.model.OAuth2AccessToken;
import com.github.scribejava.core.oauth.OAuth20Service;
import org.pac4j.core.exception.HttpAction;
import org.pac4j.oauth.profile.JsonHelper;
import org.pac4j.oauth.profile.windowslive.WindowsLiveProfile;
import org.pac4j.scribe.builder.api.WindowsLiveApi20;

/**
 * This class is the OAuth client to authenticate users in Windows Live (SkyDrive, Hotmail and Messenger).
 * It returns a {@link org.pac4j.oauth.profile.windowslive.WindowsLiveProfile}.
 * More information at http://msdn.microsoft.com/en-us/library/live/hh243641.aspx
 *
 * @author Jerome Leleu
 * @since 1.1.0
 */
public class WindowsLiveClient extends BaseOAuth20Client {

    public WindowsLiveClient() {
    }

    public WindowsLiveClient(final String key, final String secret) {
        setKey(key);
        setSecret(secret);
    }

    @Override
    protected BaseApi getApi() {
        return new WindowsLiveApi20();
    }

    @Override
    protected  boolean hasOAuthGrantType() {
        return true;
    }

    @Override
    protected String getOAuthScope() {
        return "wl.basic";
    }

    @Override
    protected String getProfileUrl(final OAuth2AccessToken accessToken) {
        return "https://apis.live.net/v5.0/me";
    }

    @Override
    protected WindowsLiveProfile extractUserProfile(final String body) throws HttpAction {
        final WindowsLiveProfile profile = new WindowsLiveProfile();
        final JsonNode json = JsonHelper.getFirstNode(body);
        if (json != null) {
            profile.setId(JsonHelper.getElement(json, "id"));
            for (final String attribute : profile.getAttributesDefinition().getPrimaryAttributes()) {
                profile.addAttribute(attribute, JsonHelper.getElement(json, attribute));
            }
        }
        return profile;
    }
}