com.mockrunner.connector
Class IndexedRecordInteraction

java.lang.Object
  com.mockrunner.connector.IndexedRecordInteraction

All Implemented Interfaces:

InteractionImplementor

public class IndexedRecordInteraction
extends java.lang.Object
implements InteractionImplementor

This interaction implementor works with indexed records. It takes a List for the request and a List or a Record instance for the response. If the request List is null, which is the default, the implementor accepts any request and returns the specified result. If a request List is specified, this implementor accepts only requests that contain the same data as the specified expected request List. The underlying lists are compared as described in the List.equals method. If a request is accepted, this implementor replies with the specified response. You can use the various constructors and set methods to configure the expected request and the response.
Please check out the documentation of the various methods for details.

Constructor Summary

IndexedRecordInteraction()
Sets the expected request and the response to null, i.e. an empty response is returned for every request.

IndexedRecordInteraction(java.util.List responseList)
Sets the expected request to null and prepares the specified response List.

IndexedRecordInteraction(java.util.List responseList, java.lang.Class responseClass)
Sets the expected request to null and prepares the specified response List.

IndexedRecordInteraction(java.util.List expectedRequest, java.util.List responseList)
Sets the specified expected request List and prepares the specified response List.

IndexedRecordInteraction(java.util.List expectedRequest, java.util.List responseList, java.lang.Class responseClass)
Sets the specified expected request List and prepares the specified response List.

IndexedRecordInteraction(java.util.List expectedRequest, javax.resource.cci.Record responseRecord)
Sets the specified expected request List and the response Record for the execute(InteractionSpec, Record) method.

IndexedRecordInteraction(javax.resource.cci.Record responseRecord)
Sets the expected request to null and prepares the response Record for the execute(InteractionSpec, Record) method.

Method Summary

boolean	canHandle(javax.resource.cci.InteractionSpec interactionSpec, javax.resource.cci.Record actualRequest, javax.resource.cci.Record actualResponse) Returns true if this implementor is enabled and will handle the request.
void	disable() Disables this implementor.
void	enable() Enables this implementor.
javax.resource.cci.Record	execute(javax.resource.cci.InteractionSpec interactionSpec, javax.resource.cci.Record actualRequest) First version of the execute methods.
boolean	execute(javax.resource.cci.InteractionSpec interactionSpec, javax.resource.cci.Record actualRequest, javax.resource.cci.Record actualResponse) Second version of the execute methods.
void	setExpectedRequest(java.util.List expectedRequest) Sets the specified expected request List.
void	setResponse(java.util.List responseList) Prepares the specified response List.
void	setResponse(java.util.List responseList, java.lang.Class responseClass) Prepares the specified response List.
void	setResponse(javax.resource.cci.Record responseRecord) Prepares the response Record for the execute(InteractionSpec, Record) method.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedRecordInteraction

public IndexedRecordInteraction()

Sets the expected request and the response to null, i.e. an empty response is returned for every request.

IndexedRecordInteraction

public IndexedRecordInteraction(java.util.List responseList)

Sets the expected request to null and prepares the specified response List. The response class for the execute(InteractionSpec,Record) method is set to the default MockIndexedRecord. It is allowed to pass null for the response List which is equivalent to an empty response. The specified response is returned for every request.

Parameters:

responseList - the response List

IndexedRecordInteraction

public IndexedRecordInteraction(java.util.List expectedRequest,
                                java.util.List responseList)

Sets the specified expected request List and prepares the specified response List. The response class for the execute(InteractionSpec,Record) method is set to the default MockIndexedRecord. It is allowed to pass null for the request and response List which is equivalent to an empty expected request (i.e. every request is accepted) or to an empty response respectively. The specified response is returned, if the actual request matches the specified expected request.

Parameters:

expectedRequest - the expected request ListresponseList - the response List

IndexedRecordInteraction

public IndexedRecordInteraction(java.util.List responseList,
                                java.lang.Class responseClass)

Sets the expected request to null and prepares the specified response List. The response class for the execute(InteractionSpec,Record) method is set to the specified responseClass. The specified responseClass must implement IndexedRecord, otherwise an IllegalArgumentException will be thrown. It is allowed to pass null for the response List which is equivalent to an empty response. The specified response is returned for every request.

Parameters:

responseList - the response ListresponseClass - the response Record class

Throws:

java.lang.IllegalArgumentException - if the responseClass is not valid

IndexedRecordInteraction

public IndexedRecordInteraction(java.util.List expectedRequest,
                                java.util.List responseList,
                                java.lang.Class responseClass)

Sets the specified expected request List and prepares the specified response List. The response class for the execute(InteractionSpec,Record) method is set to the specified responseClass. The specified responseClass must implement IndexedRecord, otherwise an IllegalArgumentException will be thrown. It is allowed to pass null for the request and response List which is equivalent to an empty expected request (i.e. every request is accepted) or to an empty response respectively. The specified response is returned, if the actual request matches the specified expected request.

Parameters:

expectedRequest - the expected request List

responseList - the response List

responseClass - the response Record class

Throws:

java.lang.IllegalArgumentException - if the responseClass is not valid

IndexedRecordInteraction

public IndexedRecordInteraction(java.util.List expectedRequest,
                                javax.resource.cci.Record responseRecord)

Sets the specified expected request List and the response Record for the execute(InteractionSpec, Record) method. The response Record is ignored for execute(InteractionSpec,Record,Record) but takes precedence over the specified response List for execute(InteractionSpec, Record). It is allowed to pass null for the request and response Record which is equivalent to an empty expected request (i.e. every request is accepted) or to no specified response Record, i.e. the specified response List is taken. The specified response is returned, if the actual request matches the specified expected request.

