001/*
002 * Copyright 2002-2012 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.context;
018
019import javax.servlet.ServletConfig;
020
021import org.springframework.beans.factory.Aware;
022
023/**
024 * Interface to be implemented by any object that wishes to be notified of the
025 * {@link ServletConfig} (typically determined by the {@link WebApplicationContext})
026 * that it runs in.
027 *
028 * <p>Note: Only satisfied if actually running within a Servlet-specific
029 * WebApplicationContext. Otherwise, no ServletConfig will be set.
030 *
031 * @author Juergen Hoeller
032 * @author Chris Beams
033 * @since 2.0
034 * @see ServletContextAware
035 */
036public interface ServletConfigAware extends Aware {
037
038        /**
039         * Set the {@link ServletConfig} that this object runs in.
040         * <p>Invoked after population of normal bean properties but before an init
041         * callback like InitializingBean's {@code afterPropertiesSet} or a
042         * custom init-method. Invoked after ApplicationContextAware's
043         * {@code setApplicationContext}.
044         * @param servletConfig ServletConfig object to be used by this object
045         * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet
046         * @see org.springframework.context.ApplicationContextAware#setApplicationContext
047         */
048        void setServletConfig(ServletConfig servletConfig);
049
050}