/*

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

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

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

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

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

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

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

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

 import java.util.HashMap;

 import java.util.LinkedList;

 import java.util.List;

 import java.util.Map;

 import org.apache.log4j.Category;

 /**

  * The base class for several 'reporters'.

  *

  * A reporter is a class that will store or record information about events that

  * occur during Latka processing

  *

  * @author Rodney Waldhoff

  * @author Morgan Delagrange

  * @version $Revision: 155424 $

  */

 public class DefaultLatkaEventInfo implements LatkaEventInfo {

     /**

      * maps the request to it's success or failure as a Boolean

      */

     protected Map _requestSucceeded = new HashMap();

     /**

      * maps the session to it's success or failure as a Boolean

      */

     protected Map _sessionSucceeded = new HashMap();

     /**

      * Holds whether or not the entire suite has succeeded

      * This is set to false when <strong>any</strong> request fails.

      */

     protected boolean _suiteSucceeded = true;

     /**

      * Holds the failed responses received by this object.

      * @see #requestFailed(RequestEvent)

      */

     protected List _failedResponses = new LinkedList();

     protected LatkaEventListener _listener = null;

     /**

      * The log4J category used for processing log requests.

      */

     protected static final Category _log =

                                 Category.getInstance(DefaultLatkaEventInfo.class);

     public DefaultLatkaEventInfo(LatkaEventListener listener) {

         _listener = listener;

     }

     /**

      * Invoked if the request succeeds.

      * Records the success

      *

      * @param event  a successful request event

      */

     public void requestSucceeded(RequestEvent event) {

         recordSuccess(event, true);

         _listener.requestSucceeded(event);

     }

     /**

      * Invoked if the request failed.

      * Records the failure and adds the request's response to the list of

      * failed responses

      *

      * @param event  a "failed" request event.

      */

     public void requestFailed(RequestEvent event) {

         recordSuccess(event, false);

         _failedResponses.add(event.getResponse());

         _listener.requestFailed(event);

     }

     /**

      * A skipped request.

      * Records the skip as a failure

      *

      * @param event  a "skipped" request.

      */

     public void requestSkipped(RequestEvent event) {

         recordSuccess(event, false);

         _listener.requestSkipped(event);

     }

     /**

      * Invoked if a request error occurs.

      * Records the error as a failure

      *

      * @param event  a request "error" event.

      */

     public void requestError(RequestEvent event) {

         recordSuccess(event, false);

         _listener.requestError(event);

     }

     /**

      * Invoked if a Latka suite wants to send a message to the 

      * report generated for the test.  Some implementations

      * of the LatkaEventListener may not generate reports.

      * 

      * @param event  Event containing the report message

      */

     public void reportMessage(ReportMessageEvent event) {

         _listener.reportMessage(event);

     }

     /**

      * Invoke when all requests completed.

      *

      * @param event suite event

      */

     public void suiteCompleted(SuiteEvent event) {

         _listener.suiteCompleted(event);

     }

     /**

      * Record the "success status" of a request event.

      * On a failed request, the current suite, request and session are

      * marked as failed

      *

      * @param event  a request event.

      * @param bool   the success (<code>true</code>) or failure

      * (<code>false</code>) of the request.

      */

     protected void recordSuccess (RequestEvent event, boolean bool) {

         if (bool == false) {

             _suiteSucceeded = false;

             _requestSucceeded.put(event.getRequest(), new Boolean(bool));

             _sessionSucceeded.put(event.getSession(), new Boolean(bool));

             _log.info("request failed");

         }

     }

     /**

      * Check to see if a particular Request succeeded or failed.

      *

      * @param request the request to check for success or

      * failure

      * @return true if request succeeded

      */

     public boolean didRequestSucceed(Request request) {

         Boolean bool = (Boolean) _requestSucceeded.get(request);

         if (bool == null || bool.booleanValue() == true) {

             return true;

         } else {

             return false;

         }

     }

     /**

      * Check to see if a particular Session succeeded or failed.

      * Once a request inside a session fails, the session itself

      * is marked as a failure.

      *

      * @param session the session to check for success or

      * failure

      * @return true if all requests in the session succeeded

      */

     public boolean didSessionSucceed(Session session) {

         Boolean bool = (Boolean) _sessionSucceeded.get(session);

         if (bool == null || bool.booleanValue() == true) {

             return true;

         } else {

             return false;

         }

     }

     /**

      * Returns true if all Requests in the suite succeed.

      *

      * @return true if all Requests have succeeded

      */

     public boolean didSuiteSucceed() {

         return _suiteSucceeded;

     }

     /**

      * List failed responses

      * @return a list of all responses of failed requests

      */

     public List getFailedResponses() {

         return _failedResponses;

     }

 }