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.PortletContext;
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 PortletContext (typically determined by the PortletApplicationContext)
026 * that it runs in.
027 *
028 * @author Juergen Hoeller
029 * @author William G. Thompson, Jr.
030 * @author Chris Beams
031 * @since 2.0
032 * @see PortletConfigAware
033 */
034public interface PortletContextAware extends Aware {
035
036        /**
037         * Set the PortletContext that this object runs in.
038         * <p>Invoked after population of normal bean properties but before an init
039         * callback like InitializingBean's afterPropertiesSet or a custom init-method.
040         * Invoked after ApplicationContextAware's setApplicationContext.
041         * @param portletContext PortletContext object to be used by this object
042         */
043        void setPortletContext(PortletContext portletContext);
044
045}