|
| 1 | +/* |
| 2 | + * Copyright 2002-2008 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 | + |
| 17 | +package org.springframework.web.servlet.view.tiles; |
| 18 | + |
| 19 | +import java.io.File; |
| 20 | +import java.io.IOException; |
| 21 | + |
| 22 | +import javax.servlet.ServletContext; |
| 23 | +import javax.servlet.ServletException; |
| 24 | +import javax.servlet.http.HttpServletRequest; |
| 25 | +import javax.servlet.http.HttpServletResponse; |
| 26 | + |
| 27 | +import org.apache.struts.tiles.ComponentContext; |
| 28 | +import org.apache.struts.tiles.ControllerSupport; |
| 29 | + |
| 30 | +import org.springframework.beans.BeansException; |
| 31 | +import org.springframework.context.ApplicationContext; |
| 32 | +import org.springframework.context.support.MessageSourceAccessor; |
| 33 | +import org.springframework.web.context.WebApplicationContext; |
| 34 | +import org.springframework.web.servlet.support.RequestContextUtils; |
| 35 | +import org.springframework.web.util.NestedServletException; |
| 36 | +import org.springframework.web.util.WebUtils; |
| 37 | + |
| 38 | +/** |
| 39 | + * Convenience class for Spring-aware Tiles component controllers. |
| 40 | + * Provides a reference to the current Spring application context, |
| 41 | + * e.g. for bean lookup or resource loading. |
| 42 | + * |
| 43 | + * <p>Derives from the Tiles {@link ControllerSupport} class rather than |
| 44 | + * implementing the Tiles {@link org.apache.struts.tiles.Controller} interface |
| 45 | + * in order to be compatible with Struts 1.1 and 1.2. Implements both Struts 1.1's |
| 46 | + * <code>perform</code> and Struts 1.2's <code>execute</code> method accordingly. |
| 47 | + * |
| 48 | + * @author Juergen Hoeller |
| 49 | + * @author Alef Arendsen |
| 50 | + * @since 22.08.2003 |
| 51 | + * @see org.springframework.web.context.support.WebApplicationObjectSupport |
| 52 | + * @deprecated as of Spring 3.0 |
| 53 | + */ |
| 54 | +@Deprecated |
| 55 | +public abstract class ComponentControllerSupport extends ControllerSupport { |
| 56 | + |
| 57 | + private WebApplicationContext webApplicationContext; |
| 58 | + |
| 59 | + private MessageSourceAccessor messageSourceAccessor; |
| 60 | + |
| 61 | + |
| 62 | + /** |
| 63 | + * This implementation delegates to <code>execute</code>, |
| 64 | + * converting non-Servlet/IO Exceptions to ServletException. |
| 65 | + * <p>This is the only execution method available in Struts 1.1. |
| 66 | + * @see #execute |
| 67 | + */ |
| 68 | + @Override |
| 69 | + public final void perform( |
| 70 | + ComponentContext componentContext, HttpServletRequest request, |
| 71 | + HttpServletResponse response, ServletContext servletContext) |
| 72 | + throws ServletException, IOException { |
| 73 | + |
| 74 | + try { |
| 75 | + execute(componentContext, request, response, servletContext); |
| 76 | + } |
| 77 | + catch (ServletException ex) { |
| 78 | + throw ex; |
| 79 | + } |
| 80 | + catch (IOException ex) { |
| 81 | + throw ex; |
| 82 | + } |
| 83 | + catch (Throwable ex) { |
| 84 | + throw new NestedServletException("Execution of component controller failed", ex); |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + /** |
| 89 | + * This implementation delegates to <code>doPerform</code>, |
| 90 | + * lazy-initializing the application context reference if necessary. |
| 91 | + * <p>This is the preferred execution method in Struts 1.2. |
| 92 | + * When running with Struts 1.1, it will be called by <code>perform</code>. |
| 93 | + * @see #perform |
| 94 | + * @see #doPerform |
| 95 | + */ |
| 96 | + @Override |
| 97 | + public final void execute( |
| 98 | + ComponentContext componentContext, HttpServletRequest request, |
| 99 | + HttpServletResponse response, ServletContext servletContext) |
| 100 | + throws Exception { |
| 101 | + |
| 102 | + synchronized (this) { |
| 103 | + if (this.webApplicationContext == null) { |
| 104 | + this.webApplicationContext = RequestContextUtils.getWebApplicationContext(request, servletContext); |
| 105 | + this.messageSourceAccessor = new MessageSourceAccessor(this.webApplicationContext); |
| 106 | + } |
| 107 | + } |
| 108 | + doPerform(componentContext, request, response); |
| 109 | + } |
| 110 | + |
| 111 | + |
| 112 | + /** |
| 113 | + * Subclasses can override this for custom initialization behavior. |
| 114 | + * Gets called on initialization of the context for this controller. |
| 115 | + * @throws org.springframework.context.ApplicationContextException in case of initialization errors |
| 116 | + * @throws org.springframework.beans.BeansException if thrown by application context methods |
| 117 | + */ |
| 118 | + protected void initApplicationContext() throws BeansException { |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * Return the current Spring ApplicationContext. |
| 123 | + */ |
| 124 | + protected final ApplicationContext getApplicationContext() { |
| 125 | + return this.webApplicationContext; |
| 126 | + } |
| 127 | + |
| 128 | + /** |
| 129 | + * Return the current Spring WebApplicationContext. |
| 130 | + */ |
| 131 | + protected final WebApplicationContext getWebApplicationContext() { |
| 132 | + return this.webApplicationContext; |
| 133 | + } |
| 134 | + |
| 135 | + /** |
| 136 | + * Return a MessageSourceAccessor for the application context |
| 137 | + * used by this object, for easy message access. |
| 138 | + */ |
| 139 | + protected final MessageSourceAccessor getMessageSourceAccessor() { |
| 140 | + return this.messageSourceAccessor; |
| 141 | + } |
| 142 | + |
| 143 | + /** |
| 144 | + * Return the current ServletContext. |
| 145 | + */ |
| 146 | + protected final ServletContext getServletContext() { |
| 147 | + return this.webApplicationContext.getServletContext(); |
| 148 | + } |
| 149 | + |
| 150 | + /** |
| 151 | + * Return the temporary directory for the current web application, |
| 152 | + * as provided by the servlet container. |
| 153 | + * @return the File representing the temporary directory |
| 154 | + */ |
| 155 | + protected final File getTempDir() { |
| 156 | + return WebUtils.getTempDir(getServletContext()); |
| 157 | + } |
| 158 | + |
| 159 | + |
| 160 | + /** |
| 161 | + * Perform the preparation for the component, allowing for any Exception to be thrown. |
| 162 | + * The ServletContext can be retrieved via getServletContext, if necessary. |
| 163 | + * The Spring WebApplicationContext can be accessed via getWebApplicationContext. |
| 164 | + * <p>This method will be called both in the Struts 1.1 and Struts 1.2 case, |
| 165 | + * by <code>perform</code> or <code>execute</code>, respectively. |
| 166 | + * @param componentContext current Tiles component context |
| 167 | + * @param request current HTTP request |
| 168 | + * @param response current HTTP response |
| 169 | + * @throws Exception in case of errors |
| 170 | + * @see org.apache.struts.tiles.Controller#perform |
| 171 | + * @see #getServletContext |
| 172 | + * @see #getWebApplicationContext |
| 173 | + * @see #perform |
| 174 | + * @see #execute |
| 175 | + */ |
| 176 | + protected abstract void doPerform( |
| 177 | + ComponentContext componentContext, HttpServletRequest request, HttpServletResponse response) |
| 178 | + throws Exception; |
| 179 | + |
| 180 | +} |
0 commit comments