/*

  * Copyright 1999-2002,2004 The Apache Software Foundation.

  * 

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  * 

  *      http://www.apache.org/licenses/LICENSE-2.0

  * 

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.apache.commons.latka.jelly.validators;

 import org.apache.commons.jelly.JellyTagException;

 import org.apache.commons.jelly.TagSupport;

 import org.apache.commons.jelly.XMLOutput;

 import org.apache.commons.latka.LatkaException;

 import org.apache.commons.latka.Validator;

 import org.apache.commons.latka.ValidationException;

 import org.apache.commons.latka.event.LatkaEventInfo;

 import org.apache.commons.latka.event.RequestFailedEvent;

 import org.apache.commons.latka.http.Response;

 import org.apache.commons.latka.jelly.JellyUtils;

 import org.apache.commons.latka.jelly.RequestTag;

 import org.apache.log4j.Category;

 /**

  * A base class for validation tags

  *

  * @author Morgan Delagrange

  * @author dIon Gillard

  * @version $Id: HttpValidatorTagSupport.java 155424 2005-02-26 13:09:29Z dirkv $

  */

 public abstract class HttpValidatorTagSupport extends TagSupport {

     /** the response being validated */

     protected Response _response = null;

     /** the listener handling request success/failure etc */

     protected LatkaEventInfo _listener = null;

     /** label for the test */

     protected String _label = null;

     protected static final Category _log = Category.getInstance(HttpValidatorTagSupport.class);

     public HttpValidatorTagSupport() {

     }

     public abstract Validator getValidator();

     /**

      * Provides a default implementation for simple validation

      * tags.  Will execute the validator produced by 

      * getValidator().  Override if necessary.

      * 

      * @param xmlOutput a place to write output

      * @exception JellyTagException if the tag body could not be invoked

      */

     public void doTag(XMLOutput xmlOutput) throws JellyTagException {

         invokeBody(xmlOutput);

         Validator validator = getValidator();

         validate(validator);

     }

     /**

      * Called by the ValidationFactory.

      *

      * @param listener supplier of information about the suite/progress

      * @param tagName name of the validating tag

      * @param reader xml to process 

      * @param response response to validate

      */

     public void init() {

         RequestTag tag = 

             (RequestTag) findAncestorWithClass(RequestTag.class);

         try {

             _response = tag.getResponse();

         } catch (LatkaException e) {

             _log.error("Unexpected exception, should have been caught earlier.");

         }

         _listener = JellyUtils.getInstance().getLatkaEventInfo(getContext());

     }

     public void setLabel(String label) {

         _label = label;

     }

     /**

      * the response being validated

      * @return the response being validated

      */

     public Response getResponse() {

         return _response;

     }

     /**

      * validate the response using the validator provided.

      * This method will notify the listener in the event

      * of a failure.  Will return false and not execute

      * the validation if the request is already invalid.

      * 

      * @param validator the object that performs validation

      * @return whether or not the request passed validation

      */

     public boolean validate(Validator validator) {

         init();

         if (_log.isDebugEnabled()) {

             _log.debug("performing custom validation");

             _log.debug("validator = " + validator);

             _log.debug("response = " + _response);

         }

         // if there's no response, or the request failed, skip it

         if (_response == null 

             || !_listener.didRequestSucceed(_response.getRequest())) {

             _log.debug("Validator skipped");

             return false;

         }

         boolean valid = true;

         try {

             validator.validate(_response);

         } catch (ValidationException e) {

             _listener.requestFailed(

                 new RequestFailedEvent(_response.getRequest(), _response, e));

             valid = false;

         }

         _log.debug("custom validation complete");

         return valid;

     }

 }