org.apache.commons.latka
Class DefaultLatkaEventInfo

java.lang.Object
  org.apache.commons.latka.DefaultLatkaEventInfo

All Implemented Interfaces:

LatkaEventInfo, LatkaEventListener

public class DefaultLatkaEventInfo
extends Object
implements LatkaEventInfo

The base class for several 'reporters'. A reporter is a class that will store or record information about events that occur during Latka processing

Version:

$Revision: 155424 $

Author:

Rodney Waldhoff, Morgan Delagrange

Field Summary

protected List	_failedResponses Holds the failed responses received by this object.
protected LatkaEventListener	_listener
protected static org.apache.log4j.Category	_log The log4J category used for processing log requests.
protected Map	_requestSucceeded maps the request to it's success or failure as a Boolean
protected Map	_sessionSucceeded maps the session to it's success or failure as a Boolean
protected boolean	_suiteSucceeded Holds whether or not the entire suite has succeeded This is set to false when any request fails.

Constructor Summary

DefaultLatkaEventInfo(LatkaEventListener listener)

Method Summary

boolean	didRequestSucceed(Request request) Check to see if a particular Request succeeded or failed.
boolean	didSessionSucceed(Session session) Check to see if a particular Session succeeded or failed.
boolean	didSuiteSucceed() Returns true if all Requests in the suite succeed.
List	getFailedResponses() List failed responses
protected void	recordSuccess(RequestEvent event, boolean bool) Record the "success status" of a request event.
void	reportMessage(ReportMessageEvent event) Invoked if a Latka suite wants to send a message to the report generated for the test.
void	requestError(RequestEvent event) Invoked if a request error occurs.
void	requestFailed(RequestEvent event) Invoked if the request failed.
void	requestSkipped(RequestEvent event) A skipped request.
void	requestSucceeded(RequestEvent event) Invoked if the request succeeds.
void	suiteCompleted(SuiteEvent event) Invoke when all requests completed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_requestSucceeded

protected Map _requestSucceeded

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

_sessionSucceeded

protected Map _sessionSucceeded

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

_suiteSucceeded

protected boolean _suiteSucceeded

Holds whether or not the entire suite has succeeded This is set to false when any request fails.

_failedResponses

protected List _failedResponses

Holds the failed responses received by this object.

See Also:

requestFailed(RequestEvent)

_listener

protected LatkaEventListener _listener

_log

protected static final org.apache.log4j.Category _log

The log4J category used for processing log requests.

Constructor Detail

DefaultLatkaEventInfo

public DefaultLatkaEventInfo(LatkaEventListener listener)

Method Detail

requestSucceeded

public void requestSucceeded(RequestEvent event)

Invoked if the request succeeds. Records the success

Specified by:

requestSucceeded in interface LatkaEventListener

Parameters:

event - a successful request event

requestFailed

public void requestFailed(RequestEvent event)

Invoked if the request failed. Records the failure and adds the request's response to the list of failed responses

Specified by:

requestFailed in interface LatkaEventListener

Parameters:

event - a "failed" request event.

requestSkipped

public void requestSkipped(RequestEvent event)

A skipped request. Records the skip as a failure

Specified by:

requestSkipped in interface LatkaEventListener

Parameters:

event - a "skipped" request.

requestError

public void requestError(RequestEvent event)

Invoked if a request error occurs. Records the error as a failure

Specified by:

requestError in interface LatkaEventListener

Parameters:

event - a request "error" event.

reportMessage

public void reportMessage(ReportMessageEvent 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.

Specified by:

reportMessage in interface LatkaEventListener

Parameters:

event - Event containing the report message

suiteCompleted

public void suiteCompleted(SuiteEvent event)

Invoke when all requests completed.

Specified by:

suiteCompleted in interface LatkaEventListener

Parameters:

event - suite event

recordSuccess

protected void recordSuccess(RequestEvent event,
                             boolean bool)

Record the "success status" of a request event. On a failed request, the current suite, request and session are marked as failed

Parameters:

event - a request event.

bool - the success (true) or failure (false) of the request.

didRequestSucceed

public boolean didRequestSucceed(Request request)

Check to see if a particular Request succeeded or failed.

Specified by:

didRequestSucceed in interface LatkaEventInfo

Parameters:

request - the request to check for success or failure

Returns:

true if request succeeded

didSessionSucceed

public boolean didSessionSucceed(Session session)

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.

Specified by:

didSessionSucceed in interface LatkaEventInfo

Parameters:

session - the session to check for success or failure

Returns:

true if all requests in the session succeeded

didSuiteSucceed

public boolean didSuiteSucceed()

Returns true if all Requests in the suite succeed.

Specified by:

didSuiteSucceed in interface LatkaEventInfo

Returns:

true if all Requests have succeeded

getFailedResponses

public List getFailedResponses()

List failed responses

Specified by:

getFailedResponses in interface LatkaEventInfo

Returns:

a list of all responses of failed requests