org.mockserver.mock

Class Expectation

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.mock.Expectation

public class Expectation
extends ObjectWithJsonToString

Author:

jamesdbloom

Constructor Summary

Constructors

Constructor and Description
Expectation(RequestDefinition requestDefinition)
Expectation(RequestDefinition requestDefinition, Times times, TimeToLive timeToLive, int priority)

Method Summary

Modifier and Type	Method and Description
Expectation	clone()
boolean	contains(HttpRequest httpRequest)
boolean	decrementRemainingMatches()
boolean	equals(Object o)
String[]	fieldsExcludedFromEqualsAndHashCode()
Action	getAction()
long	getCreated()
HttpError	getHttpError()
HttpForward	getHttpForward()
HttpClassCallback	getHttpForwardClassCallback()
HttpObjectCallback	getHttpForwardObjectCallback()
HttpTemplate	getHttpForwardTemplate()
HttpOverrideForwardedRequest	getHttpOverrideForwardedRequest()
RequestDefinition	getHttpRequest()
HttpResponse	getHttpResponse()
HttpClassCallback	getHttpResponseClassCallback()
HttpObjectCallback	getHttpResponseObjectCallback()
HttpTemplate	getHttpResponseTemplate()
String	getId()
int	getPriority()
SortableExpectationId	getSortableId()
Times	getTimes()
TimeToLive	getTimeToLive()
int	hashCode()
boolean	isActive()
Expectation	thenError(HttpError httpError)
Expectation	thenForward(HttpClassCallback httpClassCallback)
Expectation	thenForward(HttpForward httpForward)
Expectation	thenForward(HttpObjectCallback httpObjectCallback)
Expectation	thenForward(HttpOverrideForwardedRequest httpOverrideForwardedRequest)
Expectation	thenForward(HttpTemplate httpTemplate)
Expectation	thenRespond(HttpClassCallback httpClassCallback)
Expectation	thenRespond(HttpObjectCallback httpObjectCallback)
Expectation	thenRespond(HttpResponse httpResponse)
Expectation	thenRespond(HttpTemplate httpTemplate)
static Expectation	when(HttpRequest httpRequest) Specify the HttpRequest to match against as follows:
static Expectation	when(HttpRequest httpRequest, int priority) Specify the HttpRequest to match against with a match priority as follows:
static Expectation	when(HttpRequest httpRequest, Times times, TimeToLive timeToLive) Specify the HttpRequest to match against for a limit number of times or time as follows:
static Expectation	when(HttpRequest httpRequest, Times times, TimeToLive timeToLive, int priority) Specify the HttpRequest to match against for a limit number of times or time and a match priority as follows:
static Expectation	when(String specUrlOrPayload, String operationId) Specify the OpenAPI and operationId to match against by URL or payload and string as follows:
static Expectation	when(String specUrlOrPayload, String operationId, int priority) Specify the OpenAPI and operationId to match against by URL or payload and string with a match priority as follows:
static Expectation	when(String specUrlOrPayload, String operationId, Times times, TimeToLive timeToLive) Specify the OpenAPI and operationId to match against by URL or payload and string for a limit number of times or time as follows:
static Expectation	when(String specUrlOrPayload, String operationId, Times times, TimeToLive timeToLive, int priority) Specify the OpenAPI and operationId to match against by URL or payload and string for a limit number of times or time and a match priority as follows:
Expectation	withCreated(long created)
Expectation	withId(String id) Set id of this expectation which can be used to update this expectation later or for clearing or verifying by expectation id.
Expectation	withIdIfNull(String id)
Expectation	withPriority(int priority) Set priority of this expectation which is used to determin the matching order of expectations when a request is received.

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Expectation

public Expectation(RequestDefinition requestDefinition)

Expectation

public Expectation(RequestDefinition requestDefinition,
                   Times times,
                   TimeToLive timeToLive,
                   int priority)

Method Detail

when

public static Expectation when(String specUrlOrPayload,
                               String operationId)

Specify the OpenAPI and operationId to match against by URL or payload and string as follows:

   // Create from a publicly hosted HTTP location (json or yaml)
   when("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml", "showPetById")

   // Create from a file on the local filesystem (json or yaml)
   when("file://Users/myuser/git/mockserver/mockserver-core/src/test/resources/org/mockserver/openapi/openapi_petstore_example.json", "showPetById");

   // Create from a classpath resource in the /api package (json or yaml)
   when("org/mockserver/openapi/openapi_petstore_example.json", "showPetById");

   // Create from an OpenAPI payload (json or yaml)
   when("{\"openapi\": \"3.0.0\", \"info\": { ...", "showPetById")
 

Parameters:

specUrlOrPayload - the OpenAPI to match against by URL or payload

operationId - operationId from the OpenAPI to match against i.e. "showPetById"

