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.logging.log4j.LogManager;
27  import org.apache.logging.log4j.Logger;
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      implements Valve
42  {
43      private static final Logger log
44          = LogManager.getLogger(DetermineActionValve.class);
45  
46      /**
47       * @see org.apache.turbine.pipeline.Valve#invoke(PipelineData, ValveContext)
48       */
49      @Override
50      public void invoke(PipelineData pipelineData, ValveContext context)
51          throws IOException, TurbineException
52      {
53          RunData data = pipelineData.getRunData();
54          if (!data.hasAction())
55          {
56              String action =
57                  data.getParameters().getString(URIConstants.CGI_ACTION_PARAM);
58  
59              if (action != null)
60              {
61                  data.setAction(action);
62                  log.debug("Set action from request parameter");
63              }
64              else
65              {
66                  log.debug("No action");
67              }
68          }
69  
70          log.debug("Action is now: {}", data::getAction);
71  
72          // Pass control to the next Valve in the Pipeline
73          context.invokeNext(pipelineData);
74      }
75  }