org.apache.struts.action.ActionMapping Maven / Gradle / Ivy

/*
 * $Id: ActionMapping.java 471754 2006-11-06 14:55:09Z husted $
 *
 * 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.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: 471754 $ $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.
     */
    public ActionForward findForward(String forwardName) {
        ForwardConfig config = findForwardConfig(forwardName);

        if (config == null) {
            config = getModuleConfig().findForwardConfig(forwardName);
        }

        if (config == null) {
            if (log.isWarnEnabled()) {
                log.warn("Unable to find '" + forwardName + "' forward.");
            }
        }

        return ((ActionForward) config);
    }

    /**
     * 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.
     *
     * @return The input forward for this action mapping.
     * @since Struts 1.1
     */
    public ActionForward getInputForward() {
        if (getModuleConfig().getControllerConfig().getInputForward()) {
            return (findForward(getInput()));
        } else {
            return (new ActionForward(getInput()));
        }
    }
}