de.cuioss.portal.authentication.facade.BaseAuthenticationFacade Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of portal-authentication-api Show documentation

Api for the different way of authentication within the portal

There is a newer version: 1.1.1

Show newest version

/*
 * Copyright 2023 the original author or authors.
 * 
 * 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
 * 

 * https://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 de.cuioss.portal.authentication.facade;

import de.cuioss.portal.authentication.AuthenticatedUserInfo;
import de.cuioss.portal.authentication.PortalUserEnricher;
import de.cuioss.portal.common.priority.PortalPriorities;
import jakarta.enterprise.inject.Instance;
import jakarta.inject.Inject;

import java.util.List;

import static de.cuioss.tools.collect.CollectionLiterals.mutableList;

/**
 * Abstract implementation to handle {@link PortalUserEnricher}s.
 */
public abstract class BaseAuthenticationFacade implements AuthenticationFacade {

    @Inject
    private Instance portalUserEnrichers;

    /**
     * Enriches the given {@link AuthenticatedUserInfo} using the available
     * {@link PortalUserEnricher} implementations that are part of the
     * cdi-context.
     * 

     * The {@linkplain PortalUserEnricher} are sorted via {@link PortalPriorities}
     * if multiple instances are found.
     * 
     * The enriched {@linkplain AuthenticatedUserInfo} is returned as a result.
     *
     * @param authenticatedUserInfo the instance to enrich
     * @return the enriched instance
     */
    protected AuthenticatedUserInfo enrich(AuthenticatedUserInfo authenticatedUserInfo) {
        final List sortedPortalUserEnrichers = PortalPriorities
                .sortByPriority(mutableList(portalUserEnrichers));
        var enrichedAuthenticatedUserInfo = authenticatedUserInfo;
        for (PortalUserEnricher portalUserEnricher : sortedPortalUserEnrichers) {
            enrichedAuthenticatedUserInfo = portalUserEnricher.apply(enrichedAuthenticatedUserInfo);
        }
        return enrichedAuthenticatedUserInfo;
    }

}