org.apache.struts.action.ActionMapping Maven / Gradle / Ivy
/*
* $Id$
*
* 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 org.apache.struts.action;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.config.ActionConfig;
import org.apache.struts.config.ControllerConfig;
import org.apache.struts.config.ForwardConfig;
import java.util.ArrayList;
/**
* An ActionMapping represents the information that the
* controller, RequestProcessor, knows about the mapping of a
* particular request to an instance of a particular Action
* class. The ActionMapping instance used to select a particular
* Action is passed on to that Action, thereby
* providing access to any custom configuration information included with the
* ActionMapping object.
*
* Since Struts 1.1 this class extends ActionConfig.
*
*
NOTE - This class would have been deprecated and
* replaced by org.apache.struts.config.ActionConfig except for
* the fact that it is part of the public API that existing applications are
* using.
*
* @version $Rev$ $Date: 2005-08-26 21:58:39 -0400 (Fri, 26 Aug 2005)
* $
*/
public class ActionMapping extends ActionConfig {
/**
* Commons Logging instance.
*
* @since Struts 1.2.8
*/
private static Log log = LogFactory.getLog(ActionMapping.class);
/**
* Find and return the ForwardConfig instance defining how
* forwarding to the specified logical name should be handled. This is
* performed by checking local and then global configurations for the
* specified forwarding configuration. If no forwarding configuration can
* be found, return null.
*
* @param forwardName Logical name of the forwarding instance to be
* returned
* @return The local or global forward with the specified name.
* @see #findRequiredForward(String)
*/
public ActionForward findForward(String forwardName) {
ForwardConfig config = findForwardConfig(forwardName);
if (config == null) {
config = getModuleConfig().findForwardConfig(forwardName);
}
// TODO: remove warning since findRequiredForward takes care of use case?
if (config == null) {
if (log.isWarnEnabled()) {
log.warn("Unable to find '" + forwardName + "' forward.");
}
}
return ((ActionForward) config);
}
/**
* Find and return the ForwardConfig instance of this
* mapping, throwing an exception if not found locally or globally.
*
* @param forwardName Logical name of the forwarding instance to be
* returned
* @return The local or global forward with the specified name.
* @throws IllegalStateException if the forward is not found
* @see #findForward(String)
* @since Struts 1.4
*/
public ActionForward findRequiredForward(String forwardName) {
ActionForward forward = findForward(forwardName);
if (forward == null) {
throw new IllegalStateException(
"Unable to find '" + forwardName +
"' forward of action path '" + getPath() + "'");
}
return forward;
}
/**
* Return the logical names of all locally defined forwards for this
* mapping. If there are no such forwards, a zero-length array is
* returned.
*
* @return The forward names for this action mapping.
*/
public String[] findForwards() {
ArrayList results = new ArrayList();
ForwardConfig[] fcs = findForwardConfigs();
for (int i = 0; i < fcs.length; i++) {
results.add(fcs[i].getName());
}
return ((String[]) results.toArray(new String[results.size()]));
}
/**
* Create (if necessary) and return an {@link ActionForward} that
* corresponds to the input property of this Action.
*
* Since Struts 1.4:
* If the input property is not specified and the Controller
* is configured to interpret the property as a forward, return the
* forward named "input" (if it exists) in this action mapping.
*
* @return The input forward for this action mapping.
* @see ControllerConfig#getInputForward()
* @since Struts 1.1
*/
public ActionForward getInputForward() {
String input = getInput();
if (getModuleConfig().getControllerConfig().getInputForward()) {
if (input != null) {
return findForward(input);
}
return findForward(Action.INPUT);
}
return (new ActionForward(input));
}
}