/*
 * Copyright 2012-2019 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.boot.web.server;

import org.springframework.beans.factory.config.BeanPostProcessor;

Strategy interface for customizing web server factories. Any beans of this type will get a callback with the server factory before the server itself is started, so you can set the port, address, error pages etc.

Beware: calls to this interface are usually made from a WebServerFactoryCustomizerBeanPostProcessor which is a BeanPostProcessor (so called very early in the ApplicationContext lifecycle). It might be safer to lookup dependencies lazily in the enclosing BeanFactory rather than injecting them with @Autowired.

Author:Phillip Webb, Dave Syer, Brian Clozel
Type parameters:
  • <T> – the configurable web server factory
See Also:
Since:2.0.0
/** * Strategy interface for customizing {@link WebServerFactory web server factories}. Any * beans of this type will get a callback with the server factory before the server itself * is started, so you can set the port, address, error pages etc. * <p> * Beware: calls to this interface are usually made from a * {@link WebServerFactoryCustomizerBeanPostProcessor} which is a * {@link BeanPostProcessor} (so called very early in the ApplicationContext lifecycle). * It might be safer to lookup dependencies lazily in the enclosing BeanFactory rather * than injecting them with {@code @Autowired}. * * @param <T> the configurable web server factory * @author Phillip Webb * @author Dave Syer * @author Brian Clozel * @since 2.0.0 * @see WebServerFactoryCustomizerBeanPostProcessor */
@FunctionalInterface public interface WebServerFactoryCustomizer<T extends WebServerFactory> {
Customize the specified WebServerFactory.
Params:
  • factory – the web server factory to customize
/** * Customize the specified {@link WebServerFactory}. * @param factory the web server factory to customize */
void customize(T factory); }