Returns:

the Expectation

when

public static Expectation when(String specUrlOrPayload,
                               String operationId,
                               int priority)

Specify the OpenAPI and operationId to match against by URL or payload and string with a match priority as follows:

   // Create from a publicly hosted HTTP location (json or yaml)
   when("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml", "showPetById", 10)

   // Create from a file on the local filesystem (json or yaml)
   when("file://Users/myuser/git/mockserver/mockserver-core/src/test/resources/org/mockserver/openapi/openapi_petstore_example.json", "showPetById", 10);

   // Create from a classpath resource in the /api package (json or yaml)
   when("org/mockserver/openapi/openapi_petstore_example.json", "showPetById", 10);

   // Create from an OpenAPI payload (json or yaml)
   when("{\"openapi\": \"3.0.0\", \"info\": { ...", "showPetById", 10)
 

Parameters:

specUrlOrPayload - the OpenAPI to match against by URL or payload

operationId - operationId from the OpenAPI to match against i.e. "showPetById"

priority - the priority with which this expectation is used to match requests compared to other expectations (high first)

Returns:

the Expectation

when

public static Expectation when(String specUrlOrPayload,
                               String operationId,
                               Times times,
                               TimeToLive timeToLive)

Specify the OpenAPI and operationId to match against by URL or payload and string for a limit number of times or time as follows:

   // Create from a publicly hosted HTTP location (json or yaml)
   when("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml", "showPetById", 5, exactly(TimeUnit.SECONDS, 90))

   // Create from a file on the local filesystem (json or yaml)
   when("file://Users/myuser/git/mockserver/mockserver-core/src/test/resources/org/mockserver/openapi/openapi_petstore_example.json", "showPetById", 5, exactly(TimeUnit.SECONDS, 90));

   // Create from a classpath resource in the /api package (json or yaml)
   when("org/mockserver/openapi/openapi_petstore_example.json", "showPetById", 5, exactly(TimeUnit.SECONDS, 90));

   // Create from an OpenAPI payload (json or yaml)
   when("{\"openapi\": \"3.0.0\", \"info\": { ...", "showPetById", 5, exactly(TimeUnit.SECONDS, 90))
 

Parameters:

specUrlOrPayload - the OpenAPI to match against by URL or payload

operationId - operationId from the OpenAPI to match against i.e. "showPetById"

times - the number of times to use this expectation to match requests

timeToLive - the time this expectation should be used to match requests

Returns:

the Expectation

when

public static Expectation when(String specUrlOrPayload,
                               String operationId,
                               Times times,
                               TimeToLive timeToLive,
                               int priority)

Specify the OpenAPI and operationId to match against by URL or payload and string for a limit number of times or time and a match priority as follows:

   // Create from a publicly hosted HTTP location (json or yaml)
   when("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml", "showPetById", 5, exactly(TimeUnit.SECONDS, 90))

   // Create from a file on the local filesystem (json or yaml)
   when("file://Users/myuser/git/mockserver/mockserver-core/src/test/resources/org/mockserver/openapi/openapi_petstore_example.json", "showPetById", 5, exactly(TimeUnit.SECONDS, 90));

   // Create from a classpath resource in the /api package (json or yaml)
   when("org/mockserver/openapi/openapi_petstore_example.json", "showPetById", 5, exactly(TimeUnit.SECONDS, 90));

   // Create from an OpenAPI payload (json or yaml)
   when("{\"openapi\": \"3.0.0\", \"info\": { ...", "showPetById", 5, exactly(TimeUnit.SECONDS, 90))
 

Parameters:

specUrlOrPayload - the OpenAPI to match against by URL or payload

operationId - operationId from the OpenAPI to match against i.e. "showPetById"

times - the number of times to use this expectation to match requests

timeToLive - the time this expectation should be used to match requests

priority - the priority with which this expectation is used to match requests compared to other expectations (high first)

Returns:

the Expectation

when

public static Expectation when(HttpRequest httpRequest)

Specify the HttpRequest to match against as follows:

     when(
         request()
             .withMethod("GET")
             .withPath("/some/path")
     ).thenRespond(
         response()
             .withContentType(APPLICATION_JSON_UTF_8)
             .withBody("{\"some\": \"body\"}")
     );
 

Parameters:

httpRequest - the HttpRequest to match against

Returns:

the Expectation

when

public static Expectation when(HttpRequest httpRequest,
                               int priority)

Specify the HttpRequest to match against with a match priority as follows:

     when(
         request()
             .withMethod("GET")
             .withPath("/some/path"),
         10
     ).thenRespond(
         response()
             .withContentType(APPLICATION_JSON_UTF_8)
             .withBody("{\"some\": \"body\"}")
     );
 

Parameters:

httpRequest - the HttpRequest to match against

