org.pac4j.oauth.profile.google2.Google2ProfileDefinition 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.profile.google2;

import com.github.scribejava.core.model.Token;
import lombok.val;
import org.pac4j.core.profile.ProfileHelper;
import org.pac4j.core.profile.converter.Converters;
import org.pac4j.oauth.config.OAuthConfiguration;
import org.pac4j.oauth.profile.JsonHelper;
import org.pac4j.oauth.profile.definition.OAuthProfileDefinition;

import static org.pac4j.core.profile.AttributeLocation.PROFILE_ATTRIBUTE;

/**
 * This class is the Google profile definition (using OAuth 2.0 protocol).
 *
 * @author Jerome Leleu
 * @since 1.2.0
 */
public class Google2ProfileDefinition extends OAuthProfileDefinition {

    /** Constant EMAIL_VERIFIED="email_verified" */
    public static final String EMAIL_VERIFIED = "email_verified";
    /** Constant GIVEN_NAME="given_name" */
    public static final String GIVEN_NAME = "given_name";
    /** Constant NAME="name" */
    public static final String NAME = "name";
    /** Constant PICTURE="picture" */
    public static final String PICTURE = "picture";
    /** Constant PROFILE="profile" */
    public static final String PROFILE = "profile";

    /**
     * Constructor for Google2ProfileDefinition.
     */
    public Google2ProfileDefinition() {
        super(x -> new Google2Profile());
        primary(EMAIL_VERIFIED, Converters.BOOLEAN);
        primary(GIVEN_NAME, Converters.STRING);
        primary(NAME, Converters.STRING);
        primary(PICTURE, Converters.URL);
        primary(PROFILE, Converters.URL);
    }

    /** {@inheritDoc} */
    @Override
    public String getProfileUrl(final Token accessToken, final OAuthConfiguration configuration) {
        return "https://www.googleapis.com/oauth2/v3/userinfo";
    }

    /** {@inheritDoc} */
    @Override
    public Google2Profile extractUserProfile(final String body) {
        val profile = (Google2Profile) newProfile();
        val json = JsonHelper.getFirstNode(body);
        if (json != null) {
            profile.setId(ProfileHelper.sanitizeIdentifier(JsonHelper.getElement(json, "sub")));
            for (val attribute : getPrimaryAttributes()) {
                convertAndAdd(profile, PROFILE_ATTRIBUTE, attribute, JsonHelper.getElement(json, attribute));
            }
        } else {
            raiseProfileExtractionJsonError(body);
        }
        return profile;
    }
}