Parameters:

expectedRequest - the expected request List

responseRecord - the response Record

IndexedRecordInteraction

public IndexedRecordInteraction(javax.resource.cci.Record responseRecord)

Sets the expected request to null and prepares the response Record for the execute(InteractionSpec, Record) method. The response Record is ignored for execute(InteractionSpec,Record,Record) but takes precedence over the specified response List for execute(InteractionSpec, Record). It is allowed to pass null for the response Record which is equivalent to no specified response Record, i.e. the specified response List is taken. The specified response is returned for every request.

Parameters:

responseRecord - the response Record

Method Detail

enable

public void enable()

Enables this implementor.

disable

public void disable()

Disables this implementor. canHandle(InteractionSpec, Record, Record) always returns false, if this implementor is disabled.

setExpectedRequest

public void setExpectedRequest(java.util.List expectedRequest)

Sets the specified expected request List. The response is returned, if the actual request matches the specified expected request List according to List.equals. It is allowed to pass null for the request List which is equivalent to an empty expected request (i.e. every request is accepted).

Parameters:

expectedRequest - the expected request List

setResponse

public void setResponse(java.util.List responseList)

Prepares the specified response List. The response class for the execute(InteractionSpec,Record) method is set to the default MockIndexedRecord. It is allowed to pass null for the response List which is equivalent to an empty response.

Parameters:

responseList - the response List

setResponse

public void setResponse(java.util.List responseList,
                        java.lang.Class responseClass)

Prepares the specified response List. The response class for the execute(InteractionSpec,Record) method is set to the specified responseClass. The specified responseClass must implement IndexedRecord, otherwise an IllegalArgumentException will be thrown. It is allowed to pass null for the response List which is equivalent to an empty response.

Parameters:

responseList - the response List

responseClass - the response Record class

Throws:

java.lang.IllegalArgumentException - if the responseClass is not valid

setResponse

public void setResponse(javax.resource.cci.Record responseRecord)

Prepares the response Record for the execute(InteractionSpec, Record) method. The response Record is ignored for execute(InteractionSpec,Record,Record) but takes precedence over the specified response List for execute(InteractionSpec, Record). It is allowed to pass null for the response Record which is equivalent to no specified response Record, i.e. the specified response List is taken.

Parameters:

responseRecord - the response Record

canHandle

public boolean canHandle(javax.resource.cci.InteractionSpec interactionSpec,
                         javax.resource.cci.Record actualRequest,
                         javax.resource.cci.Record actualResponse)

Returns true if this implementor is enabled and will handle the request. This method returns true if the following prerequisites are fulfilled:

It is enabled.

The response Record must implement IndexedRecord or it must be null (which is the case, if the actual request targets the execute(InteractionSpec,Record) method instead of execute(InteractionSpec,Record,Record)).

The expected request must be null (use the various setExpectedRequest methods) or the actual request Record must implement IndexedRecord and must contain the same data as the specified expected request List according to List.equals.

Otherwise, false is returned.

Specified by:

canHandle in interface InteractionImplementor

Parameters:

interactionSpec - the InteractionSpec for the actual call

actualRequest - the request for the actual call

actualResponse - the response for the actual call, may be null

Returns:

true if this implementor will handle the request and will return the specified response, false otherwise

execute

public javax.resource.cci.Record execute(javax.resource.cci.InteractionSpec interactionSpec,
                                         javax.resource.cci.Record actualRequest)
                                  throws javax.resource.ResourceException

First version of the execute methods.

This method returns null, if the request does not match according to the contract of canHandle(javax.resource.cci.InteractionSpec, javax.resource.cci.Record, javax.resource.cci.Record). This never happens under normal conditions since the InteractionHandler does not call execute, if canHandle(javax.resource.cci.InteractionSpec, javax.resource.cci.Record, javax.resource.cci.Record) returns false.

Otherwise, this method returns the specified response. If a response Record object is specified (use setResponse(Record)), it always takes precedence, i.e. the response List will be ignored. If no Record object is specified, a Record object is created and filled with the specified response List data. Use the setResponse methods that take a List to prepare the response List. The created Record is of the the specified type (the setResponse method that takes a second Class parameter allows for specifying a type). If no type is specified, a MockIndexedRecord is created. If no response List is specified at all, an empty MockIndexedRecord will be returned.

Specified by:

execute in interface InteractionImplementor

Parameters:

interactionSpec - the interaction spec

actualRequest - the actual request

Returns:

the response according to the current request

Throws:

javax.resource.ResourceException

execute

public boolean execute(javax.resource.cci.InteractionSpec interactionSpec,
                       javax.resource.cci.Record actualRequest,
                       javax.resource.cci.Record actualResponse)
                throws javax.resource.ResourceException

Second version of the execute methods.

This method returns false, if the request does not match according to the contract of canHandle(javax.resource.cci.InteractionSpec, javax.resource.cci.Record, javax.resource.cci.Record). This never happens under normal conditions since the InteractionHandler does not call execute, if canHandle(javax.resource.cci.InteractionSpec, javax.resource.cci.Record, javax.resource.cci.Record) returns false.

Otherwise, this method fills the response Record with the specified response List data. Use the setResponse methods that take a List to prepare the response List. The response Record must implement IndexedRecord (it does, otherwise the request would have been rejected by canHandle(javax.resource.cci.InteractionSpec, javax.resource.cci.Record, javax.resource.cci.Record)). If no response List is specified at all, the response Record is not touched but true is returned anyway

Specified by:

execute in interface InteractionImplementor

Parameters:

interactionSpec - the interaction spec

actualRequest - the actual request

actualResponse - the actual response

Returns:

true under normal conditions

Throws:

javax.resource.ResourceException