    001package org.apache.turbine.modules.actions;
    002
    003/*
    004 * Licensed to the Apache Software Foundation (ASF) under one
    005 * or more contributor license agreements.  See the NOTICE file
    006 * distributed with this work for additional information
    007 * regarding copyright ownership.  The ASF licenses this file
    008 * to you under the Apache License, Version 2.0 (the
    009 * "License"); you may not use this file except in compliance
    010 * with the License.  You may obtain a copy of the License at
    011 *
    012 *   http://www.apache.org/licenses/LICENSE-2.0
    013 *
    014 * Unless required by applicable law or agreed to in writing,
    015 * software distributed under the License is distributed on an
    016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    017 * KIND, either express or implied.  See the License for the
    018 * specific language governing permissions and limitations
    019 * under the License.
    020 */
    021
    022
    023import static org.junit.Assert.assertNotNull;
    024
    025import org.apache.commons.logging.Log;
    026import org.apache.commons.logging.LogFactory;
    027import org.apache.turbine.annotation.TurbineActionEvent;
    028import org.apache.turbine.pipeline.PipelineData;
    029import org.apache.turbine.util.RunData;
    030import org.apache.velocity.context.Context;
    031/**
    032 * This action is used in testing the ExecutePageValve by the ExecutePageValveTest.
    033 *
    034 * @author     <a href="mailto:epugh@upstate.com">Eric Pugh</a>
    035 * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
    036 */
    037public class VelocityActionDoesNothing extends VelocityAction
    038{
    039    private static Log log = LogFactory.getLog(VelocityActionDoesNothing.class);
    040    public static int numberOfCalls;
    041    public static int pipelineDataCalls;
    042    public static int actionEventCalls;
    043
    044    /**
    045     *  Default action is throw an exception.
    046     *
    047     * @param  pipelineData           Current RunData information
    048     * @param  context        Context to populate
    049     * @throws  Exception  Thrown on error
    050     */
    051    @Override
    052    public void doPerform(PipelineData pipelineData, Context context) throws Exception
    053    {
    054        log.debug("Calling doPerform(PipelineData)");
    055                VelocityActionDoesNothing.numberOfCalls++;
    056        RunData rd = (RunData)pipelineData;
    057                assertNotNull("PipelineData object was Null.", rd);
    058                VelocityActionDoesNothing.pipelineDataCalls++;
    059    }
    060
    061    /**
    062     *  Annotated action method.
    063     *
    064     * @param  pipelineData           Current RunData information
    065     * @param  context        Context to populate
    066     * @throws  Exception  Thrown on error
    067     */
    068    @TurbineActionEvent("annotatedEvent") // subject to URL folding
    069    public void arbitraryMethodName(PipelineData pipelineData, Context context) throws Exception
    070    {
    071        log.debug("Calling arbitraryMethodName(PipelineData)");
    072        VelocityActionDoesNothing.numberOfCalls++;
    073        RunData rd = (RunData)pipelineData;
    074        assertNotNull("RunData object was Null.", rd);
    075        VelocityActionDoesNothing.actionEventCalls++;
    076    }
    077}