WarpContext (Arquillian Warp: Implementation 1.0.0 API)

All Known Implementing Classes:

WarpContextImpl
```
public interface WarpContext
```
Context of Warp execution which makes available executed groups, holds exceptions and execution results

Author:

Lukas Fryc

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addGroup(WarpGroup group)` Registers group to be inspected
`void`	`addUnmatchedRequest(Request request)` Records that given request was not matched by any observer.
`Collection<WarpGroup>`	`getAllGroups()` Returns all registered groups
`int`	`getExpectedRequestCount()` Return the number of requests expected in all groups of this context
`Exception`	`getFirstException()` Returns first exception observed during Warp execution.
`org.jboss.arquillian.test.spi.TestResult`	`getFirstNonSuccessfulResult()` Returns first observed non-successful result.
`WarpGroup`	`getGroup(Object identifier)` Returns the request group based on its identifier under which it was registered using `addGroup(WarpGroup)`.
`Collection<RequestObserverChainManager>`	`getObserverChainManagers()` Get all registered services for `RequestObserverChainManager`.
`WarpResult`	`getResult()` Exports response status as `WarpResult` to be available to user.
`SynchronizationPoint`	`getSynchronization()` Returns the point of synchronization of current Warp execution.
`List<Request>`	`getUnmatchedRequests()` Return the list of requests which weren't matched by any observer.
`void`	`initialize(org.jboss.arquillian.core.spi.ServiceLoader serviceLoader)` Initializes Warp context by available services.
`void`	`pushException(Exception exception)` Pushes exception observer during Warp execution to context.
`void`	`pushResponsePayload(ResponsePayload payload)` Pushes `ResponsePayload` to context.

- Method Detail
  - addGroup
```
void addGroup(WarpGroup group)
```
    Registers group to be inspected
  - getAllGroups
```
Collection<WarpGroup> getAllGroups()
```
    Returns all registered groups
  - getGroup
```
WarpGroup getGroup(Object identifier)
```
    Returns the request group based on its identifier under which it was registered using addGroup(WarpGroup).
    
    Parameters:
    
    identifier -
    
    Returns:
  - pushResponsePayload
```
void pushResponsePayload(ResponsePayload payload)
```
    Pushes ResponsePayload to context.
    
    Context should ensure propagating ResponsePayload to associated WarpGroup based on the generated serial identifier (RequestPayload.getSerialId()).
  - pushException
```
void pushException(Exception exception)
```
    Pushes exception observer during Warp execution to context.
  - getFirstException
```
Exception getFirstException()
```
    Returns first exception observed during Warp execution.
  - getSynchronization
```
SynchronizationPoint getSynchronization()
```
    Returns the point of synchronization of current Warp execution.
  - getFirstNonSuccessfulResult
```
org.jboss.arquillian.test.spi.TestResult getFirstNonSuccessfulResult()
```
    Returns first observed non-successful result.
  - getResult
```
WarpResult getResult()
```
    Exports response status as WarpResult to be available to user.
  - initialize
```
void initialize(org.jboss.arquillian.core.spi.ServiceLoader serviceLoader)
```
    Initializes Warp context by available services.
    
    Note: WarpContext is used in another thread, that's why it can't access injected ServiceLoader directly.
  - getObserverChainManagers
```
Collection<RequestObserverChainManager> getObserverChainManagers()
```
    Get all registered services for RequestObserverChainManager.
    
    Returns:
  - getExpectedRequestCount
```
int getExpectedRequestCount()
```
    Return the number of requests expected in all groups of this context
    
    Returns:
    
    the number of requests expected in all groups of this context
  - addUnmatchedRequest
```
void addUnmatchedRequest(Request request)
```
    Records that given request was not matched by any observer.
    For debugging purposes.
  - getUnmatchedRequests
```
List<Request> getUnmatchedRequests()
```
    Return the list of requests which weren't matched by any observer.
    
    Returns:

Interface WarpContext

Method Summary

Method Detail

addGroup

getAllGroups

getGroup

pushResponsePayload

pushException

getFirstException

getSynchronization

getFirstNonSuccessfulResult

getResult

initialize

getObserverChainManagers

getExpectedRequestCount

addUnmatchedRequest

getUnmatchedRequests