io.gravitee.am.model.safe.UserProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-am-model Show documentation
There is a newer version: 4.6.0-alpha.2
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.am.model.safe;

import io.gravitee.am.common.oidc.StandardClaims;
import io.gravitee.am.common.oidc.idtoken.Claims;
import io.gravitee.am.common.utils.ConstantKeys;
import io.gravitee.am.model.Role;
import io.gravitee.am.model.User;
import io.gravitee.am.model.ReferenceType;
import io.gravitee.am.model.scim.Address;
import io.gravitee.am.model.scim.Attribute;

import java.util.*;
import java.util.stream.Collectors;

/**
 * @author Titouan COMPIEGNE (titouan.compiegne at graviteesource.com)
 * @author GraviteeSource Team
 */
public class UserProperties {

    private String id;
    private String externalId;
    private String domain;
    private String username;
    private String firstName;
    private String lastName;
    private String email;
    private String phoneNumber;
    private String source;
    private String preferredLanguage;
    private Set roles;
    private List groups;
    private Map claims;
    private Map additionalInformation;
    private List emails;
    private List phoneNumbers;
    private List ims;
    private List photos;
    private List entitlements;
    private List addresses;

    public UserProperties() {
    }

    public UserProperties(User user) {
        this.id = user.getId();
        this.externalId = user.getExternalId();

        if(user.getReferenceType() == ReferenceType.DOMAIN) {
            this.domain = user.getReferenceId();
        }

        this.username = user.getUsername();
        this.firstName = user.getFirstName();
        this.lastName = user.getLastName();
        this.email = user.getEmail();
        this.phoneNumber = user.getPhoneNumber();
        // set groups
        this.groups = user.getGroups();
        // set roles
        if (user.getRolesPermissions() != null) {
            roles = user.getRolesPermissions().stream().map(Role::getName).collect(Collectors.toSet());
        }
        // set claims
        var userAdditionalInformation = Optional.ofNullable(user.getAdditionalInformation())
                .orElse(new HashMap<>());
        claims = new HashMap<>(userAdditionalInformation);
        if (user.getLoggedAt() != null) {
            claims.put(Claims.auth_time, user.getLoggedAt().getTime() / 1000);
        }
        // remove technical information that shouldn't be used in templates
        claims.remove(ConstantKeys.OIDC_PROVIDER_ID_TOKEN_KEY);
        claims.remove(ConstantKeys.OIDC_PROVIDER_ID_ACCESS_TOKEN_KEY);

        this.additionalInformation = claims; // use same ref as claims for additionalInfo to avoid regression on templates that used the User object before
        this.source = user.getSource();
        this.preferredLanguage = evaluatePreferredLanguage(user);
        this.emails = evaluateAttributes(user.getEmails());
        this.phoneNumbers = evaluateAttributes(user.getPhoneNumbers());
        this.ims = evaluateAttributes(user.getIms());
        this.photos = evaluateAttributes(user.getPhotos());
        this.entitlements = user.getEntitlements();
        this.addresses = evaluateAddresses(user.getAddresses());
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getExternalId() {
        return externalId;
    }

    public void setExternalId(String externalId) {
        this.externalId = externalId;
    }

    public String getDomain() {
        return domain;
    }

    public void setDomain(String domain) {
        this.domain = domain;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getPhoneNumber() {
        return phoneNumber;
    }

    public void setPhoneNumber(String phoneNumber) {
        this.phoneNumber = phoneNumber;
    }

    public Set getRoles() {
        return roles;
    }

    public void setRoles(Set roles) {
        this.roles = roles;
    }

    public List getGroups() {
        return groups;
    }

    public void setGroups(List groups) {
        this.groups = groups;
    }

    public Map getClaims() {
        return claims;
    }

    public void setClaims(Map claims) {
        this.claims = claims;
    }

    public String getSource() {
        return source;
    }

    public void setSource(String source) {
        this.source = source;
    }

    public String getPreferredLanguage() {
        return preferredLanguage;
    }

    public void setPreferredLanguage(String preferredLanguage) {
        this.preferredLanguage = preferredLanguage;
    }

    public Map getAdditionalInformation() {
        return additionalInformation;
    }

    public void setAdditionalInformation(Map additionalInformation) {
        this.additionalInformation = additionalInformation;
    }

    public List getEmails() {
        return emails;
    }

    public void setEmails(List emails) {
        this.emails = emails;
    }

    public List getPhoneNumbers() {
        return phoneNumbers;
    }

    public void setPhoneNumbers(List phoneNumbers) {
        this.phoneNumbers = phoneNumbers;
    }

    public List getIms() {
        return ims;
    }

    public void setIms(List ims) {
        this.ims = ims;
    }

    public List getPhotos() {
        return photos;
    }

    public void setPhotos(List photos) {
        this.photos = photos;
    }

    public List getEntitlements() {
        return entitlements;
    }

    public void setEntitlements(List entitlements) {
        this.entitlements = entitlements;
    }

    public List getAddresses() {
        return addresses;
    }

    public void setAddresses(List addresses) {
        this.addresses = addresses;
    }

    private String evaluatePreferredLanguage(User user) {
        if (user.getPreferredLanguage() == null) {
            // fall back to OIDC standard claims
            if (user.getAdditionalInformation() != null && user.getAdditionalInformation().get(StandardClaims.LOCALE) != null) {
                return (String) user.getAdditionalInformation().get(StandardClaims.LOCALE);
            }
        }
        return user.getPreferredLanguage();
    }

    private List evaluateAttributes(List attributes) {
        if (attributes == null) {
            return null;
        }
        // Nimbus internal JSON writer do not handle null values
        return attributes
                .stream()
                .map(attribute -> {
                    attribute.setPrimary(Boolean.TRUE.equals(attribute.isPrimary()));
                    return attribute;
                }).collect(Collectors.toList());

    }

    private List evaluateAddresses(List addresses) {
        if (addresses == null) {
            return null;
        }
        // Nimbus internal JSON writer do not handle null values
        return addresses
                .stream()
                .map(address -> {
                    address.setPrimary(Boolean.TRUE.equals(address.isPrimary()));
                    return address;
                }).collect(Collectors.toList());
    }
}