AbstractClient (MockServer 5.2.3 API)

java.lang.Object
- org.mockserver.client.AbstractClient<T>

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

MockServerClient, ProxyClient
```
public abstract class AbstractClient<T extends AbstractClient>
extends Object
implements Closeable
```
Author:

jamesdbloom

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`contextPath`
`protected ExpectationSerializer`	`expectationSerializer`
`protected String`	`host`
`protected HttpRequestSerializer`	`httpRequestSerializer`
`protected org.slf4j.Logger`	`logger`
`protected NettyHttpClient`	`nettyHttpClient`
`protected int`	`port`
`protected PortBindingSerializer`	`portBindingSerializer`
`protected VerificationSequenceSerializer`	`verificationSequenceSerializer`
`protected VerificationSerializer`	`verificationSerializer`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractClient(String host, int port, String contextPath, Class<T> clientClass)` Start the client communicating to the proxy at the specified host and port and contextPath for example:

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Integer>`	`bind(Integer... ports)` Bind new ports to listen on
`protected String`	`calculatePath(String path)`
`T`	`clear(HttpRequest httpRequest)` Clear all expectations and logs that match the http
`T`	`clear(HttpRequest httpRequest, ClearType type)` Clear expectations, logs or both that match the http
`void`	`close()`
`String`	`contextPath()`
`protected String`	`formatErrorMessage(String message, Object... objects)`
`boolean`	`isRunning()` Returns the server (MockServer or Proxy) is running
`boolean`	`isRunning(int attempts, long timeout, TimeUnit timeUnit)` Returns the server (MockServer or Proxy) is running, by polling the MockServer a configurable amount of times
`InetSocketAddress`	`remoteAddress()`
`T`	`reset()` Reset server (MockServer or Proxy) by clearing all expectations
`String`	`retrieveLogMessages(HttpRequest httpRequest)` Retrieve the logs associated to a specific requests, this shows all logs for expectation matching, verification, clearing, etc
`String[]`	`retrieveLogMessagesArray(HttpRequest httpRequest)` Retrieve the logs associated to a specific requests, this shows all logs for expectation matching, verification, clearing, etc
`Expectation[]`	`retrieveRecordedExpectations(HttpRequest httpRequest)` Retrieve the request-response combinations that have been recorded as a list of expectations, only those that match the httpRequest parameter are returned, use null to retrieve all requests
`String`	`retrieveRecordedExpectations(HttpRequest httpRequest, Format format)` Retrieve the request-response combinations that have been recorded as a list of expectations, only those that match the httpRequest parameter are returned, use null to retrieve all requests
`HttpRequest[]`	`retrieveRecordedRequests(HttpRequest httpRequest)` Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests
`String`	`retrieveRecordedRequests(HttpRequest httpRequest, Format format)` Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests
`protected HttpResponse`	`sendRequest(HttpRequest request)`
`T`	`stop()` Stop server (MockServer or Proxy) gracefully (only support for Netty version, not supported for WAR version)
`T`	`stop(boolean ignoreFailure)` Stop server (MockServer or Proxy) gracefully (only support for Netty version, not supported for WAR version)
`T`	`verify(HttpRequest... httpRequests)` Verify a list of requests have been sent in the order specified for example:
`T`	`verify(HttpRequest httpRequest, VerificationTimes times)` Verify a request has been sent for example:
`T`	`verifyZeroInteractions()` Verify no requests have been have been sent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected final org.slf4j.Logger logger
```
  - host
```
protected final String host
```
  - port
```
protected final int port
```
  - contextPath
```
protected final String contextPath
```
  - nettyHttpClient
```
protected NettyHttpClient nettyHttpClient
```
  - httpRequestSerializer
```
protected HttpRequestSerializer httpRequestSerializer
```
  - portBindingSerializer
```
protected PortBindingSerializer portBindingSerializer
```
  - expectationSerializer
```
protected ExpectationSerializer expectationSerializer
```
  - verificationSerializer
```
protected VerificationSerializer verificationSerializer
```
  - verificationSequenceSerializer
```
protected VerificationSequenceSerializer verificationSequenceSerializer
```
- Constructor Detail
  - AbstractClient
```
protected AbstractClient(String host,
                         int port,
                         String contextPath,
                         Class<T> clientClass)
```
    Start the client communicating to the proxy at the specified host and port and contextPath for example:
    ProxyClient mockServerClient = new ProxyClient("localhost", 1080, "/proxy");
    
    Parameters:
    
    host - the host for the proxy to communicate with
    
    port - the port for the proxy to communicate with
    
    contextPath - the context path that the proxy war is deployed to
- Method Detail
  - calculatePath
```
protected String calculatePath(String path)
```
  - sendRequest
```
protected HttpResponse sendRequest(HttpRequest request)
```
  - formatErrorMessage
```
protected String formatErrorMessage(String message,
                                    Object... objects)
```
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
  - contextPath
```
public String contextPath()
```
  - isRunning
```
public boolean isRunning()
```
    Returns the server (MockServer or Proxy) is running
  - isRunning
```
public boolean isRunning(int attempts,
                         long timeout,
                         TimeUnit timeUnit)
