org.apache.camel.spi.CamelBeanPostProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation
The Camel API
There is a newer version: 4.9.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      http://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.apache.camel.spi;

/**
 * Bean post processor.
 */
public interface CamelBeanPostProcessor {

    /**
     * Apply this post processor to the given new bean instance before any bean initialization callbacks (like
     * afterPropertiesSet or a custom init-method). The bean will already be populated with property
     * values. The returned bean instance may be a wrapper around the original.
     *
     * @param  bean      the new bean instance
     * @param  beanName  the name of the bean
     * @return           the bean instance to use, either the original or a wrapped one; if null, no
     *                   subsequent BeanPostProcessors will be invoked
     * @throws Exception is thrown if error post processing bean
     */
    default Object postProcessBeforeInitialization(Object bean, String beanName) throws Exception {
        return bean;
    }

    /**
     * Apply this post processor to the given new bean instance after any bean initialization callbacks (like
     * afterPropertiesSet or a custom init-method). The bean will already be populated with property
     * values. The returned bean instance may be a wrapper around the original.
     *
     * @param  bean      the new bean instance
     * @param  beanName  the name of the bean
     * @return           the bean instance to use, either the original or a wrapped one; if null, no
     *                   subsequent BeanPostProcessors will be invoked
     * @throws Exception is thrown if error post processing bean
     */
    default Object postProcessAfterInitialization(Object bean, String beanName) throws Exception {
        return bean;
    }

    /**
     * Can be used to turn off bean post processing.
     *
     * Be careful to turn this off, as this means that beans that use Camel annotations such as
     * {@link org.apache.camel.EndpointInject}, {@link org.apache.camel.ProducerTemplate},
     * {@link org.apache.camel.Produce}, {@link org.apache.camel.Consume} etc will not be injected and in use.
     *
     * Turning this off should only be done if you are sure you do not use any of these Camel features.
     */
    default void setEnabled(boolean enabled) {
        // noop
    }

    /**
     * @see #setEnabled(boolean)
     */
    default boolean isEnabled() {
        return true;
    }

}