/*

  * 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 java.text.MessageFormat;

 /**

  * Validates a Response according to its HTTP status code

  * (200, 301, 302, 404, etc).  Note: by default, Latka 

  * will automatically follow redirects.  If you want to

  * test for a 301 or 302 response, you will need to

  * set followRedirects="false" on the Latka request. 

  * 

  * @author Morgan Delagrange

  * @author dIon Gillard

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

  */

 public class StatusCodeValidator extends BaseValidator implements Validator {

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

   protected static final MessageFormat MESSAGE = new MessageFormat("Expected status code \"{0,number,000}\". Found \"{1,number,000}\".");

   protected int _statusCode = 200;

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

   public StatusCodeValidator() {

     this(null,200);

   }

   public StatusCodeValidator(int code) {

     this(null,code);

   }

   public StatusCodeValidator(String label) {

     this(label,200);

   }

   public StatusCodeValidator(String label, int code) {

     super(label);

     _statusCode = code;

   }

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

   public void setStatusCode(int statusCode) {

     _statusCode = statusCode;

   }

   public void validate(Response response)

     throws ValidationException {

     int responseStatusCode = response.getStatusCode();

     if (_statusCode != responseStatusCode) {

        fail(MESSAGE.format(new Object[] { new Integer(_statusCode), new Integer(responseStatusCode) }).toString());

     }

   }

 }