```
    Returns the server (MockServer or Proxy) is running, by polling the MockServer a configurable amount of times
  - bind
```
public List<Integer> bind(Integer... ports)
```
    Bind new ports to listen on
  - stop
```
public T stop()
```
    Stop server (MockServer or Proxy) gracefully (only support for Netty version, not supported for WAR version)
  - stop
```
public T stop(boolean ignoreFailure)
```
    Stop server (MockServer or Proxy) gracefully (only support for Netty version, not supported for WAR version)
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - reset
```
public T reset()
```
    Reset server (MockServer or Proxy) by clearing all expectations
  - clear
```
public T clear(HttpRequest httpRequest)
```
    Clear all expectations and logs that match the http
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to clear each expectation if null all expectations are cleared
  - clear
```
public T clear(HttpRequest httpRequest,
               ClearType type)
```
    Clear expectations, logs or both that match the http
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to clear each expectation if null all expectations are cleared
    
    type - the type to clear, EXPECTATION, LOG or BOTH
  - verify
```
public T verify(HttpRequest... httpRequests)
         throws AssertionError
```
    Verify a list of requests have been sent in the order specified for example:
    mockServerClient .verify( request() .withPath("/first_request") .withBody("some_request_body"), request() .withPath("/second_request") .withBody("some_request_body") );
    
    Parameters:
    
    httpRequests - the http requests that must be matched for this verification to pass
    
    Throws:
    
    AssertionError - if the request has not been found
  - verify
```
public T verify(HttpRequest httpRequest,
                VerificationTimes times)
         throws AssertionError
```
    Verify a request has been sent for example:
    mockServerClient .verify( request() .withPath("/some_path") .withBody("some_request_body"), VerificationTimes.exactly(3) );
    VerificationTimes supports multiple static factory methods:
    once() - verify the request was only received once exactly(n) - verify the request was only received exactly n times atLeast(n) - verify the request was only received at least n times
    
    Parameters:
    
    httpRequest - the http request that must be matched for this verification to pass
    
    times - the number of times this request must be matched
    
    Throws:
    
    AssertionError - if the request has not been found
  - verifyZeroInteractions
```
public T verifyZeroInteractions()
                         throws AssertionError
```
    Verify no requests have been have been sent.
    
    Throws:
    
    AssertionError - if any request has been found
  - retrieveRecordedRequests
```
public HttpRequest[] retrieveRecordedRequests(HttpRequest httpRequest)
```
    Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to return each request, use null for the parameter to retrieve for all requests
    
    Returns:
    
    an array of all requests that have been recorded by the MockServer in the order they have been received and including duplicates where the same request has been received multiple times
  - retrieveRecordedRequests
```
public String retrieveRecordedRequests(HttpRequest httpRequest,
                                       Format format)
```
    Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to return each request, use null for the parameter to retrieve for all requests
    
    format - the format to retrieve the expectations, either JAVA or JSON
    
    Returns:
    
    an array of all requests that have been recorded by the MockServer in the order they have been received and including duplicates where the same request has been received multiple times
  - retrieveRecordedExpectations
```
public Expectation[] retrieveRecordedExpectations(HttpRequest httpRequest)
```
    Retrieve the request-response combinations that have been recorded as a list of expectations, only those that match the httpRequest parameter are returned, use null to retrieve all requests
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to return each request, use null for the parameter to retrieve for all requests
    
    Returns:
    
    an array of all expectations that have been recorded by the MockServer in the order they have been received and including duplicates where the same request has been received multiple times
  - retrieveRecordedExpectations
```
public String retrieveRecordedExpectations(HttpRequest httpRequest,
                                           Format format)
```
    Retrieve the request-response combinations that have been recorded as a list of expectations, only those that match the httpRequest parameter are returned, use null to retrieve all requests
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to return each request, use null for the parameter to retrieve for all requests
    
    format - the format to retrieve the expectations, either JAVA or JSON
    
    Returns:
    
    an array of all expectations that have been recorded by the MockServer in the order they have been received and including duplicates where the same request has been received multiple times
  - retrieveLogMessages
```
public String retrieveLogMessages(HttpRequest httpRequest)
```
    Retrieve the logs associated to a specific requests, this shows all logs for expectation matching, verification, clearing, etc
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to return each request, use null for the parameter to retrieve for all requests
    
    Returns:
    
    all log messages recorded by the MockServer when creating expectations, matching expectations, performing verification, clearing logs, etc
  - retrieveLogMessagesArray
```
public String[] retrieveLogMessagesArray(HttpRequest httpRequest)
```
    Retrieve the logs associated to a specific requests, this shows all logs for expectation matching, verification, clearing, etc
    
    Parameters:
    
    httpRequest - the http request that is matched against when deciding whether to return each request, use null for the parameter to retrieve for all requests
    
    Returns:
    
    an array of all log messages recorded by the MockServer when creating expectations, matching expectations, performing verification, clearing logs, etc

Class AbstractClient<T extends AbstractClient>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

host

port

contextPath

nettyHttpClient

httpRequestSerializer

portBindingSerializer

expectationSerializer

verificationSerializer

verificationSequenceSerializer

Constructor Detail

AbstractClient

Method Detail

calculatePath

sendRequest

formatErrorMessage

remoteAddress

contextPath

isRunning

isRunning

bind

stop

stop

close

reset

clear

clear

verify

verify

verifyZeroInteractions

retrieveRecordedRequests

retrieveRecordedRequests

retrieveRecordedExpectations

retrieveRecordedExpectations

retrieveLogMessages

retrieveLogMessagesArray