/*

  * 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.validators;

 import org.apache.commons.latka.Validator;

 import org.apache.commons.latka.ValidationException;

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

 import org.apache.regexp.RE;

 import org.apache.regexp.RESyntaxException;

 /**

  * Perform regular expression matches on the body of

  * the HTTP response.  Setting the "condition" attribute

  * of the test indicates whether or not a match 

  * is expected.  If the server returns a <i>null</i> 

  * (e.g. in the case of an empty HEAD response), the 

  * validator will always fail, regardless of the setting

  * of the "condition" attribute.

  * 

  * @author Morgan Delagrange

  * @author dIon Gillard

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

  */

 public class RegexpValidator extends BaseConditionalValidator implements Validator {

     // --------------------------------------------------------------- Attributes

     protected String _pattern = null;

     protected boolean _ignoreCase = false;

     protected static final String BARE_EXCEPTION_MESSAGE = " TO MATCH PATTERN: ";

     // ------------------------------------------------------------- Constructors

     public RegexpValidator() {

         this(null,null,true,false);

     }

     public RegexpValidator(String label) {

         this(label,null,true,false);

     }

     public RegexpValidator(String label, String pattern, boolean cond, boolean ignoreCase) {

         super(label, cond);

         _pattern = pattern;

         _ignoreCase = ignoreCase;

     }

     // ------------------------------------------------------------------ Methods

     public void setPattern(String pattern) {

         _pattern = pattern;

     }

     public void setIgnoreCase(boolean ignoreCase) {

         _ignoreCase = ignoreCase;

     }

     public boolean assertTrue(Response response)

     throws ValidationException {

         String responseBody = response.getResource();

         if (responseBody == null) {

             fail("HTTP RESPONSE BODY WAS NULL");

         }

         RE r = null;

         try {

             r = new RE(_pattern);  // Compile expression

         } catch (RESyntaxException e) {

             fail(e.toString());

         }

         if (_ignoreCase == true) {

             r.setMatchFlags(RE.MATCH_CASEINDEPENDENT);

         }

         boolean matched =

           r.match(response.getResource()); // Match against expression

         return matched;

     }

     public String generateBareExceptionMessage() {

         return BARE_EXCEPTION_MESSAGE + _pattern;

     }

 }