org.pac4j.openid.client.YahooOpenIdClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pac4j-openid Show documentation
There is a newer version: 4.5.8
package org.pac4j.openid.client;

import org.openid4java.message.AuthSuccess;
import org.openid4java.message.MessageException;
import org.openid4java.message.ax.AxMessage;
import org.openid4java.message.ax.FetchRequest;
import org.openid4java.message.ax.FetchResponse;
import org.pac4j.core.context.WebContext;
import org.pac4j.core.exception.HttpAction;
import org.pac4j.core.util.CommonHelper;
import org.pac4j.openid.profile.yahoo.YahooOpenIdAttributesDefinition;
import org.pac4j.openid.profile.yahoo.YahooOpenIdProfile;

/**
 * This class is the OpenID client to authenticate users with their yahoo account.
 * It returns a {@link org.pac4j.openid.profile.yahoo.YahooOpenIdProfile}.
 * 
 * @see org.pac4j.openid.profile.yahoo.YahooOpenIdProfile
 * @author Patrice de Saint Steban
 * @since 1.6.0
 */
public class YahooOpenIdClient extends BaseOpenIdClient {

    public static final String YAHOO_GENERIC_USER_IDENTIFIER = "https://me.yahoo.com";

    @Override
    protected String getUser(final WebContext context) {
        return YAHOO_GENERIC_USER_IDENTIFIER;
    }

    @Override
    protected FetchRequest getFetchRequest() throws MessageException {
        final FetchRequest fetchRequest = FetchRequest.createFetchRequest();
		fetchRequest.addAttribute(YahooOpenIdAttributesDefinition.EMAIL,
				"http://axschema.org/contact/email", true);
		fetchRequest.addAttribute(YahooOpenIdAttributesDefinition.FULLNAME,
				"http://axschema.org/namePerson", true);
		fetchRequest.addAttribute(YahooOpenIdAttributesDefinition.LANGUAGE,
				"http://axschema.org/pref/language", true);
		fetchRequest.addAttribute(YahooOpenIdAttributesDefinition.PROFILEPICTURE,
				"http://axschema.org/media/image/default", true);
		
		logger.debug("fetchRequest: {}", fetchRequest);
        return fetchRequest;
    }

    @Override
    protected YahooOpenIdProfile createProfile(final AuthSuccess authSuccess) throws MessageException, HttpAction {
        final YahooOpenIdProfile profile = new YahooOpenIdProfile();

        if (authSuccess.hasExtension(AxMessage.OPENID_NS_AX)) {
            final FetchResponse fetchResp = (FetchResponse) authSuccess.getExtension(AxMessage.OPENID_NS_AX);
            for (final String name : profile.getAttributesDefinition().getPrimaryAttributes()) {
                profile.addAttribute(name, fetchResp.getAttributeValue(name));
            }
        }
        return profile;
    }

    @Override
    public String toString() {
        return CommonHelper.toString(this.getClass(), "callbackUrl", this.callbackUrl, "name", getName());
    }
}