keycloakjar.org.springframework.beans.factory.aot.BeanFactoryInitializationAotProcessor Maven / Gradle / Ivy
Show all versions of camunda-platform-7-keycloak-all Show documentation
/*
* Copyright 2002-2022 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 org.springframework.beans.factory.aot;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.lang.Nullable;
/**
* AOT processor that makes bean factory initialization contributions by
* processing {@link ConfigurableListableBeanFactory} instances.
*
* {@code BeanFactoryInitializationAotProcessor} implementations may be
* registered in a {@value AotServices#FACTORIES_RESOURCE_LOCATION} resource or
* as a bean.
*
*
Using this interface on a registered bean will cause the bean and
* all of its dependencies to be initialized during AOT processing. We generally
* recommend that this interface is only used with infrastructure beans such as
* {@link BeanFactoryPostProcessor} which have limited dependencies and are
* already initialized early in the bean factory lifecycle. If such a bean is
* registered using a factory method, make sure to make it {@code static} so
* that its enclosing class does not have to be initialized.
*
*
A component that implements this interface is not contributed.
*
* @author Phillip Webb
* @author Stephane Nicoll
* @since 6.0
* @see BeanFactoryInitializationAotContribution
*/
@FunctionalInterface
public interface BeanFactoryInitializationAotProcessor {
/**
* Process the given {@link ConfigurableListableBeanFactory} instance
* ahead-of-time and return a contribution or {@code null}.
*
Processors are free to use any techniques they like to analyze the given
* bean factory. Most typically use reflection to find fields or methods to
* use in the contribution. Contributions typically generate source code or
* resource files that can be used when the AOT optimized application runs.
*
If the given bean factory does not contain anything that is relevant to
* the processor, this method should return a {@code null} contribution.
* @param beanFactory the bean factory to process
* @return a {@link BeanFactoryInitializationAotContribution} or {@code null}
*/
@Nullable
BeanFactoryInitializationAotContribution processAheadOfTime(ConfigurableListableBeanFactory beanFactory);
}