View Javadoc

1   package org.apache.turbine.pipeline;
2   
3   
4   /*
5    * Licensed to the Apache Software Foundation (ASF) under one
6    * or more contributor license agreements.  See the NOTICE file
7    * distributed with this work for additional information
8    * regarding copyright ownership.  The ASF licenses this file
9    * to you under the Apache License, Version 2.0 (the
10   * "License"); you may not use this file except in compliance
11   * with the License.  You may obtain a copy of the License at
12   *
13   *   http://www.apache.org/licenses/LICENSE-2.0
14   *
15   * Unless required by applicable law or agreed to in writing,
16   * software distributed under the License is distributed on an
17   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18   * KIND, either express or implied.  See the License for the
19   * specific language governing permissions and limitations
20   * under the License.
21   */
22  
23  
24  import java.io.IOException;
25  
26  import org.apache.commons.logging.Log;
27  import org.apache.commons.logging.LogFactory;
28  import org.apache.turbine.util.RunData;
29  import org.apache.turbine.util.TurbineException;
30  import org.apache.turbine.util.uri.URIConstants;
31  
32  /**
33   * This valve is responsible for setting the 'action' property of RunData based
34   * on request parameter. There is no default action, since a null action is
35   * perfectly valid.
36   *
37   * @author <a href="mailto:james@jamestaylor.org">James Taylor</a>
38   * @author <a href="mailto:peter@courcoux.biz">Peter Courcoux</a>
39   */
40  public class DetermineActionValve
41      extends AbstractValve
42  {
43      private static final Log log
44          = LogFactory.getLog(DetermineActionValve.class);
45  
46      /**
47       * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
48       */
49      public void invoke(PipelineData pipelineData, ValveContext context)
50          throws IOException, TurbineException
51      {
52          RunData data = getRunData(pipelineData);
53          if (! data.hasAction())
54          {
55              String action =
56                  data.getParameters().getString(URIConstants.CGI_ACTION_PARAM);
57  
58              if (action != null)
59              {
60                  data.setAction(action);
61  
62                  log.debug("Set action from request parameter");
63              }
64              else
65              {
66                  log.debug("No action");
67              }
68          }
69  
70          if (log.isDebugEnabled())
71          {
72              log.debug("Action is now: " + data.getAction());
73          }
74  
75          // Pass control to the next Valve in the Pipeline
76          context.invokeNext(pipelineData);
77      }
78  }