| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package com.opensymphony.xwork2; |
| |
| import com.opensymphony.xwork2.config.Configuration; |
| import com.opensymphony.xwork2.config.ConfigurationException; |
| import com.opensymphony.xwork2.config.entities.ActionConfig; |
| import com.opensymphony.xwork2.inject.Inject; |
| import org.apache.commons.text.StringEscapeUtils; |
| import org.apache.commons.lang3.StringUtils; |
| import org.apache.logging.log4j.LogManager; |
| import org.apache.logging.log4j.Logger; |
| |
| import java.io.Serializable; |
| import java.util.Locale; |
| |
| /** |
| * The Default ActionProxy implementation |
| * |
| * @author Rainer Hermanns |
| * @author Revised by <a href="mailto:hu_pengfei@yahoo.com.cn">Henry Hu</a> |
| * @author tmjee |
| * @since 2005-8-6 |
| */ |
| public class DefaultActionProxy implements ActionProxy, Serializable { |
| |
| private static final long serialVersionUID = 3293074152487468527L; |
| |
| private static final Logger LOG = LogManager.getLogger(DefaultActionProxy.class); |
| |
| protected Configuration configuration; |
| protected ActionConfig config; |
| protected ActionInvocation invocation; |
| protected UnknownHandlerManager unknownHandlerManager; |
| protected LocalizedTextProvider localizedTextProvider; |
| |
| protected String actionName; |
| protected String namespace; |
| protected String method; |
| protected boolean executeResult; |
| protected boolean cleanupContext; |
| |
| protected ObjectFactory objectFactory; |
| |
| protected ActionEventListener actionEventListener; |
| |
| private boolean methodSpecified = true; |
| |
| /** |
| * This constructor is private so the builder methods (create*) should be used to create an DefaultActionProxy. |
| * |
| * <p> |
| * The reason for the builder methods is so that you can use a subclass to create your own DefaultActionProxy instance |
| * </p> |
| * |
| * (like a RMIActionProxy). |
| * |
| * @param inv the action invocation |
| * @param namespace the namespace |
| * @param actionName the action name |
| * @param methodName the method name |
| * @param executeResult execute result |
| * @param cleanupContext cleanup context |
| */ |
| protected DefaultActionProxy(ActionInvocation inv, String namespace, String actionName, String methodName, boolean executeResult, boolean cleanupContext) { |
| |
| this.invocation = inv; |
| this.cleanupContext = cleanupContext; |
| LOG.debug("Creating an DefaultActionProxy for namespace [{}] and action name [{}]", namespace, actionName); |
| |
| this.actionName = StringEscapeUtils.escapeHtml4(actionName); |
| this.namespace = namespace; |
| this.executeResult = executeResult; |
| this.method = StringEscapeUtils.escapeEcmaScript(StringEscapeUtils.escapeHtml4(methodName)); |
| } |
| |
| @Inject |
| public void setObjectFactory(ObjectFactory factory) { |
| this.objectFactory = factory; |
| } |
| |
| @Inject |
| public void setConfiguration(Configuration config) { |
| this.configuration = config; |
| } |
| |
| @Inject |
| public void setUnknownHandler(UnknownHandlerManager unknownHandlerManager) { |
| this.unknownHandlerManager = unknownHandlerManager; |
| } |
| |
| @Inject(required = false) |
| public void setActionEventListener(ActionEventListener listener) { |
| this.actionEventListener = listener; |
| } |
| |
| @Inject |
| public void setLocalizedTextProvider(LocalizedTextProvider localizedTextProvider) { |
| this.localizedTextProvider = localizedTextProvider; |
| } |
| |
| public Object getAction() { |
| return invocation.getAction(); |
| } |
| |
| public String getActionName() { |
| return actionName; |
| } |
| |
| public ActionConfig getConfig() { |
| return config; |
| } |
| |
| public void setExecuteResult(boolean executeResult) { |
| this.executeResult = executeResult; |
| } |
| |
| public boolean getExecuteResult() { |
| return executeResult; |
| } |
| |
| public ActionInvocation getInvocation() { |
| return invocation; |
| } |
| |
| public String getNamespace() { |
| return namespace; |
| } |
| |
| public String execute() throws Exception { |
| ActionContext nestedContext = ActionContext.getContext(); |
| ActionContext.bind(invocation.getInvocationContext()); |
| |
| try { |
| return invocation.invoke(); |
| } finally { |
| if (cleanupContext) { |
| ActionContext.bind(nestedContext); |
| } |
| } |
| } |
| |
| |
| public String getMethod() { |
| return method; |
| } |
| |
| private void resolveMethod() { |
| // if the method is set to null, use the one from the configuration |
| // if the one from the configuration is also null, use "execute" |
| if (StringUtils.isEmpty(this.method)) { |
| this.method = config.getMethodName(); |
| if (StringUtils.isEmpty(this.method)) { |
| this.method = ActionConfig.DEFAULT_METHOD; |
| } |
| methodSpecified = false; |
| } |
| } |
| |
| protected void prepare() { |
| config = configuration.getRuntimeConfiguration().getActionConfig(namespace, actionName); |
| |
| if (config == null && unknownHandlerManager.hasUnknownHandlers()) { |
| config = unknownHandlerManager.handleUnknownAction(namespace, actionName); |
| } |
| if (config == null) { |
| throw new ConfigurationException(getErrorMessage()); |
| } |
| |
| resolveMethod(); |
| |
| if (config.isAllowedMethod(method)) { |
| invocation.init(this); |
| } else { |
| throw new ConfigurationException(prepareNotAllowedErrorMessage()); |
| } |
| } |
| |
| protected String prepareNotAllowedErrorMessage() { |
| return localizedTextProvider.findDefaultText( |
| "struts.exception.method-not-allowed", |
| Locale.getDefault(), |
| new String[]{method, actionName} |
| ); |
| } |
| |
| protected String getErrorMessage() { |
| if ((namespace != null) && (namespace.trim().length() > 0)) { |
| return localizedTextProvider.findDefaultText( |
| "xwork.exception.missing-package-action", |
| Locale.getDefault(), |
| new String[]{namespace, actionName}); |
| } else { |
| return localizedTextProvider.findDefaultText( |
| "xwork.exception.missing-action", |
| Locale.getDefault(), |
| new String[]{actionName}); |
| } |
| } |
| |
| public boolean isMethodSpecified() { |
| return methodSpecified; |
| } |
| } |