core/src/main/java/org/apache/struts/chain/commands/AbstractSetOriginalURI.java

/*
 * $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.chain.commands;

import org.apache.struts.Globals;
import org.apache.struts.chain.contexts.ActionContext;

/**
 * <p>Check to original uri is set, and if not, set it for this request.</p>
 *
 * @version $Rev$ $Date: 2005-06-04 07:58:46 -0700 (Sat, 04 Jun 2005)
 *          $
 */
public abstract class AbstractSetOriginalURI extends ActionCommandBase {
    // ---------------------------------------------------------- Public Methods

    /**
     * <p>Check to original uri is set, and if not, set it for this
     * request.</p>
     *
     * @param actionCtx The <code>Context</code> for the current request
     * @return <code>false</code> so that processing continues
     * @throws Exception if thrown by the Action class
     */
    public boolean execute(ActionContext actionCtx)
        throws Exception {
        // Set the original uri if not already set
        if (!actionCtx.getRequestScope().containsKey(Globals.ORIGINAL_URI_KEY)) {
            setOriginalURI(actionCtx);
        }

        return CONTINUE_PROCESSING;
    }

    // ------------------------------------------------------- Protected Methods

    /**
     * <p>Set the original uri.</p>
     *
     * @param context The <code>Context</code> for this request
     */
    protected abstract void setOriginalURI(ActionContext context);
}