View Javadoc

1   /*
2    * Copyright 1999-2002,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.latka;
18  
19  import org.apache.commons.latka.http.Response;
20  
21  /**
22   * This is the standard interface for custom validation of an HTTP
23   * Response in Latka.  All custom validators need to implement
24   * a Validator class and a ValidationHandler class.
25   *
26   * @see org.apache.commons.latka.http.Response
27   * @see org.apache.commons.latka.xml.ValidationHandler
28   *
29   * @author Doug Sale
30   * @author dIon Gillard
31   * @version $Revision: 155424 $
32   */
33  public interface Validator {
34      
35      /**
36       * Run custom validation.  Latka will
37       * provide the HTTP response to this method.  The implementer
38       * should throw a ValidationException if the Response fails
39       * to meet the validation criteria.
40       *
41       * @param response the HTTP response
42       * @throws ValidationException if the Response fails to be valid
43       */
44      void validate(Response response) throws ValidationException;
45  }