View Javadoc

1   /*
2    * $Id: ValidatorActionForm.java 471754 2006-11-06 14:55:09Z husted $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  package org.apache.struts.validator;
22  
23  import org.apache.struts.action.ActionMapping;
24  
25  import javax.servlet.http.HttpServletRequest;
26  
27  import java.io.Serializable;
28  
29  /**
30   * <p>This class extends <strong>ValidatorForm</strong> and provides basic
31   * field validation based on an XML file.  The key passed into the validator
32   * is the action element's 'path' attribute from the struts-config.xml which
33   * should match the form element's name attribute in the validation.xml.</p>
34   *
35   * <ul>
36   *
37   * <li>See <code>ValidatorPlugin</code> definition in struts-config.xml for
38   * validation rules.</li>
39   *
40   * </ul>
41   *
42   * @version $Rev: 471754 $ $Date: 2005-05-07 12:11:38 -0400 (Sat, 07 May 2005)
43   *          $
44   * @since Struts 1.1
45   */
46  public class ValidatorActionForm extends ValidatorForm implements Serializable {
47      /**
48       * Returns the Validation key.
49       *
50       * @param mapping The mapping used to select this instance
51       * @param request The servlet request we are processing
52       * @return validation key - the action element's 'path' attribute in this
53       *         case
54       */
55      public String getValidationKey(ActionMapping mapping,
56          HttpServletRequest request) {
57          return mapping.getPath();
58      }
59  }