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.portlet.context;
018
019import javax.portlet.PortletConfig;
020
021import org.springframework.beans.factory.Aware;
022
023/**
024 * Interface to be implemented by any object that wishes to be notified
025 * of the PortletConfig (typically determined by the PortletApplicationContext)
026 * that it runs in.
027 *
028 * @author Juergen Hoeller
029 * @author Chris Beams
030 * @since 2.0
031 * @see PortletContextAware
032 */
033public interface PortletConfigAware extends Aware {
034
035        /**
036         * Set the PortletConfigthat this object runs in.
037         * <p>Invoked after population of normal bean properties but before an init
038         * callback like InitializingBean's afterPropertiesSet or a custom init-method.
039         * Invoked after ApplicationContextAware's setApplicationContext.
040         * @param portletConfig PortletConfig object to be used by this object
041         */
042        void setPortletConfig(PortletConfig portletConfig);
043
044}