keycloakjar.org.springframework.beans.factory.aot.BeanRegistrationAotProcessor 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.BeanPostProcessor;
import org.springframework.beans.factory.support.RegisteredBean;
import org.springframework.lang.Nullable;
/**
* AOT processor that makes bean registration contributions by processing
* {@link RegisteredBean} instances.
*
* {@code BeanRegistrationAotProcessor} 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 BeanPostProcessor} 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.
*
*
An AOT processor replaces its usual runtime behavior by an optimized
* arrangement, usually in generated code. For that reason, a component that
* implements this interface is not contributed by default. If a component that
* implements this interface still needs to be invoked at runtime,
* {@link #isBeanExcludedFromAotProcessing} can be overridden.
*
* @author Phillip Webb
* @author Stephane Nicoll
* @since 6.0
* @see BeanRegistrationAotContribution
*/
@FunctionalInterface
public interface BeanRegistrationAotProcessor {
/**
* Process the given {@link RegisteredBean} instance ahead-of-time and
* return a contribution or {@code null}.
*
* Processors are free to use any techniques they like to analyze the given
* instance. 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 instance isn't relevant to the processor, it should return a
* {@code null} contribution.
* @param registeredBean the registered bean to process
* @return a {@link BeanRegistrationAotContribution} or {@code null}
*/
@Nullable
BeanRegistrationAotContribution processAheadOfTime(RegisteredBean registeredBean);
/**
* Return if the bean instance associated with this processor should be
* excluded from AOT processing itself. By default, this method returns
* {@code true} to automatically exclude the bean, if the definition should
* be written then this method may be overridden to return {@code true}.
* @return if the bean should be excluded from AOT processing
* @see BeanRegistrationExcludeFilter
*/
default boolean isBeanExcludedFromAotProcessing() {
return true;
}
}