001    /*
002     * Copyright 1999-2002,2004 The Apache Software Foundation.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     *      http://www.apache.org/licenses/LICENSE-2.0
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.apache.commons.latka;
018    
019    import org.apache.commons.latka.http.Response;
020    
021    /**
022     * This is the standard interface for custom validation of an HTTP
023     * Response in Latka.  All custom validators need to implement
024     * a Validator class and a ValidationHandler class.
025     *
026     * @see org.apache.commons.latka.http.Response
027     * @see org.apache.commons.latka.xml.ValidationHandler
028     *
029     * @author Doug Sale
030     * @author dIon Gillard
031     * @version $Revision: 155424 $
032     */
033    public interface Validator {
034        
035        /**
036         * Run custom validation.  Latka will
037         * provide the HTTP response to this method.  The implementer
038         * should throw a ValidationException if the Response fails
039         * to meet the validation criteria.
040         *
041         * @param response the HTTP response
042         * @throws ValidationException if the Response fails to be valid
043         */
044        void validate(Response response) throws ValidationException;
045    }