EntitlementsUpdater.java

/*
 * Copyright (C) 2013 tarent AG
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package org.osiam.resources.provisioning.update;

import com.google.common.base.Strings;
import org.osiam.resources.converter.EntitlementConverter;
import org.osiam.resources.scim.Entitlement;
import org.osiam.storage.entities.EntitlementEntity;
import org.osiam.storage.entities.UserEntity;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Set;

/**
 * The EntitlementsUpdater provides the functionality to update the {@link EntitlementEntity} of a UserEntity
 */
@Service
class EntitlementsUpdater {

    private EntitlementConverter entitlementConverter;

    @Autowired
    public EntitlementsUpdater(EntitlementConverter entitlementConverter) {
        this.entitlementConverter = entitlementConverter;
    }

    /**
     * updates (adds new, delete, updates) the {@link EntitlementEntity}'s of the given {@link UserEntity} based on the
     * given List of Entitlement's
     *
     * @param entitlements list of Entitlement's to be deleted, updated or added
     * @param userEntity   user who needs to be updated
     * @param attributes   all {@link EntitlementEntity}'s will be deleted if this Set contains 'entitlements'
     */
    void update(List<Entitlement> entitlements, UserEntity userEntity, Set<String> attributes) {

        if (attributes.contains("entitlements")) {
            userEntity.removeAllEntitlements();
        }

        if (entitlements != null) {
            for (Entitlement scimEntitlements : entitlements) {
                EntitlementEntity entitlementsEntity = entitlementConverter.fromScim(scimEntitlements);
                userEntity.removeEntitlement(entitlementsEntity); // we always have to remove the entitlement's in case
                // the primary attribute has changed
                if (Strings.isNullOrEmpty(scimEntitlements.getOperation())
                        || !scimEntitlements.getOperation().equalsIgnoreCase("delete")) {

                    ensureOnlyOnePrimaryEntitlementExists(entitlementsEntity, userEntity.getEntitlements());
                    userEntity.addEntitlement(entitlementsEntity);
                }
            }
        }
    }

    /**
     * if the given newEntitlement is set to primary the primary attribute of all existing entitlement's in the
     * {@link UserEntity} will be removed
     *
     * @param newEntitlement to be checked if it is primary
     * @param entitlements   all existing entitlement's of the {@link UserEntity}
     */
    private void ensureOnlyOnePrimaryEntitlementExists(EntitlementEntity newEntitlement,
                                                       Set<EntitlementEntity> entitlements) {
        if (newEntitlement.isPrimary()) {
            for (EntitlementEntity exisitngEntitlementEntity : entitlements) {
                if (exisitngEntitlementEntity.isPrimary()) {
                    exisitngEntitlementEntity.setPrimary(false);
                }
            }
        }
    }

}