1. /*
  2. * Copyright 2002-2004 the original author or authors.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. package org.springframework.web.context;
  17. import javax.servlet.ServletContext;
  18. /**
  19. * Interface to be implemented by any object that wishes to be notified
  20. * of the ServletContext (typically determined by the WebApplicationContext)
  21. * that it runs in.
  22. *
  23. * <p>Can be implemented instead of ApplicationContextAware (casting the
  24. * context to WebApplicationContext) if all an object needs is a reference
  25. * to the ServletContext.
  26. *
  27. * @author Juergen Hoeller
  28. * @since 12.03.2004
  29. * @see org.springframework.context.ApplicationContextAware
  30. */
  31. public interface ServletContextAware {
  32. /**
  33. * Set the ServletContext that this object runs in.
  34. * <p>Invoked after population of normal bean properties but before an init
  35. * callback like InitializingBean's afterPropertiesSet or a custom init-method.
  36. * Invoked after ApplicationContextAware's setApplicationContext.
  37. * @param servletContext ServletContext object to be used by this object
  38. */
  39. void setServletContext(ServletContext servletContext);
  40. }