de.cuioss.portal.authentication.PortalUserEnricher Maven / Gradle / Ivy
Show all versions of portal-authentication-api Show documentation
/*
* 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;
import de.cuioss.portal.authentication.facade.AuthenticationFacade;
import de.cuioss.portal.common.priority.PortalPriorities;
import jakarta.servlet.http.HttpServletRequest;
import java.util.function.Function;
/**
* To enrich an {@link AuthenticatedUserInfo} created by the {@link AuthenticationFacade}.
*
* Implementations of this interface will be called as part of
* {@link AuthenticationFacade#retrieveCurrentAuthenticationContext(HttpServletRequest)}.
*
* Multiple implementations can be specified, and differentiated by
* {@link PortalPriorities}.
*
* The highest priority is called last.
*
* The enriched {@linkplain AuthenticatedUserInfo} should be returned as a result.
*
* If no enrichment is done, the same object should be returned, but never null.
*/
public interface PortalUserEnricher extends Function {
}