org.pac4j.oauth.profile.hiorgserver.HiOrgServerProfileDefinition 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.hiorgserver;

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 java.util.HashSet;
import java.util.Set;

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

/**
 * This class is the HiOrg-Server profile definition.
 *
 * @author Martin Böhmer
 * @since 3.2.0
 */
public class HiOrgServerProfileDefinition extends OAuthProfileDefinition {

    /** Constant USER_ID="user_id" */
    public static final String USER_ID = "user_id";
    /** Constant USERNAME="username" */
    public static final String USERNAME = "username";

    /** Constant NAME="name" */
    public static final String NAME = "name";
    /** Constant FIRST_NAME="vorname" */
    public static final String FIRST_NAME = "vorname";
    /** Constant FULL_NAME="fullname" */
    public static final String FULL_NAME = "fullname";
    /** Constant ROLES="gruppe" */
    public static final String ROLES = "gruppe";
    /** Constant LEADER="leitung" */
    public static final String LEADER = "leitung";
    /** Constant POSITION="funktion" */
    public static final String POSITION = "funktion";
    /** Constant ORGANISATION_ID="orga" */
    public static final String ORGANISATION_ID = "orga";
    /** Constant ORGANISATION_NAME="organisation" */
    public static final String ORGANISATION_NAME = "organisation";

    /** Constant ALTERNATIVE_ID="alt_user_id" */
    public static final String ALTERNATIVE_ID = "alt_user_id";
    /** Constant TYPED_ALTERNATIVE_ID="typed_alt_user_id" */
    public static final String TYPED_ALTERNATIVE_ID = "typed_alt_user_id";

    /** Constant BASE_URL="https://www.hiorg-server.de/api/oauth2/"{trunked} */
    protected static final String BASE_URL = "https://www.hiorg-server.de/api/oauth2/v1/user.php";

    /**
     * Constructor for HiOrgServerProfileDefinition.
     */
    public HiOrgServerProfileDefinition() {
        super(x -> new HiOrgServerProfile());
        primary(USERNAME, Converters.STRING);
        primary(NAME, Converters.STRING);
        primary(FIRST_NAME, Converters.STRING);
        primary(FULL_NAME, Converters.STRING);
        primary(ROLES, Converters.INTEGER);
        primary(LEADER, Converters.BOOLEAN);
        primary(POSITION, Converters.STRING);
        primary(ORGANISATION_ID, Converters.STRING);
        primary(ORGANISATION_NAME, Converters.STRING);
        secondary(ALTERNATIVE_ID, Converters.STRING);
        secondary(TYPED_ALTERNATIVE_ID, Converters.STRING);
    }

    /** {@inheritDoc} */
    @Override
    public String getProfileUrl(final Token accessToken, final OAuthConfiguration configuration) {
        return BASE_URL;
    }

    /** {@inheritDoc} */
    @Override
    public HiOrgServerProfile extractUserProfile(String body) {
        val profile = (HiOrgServerProfile) newProfile();
        val json = JsonHelper.getFirstNode(body);
        if (json != null) {
            logger.debug("Extracting user profile from JSON node " + json);
            profile.setId(ProfileHelper.sanitizeIdentifier(JsonHelper.getElement(json, USER_ID)));
            for (val attribute : getPrimaryAttributes()) {
                convertAndAdd(profile, PROFILE_ATTRIBUTE, attribute, JsonHelper.getElement(json, attribute));
            }
            // Secondary attributes are generated from primary attributes
            convertAndAdd(profile, PROFILE_ATTRIBUTE, ALTERNATIVE_ID, profile.getAlternativeId());
            convertAndAdd(profile, PROFILE_ATTRIBUTE, TYPED_ALTERNATIVE_ID, profile.getTypedAlternativeId());
        } else {
            raiseProfileExtractionJsonError(body);
        }
        extractRoles(profile);
        return profile;
    }

    /**
     * extractRoles.
     *
     * @param profile a {@link HiOrgServerProfile} object
     */
    protected void extractRoles(HiOrgServerProfile profile) {
        final Integer rolesAsInt = profile.getRolesAsInteger();
        Set roles = new HashSet<>();
        for (var i = 0; i <= 10; i++) {
            var groupId = (int) Math.pow(2, i);
            var isGroupSet = (rolesAsInt & groupId) == groupId;
            if (isGroupSet) {
                logger.debug("Extracted role " + groupId);
                roles.add(String.valueOf(groupId));
            }
        }
        profile.setRoles(roles);
    }

}