priority - the priority with which this expectation is used to match requests compared to other expectations (high first)

Returns:

the Expectation

when

public static Expectation when(HttpRequest httpRequest,
                               Times times,
                               TimeToLive timeToLive)

Specify the HttpRequest to match against for a limit number of times or time as follows:

     when(
         request()
             .withMethod("GET")
             .withPath("/some/path"),
         5,
         exactly(TimeUnit.SECONDS, 90)
     ).thenRespond(
         response()
             .withContentType(APPLICATION_JSON_UTF_8)
             .withBody("{\"some\": \"body\"}")
     );
 

Parameters:

httpRequest - the HttpRequest to match against

times - the number of times to use this expectation to match requests

timeToLive - the time this expectation should be used to match requests

Returns:

the Expectation

when

public static Expectation when(HttpRequest httpRequest,
                               Times times,
                               TimeToLive timeToLive,
                               int priority)

Specify the HttpRequest to match against for a limit number of times or time and a match priority as follows:

     when(
         request()
             .withMethod("GET")
             .withPath("/some/path"),
         5,
         exactly(TimeUnit.SECONDS, 90),
         10
     ).thenRespond(
         response()
             .withContentType(APPLICATION_JSON_UTF_8)
             .withBody("{\"some\": \"body\"}")
     );
 

Parameters:

httpRequest - the HttpRequest to match against

times - the number of times to use this expectation to match requests

timeToLive - the time this expectation should be used to match requests

priority - the priority with which this expectation is used to match requests compared to other expectations (high first)

Returns:

the Expectation

withId

public Expectation withId(String id)

Set id of this expectation which can be used to update this expectation later or for clearing or verifying by expectation id.

Note: Each unique expectation must have a unique id otherwise this expectation will update a existing expectation with the same id.

Parameters:

id - unique string for expectation's id

withIdIfNull

public Expectation withIdIfNull(String id)

getId

public String getId()

withPriority

public Expectation withPriority(int priority)

Set priority of this expectation which is used to determin the matching order of expectations when a request is received.

Matching is ordered by priority (highest first) then creation (earliest first).

Parameters:

priority - expectation's priority

getPriority

public int getPriority()

withCreated

public Expectation withCreated(long created)

getCreated

public long getCreated()

getSortableId

public SortableExpectationId getSortableId()

getHttpRequest

public RequestDefinition getHttpRequest()

getHttpResponse

public HttpResponse getHttpResponse()

getHttpResponseTemplate

public HttpTemplate getHttpResponseTemplate()

getHttpResponseClassCallback

public HttpClassCallback getHttpResponseClassCallback()

getHttpResponseObjectCallback

public HttpObjectCallback getHttpResponseObjectCallback()

getHttpForward

public HttpForward getHttpForward()

getHttpForwardTemplate

public HttpTemplate getHttpForwardTemplate()

getHttpForwardClassCallback

public HttpClassCallback getHttpForwardClassCallback()

getHttpForwardObjectCallback

public HttpObjectCallback getHttpForwardObjectCallback()

getHttpOverrideForwardedRequest

public HttpOverrideForwardedRequest getHttpOverrideForwardedRequest()

getHttpError

public HttpError getHttpError()

getAction

public Action getAction()

getTimes

public Times getTimes()

getTimeToLive

public TimeToLive getTimeToLive()

thenRespond

public Expectation thenRespond(HttpResponse httpResponse)

thenRespond

public Expectation thenRespond(HttpTemplate httpTemplate)

thenRespond

public Expectation thenRespond(HttpClassCallback httpClassCallback)

thenRespond

public Expectation thenRespond(HttpObjectCallback httpObjectCallback)

thenForward

public Expectation thenForward(HttpForward httpForward)

thenForward

public Expectation thenForward(HttpTemplate httpTemplate)

thenForward

public Expectation thenForward(HttpClassCallback httpClassCallback)

thenForward

public Expectation thenForward(HttpObjectCallback httpObjectCallback)

thenForward

public Expectation thenForward(HttpOverrideForwardedRequest httpOverrideForwardedRequest)

thenError

public Expectation thenError(HttpError httpError)

isActive

public boolean isActive()

decrementRemainingMatches

public boolean decrementRemainingMatches()

contains

public boolean contains(HttpRequest httpRequest)

clone

public Expectation clone()

Overrides:

clone in class Object

fieldsExcludedFromEqualsAndHashCode

public String[] fieldsExcludedFromEqualsAndHashCode()

Overrides:

fieldsExcludedFromEqualsAndHashCode in class ObjectWithReflectiveEqualsHashCodeToString

equals

public boolean equals(Object o)

Overrides:

equals in class ObjectWithReflectiveEqualsHashCodeToString

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectWithReflectiveEqualsHashCodeToString