Constructor Detail

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters, Function<Method, Object> providerMethodInstance, Supplier<String> providerVersion, Supplier<String> providerTag, Supplier<List<String>> providerTags, Supplier<String> providerBranch, Supplier<ClassLoader> projectClassLoader, Function<String, Object> responseFactory)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters, Function<Method, Object> providerMethodInstance, Supplier<String> providerVersion, Supplier<String> providerTag, Supplier<List<String>> providerTags, Supplier<String> providerBranch, Supplier<ClassLoader> projectClassLoader)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters, Function<Method, Object> providerMethodInstance, Supplier<String> providerVersion, Supplier<String> providerTag, Supplier<List<String>> providerTags, Supplier<String> providerBranch)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters, Function<Method, Object> providerMethodInstance, Supplier<String> providerVersion, Supplier<String> providerTag, Supplier<List<String>> providerTags)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters, Function<Method, Object> providerMethodInstance, Supplier<String> providerVersion, Supplier<String> providerTag)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters, Function<Method, Object> providerMethodInstance, Supplier<String> providerVersion)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters, Function<Method, Object> providerMethodInstance)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath, List<VerifierReporter> reporters)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask, Supplier<List<URL>> projectClasspath)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask, BiConsumer<Object, ProviderState> executeBuildSpecificTask)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage, Function<Object, Boolean> checkBuildSpecificTask)

• ProviderVerifier

  ProviderVerifier(Object pactLoadFailureMessage)

• ProviderVerifier

  ProviderVerifier()

Method Detail

• getProjectHasProperty

   Function<String, Boolean> getProjectHasProperty()

  Callback to determine is the project has a particular property

• setProjectHasProperty

   Unit setProjectHasProperty(Function<String, Boolean> projectHasProperty)

  Callback to determine is the project has a particular property

• getProjectGetProperty

   Function<String, String> getProjectGetProperty()

  Callback to fetch a project property

• setProjectGetProperty

   Unit setProjectGetProperty(Function<String, String> projectGetProperty)

  Callback to fetch a project property

• getVerificationReporter

   final VerificationReporter getVerificationReporter()

• setVerificationReporter

   final Unit setVerificationReporter(VerificationReporter verificationReporter)

• getStateChangeHandler

   final StateChange getStateChangeHandler()

• setStateChangeHandler

   final Unit setStateChangeHandler(StateChange stateChangeHandler)

• getPactReader

   final PactReader getPactReader()

• setPactReader

   final Unit setPactReader(PactReader pactReader)

• getVerificationSource

   String getVerificationSource()

  Source of the verification (Gradle/Maven/Junit)

• setVerificationSource

   Unit setVerificationSource(String verificationSource)

  Source of the verification (Gradle/Maven/Junit)

• getPluginManager

   final PluginManager getPluginManager()

• setPluginManager

   final Unit setPluginManager(PluginManager pluginManager)

• getResponseComparer

   final IResponseComparison getResponseComparer()

• setResponseComparer

   final Unit setResponseComparer(IResponseComparison responseComparer)

• getPactLoadFailureMessage

   Object getPactLoadFailureMessage()

  Callback to display a pact load error

• setPactLoadFailureMessage

   Unit setPactLoadFailureMessage(Object pactLoadFailureMessage)

  Callback to display a pact load error

• getCheckBuildSpecificTask

   Function<Object, Boolean> getCheckBuildSpecificTask()

  Callback to determine if something is a build specific task

• setCheckBuildSpecificTask

   Unit setCheckBuildSpecificTask(Function<Object, Boolean> checkBuildSpecificTask)

  Callback to determine if something is a build specific task

• getExecuteBuildSpecificTask

   BiConsumer<Object, ProviderState> getExecuteBuildSpecificTask()

  Consumer SAM to execute the build specific task

• setExecuteBuildSpecificTask

   Unit setExecuteBuildSpecificTask(BiConsumer<Object, ProviderState> executeBuildSpecificTask)

  Consumer SAM to execute the build specific task

• getProjectClasspath

   Supplier<List<URL>> getProjectClasspath()

  Callback to return the project classpath to use for looking up methods

• setProjectClasspath

   Unit setProjectClasspath(Supplier<List<URL>> projectClasspath)

  Callback to return the project classpath to use for looking up methods

• getReporters

   List<VerifierReporter> getReporters()

  List of the all reporters to report the results of the verification to

• setReporters

   Unit setReporters(List<VerifierReporter> reporters)

  List of the all reporters to report the results of the verification to

• getProviderMethodInstance

   Function<Method, Object> getProviderMethodInstance()

  Callback to return the instance for the provider method to invoke

• setProviderMethodInstance

   Unit setProviderMethodInstance(Function<Method, Object> providerMethodInstance)

  Callback to return the instance for the provider method to invoke

• getProviderVersion

   Supplier<String> getProviderVersion()

  Callback to get the provider version

• setProviderVersion

   Unit setProviderVersion(Supplier<String> providerVersion)

  Callback to get the provider version

• getProviderTag

   Supplier<String> getProviderTag()

  Callback to get the provider tag

• setProviderTag

   Unit setProviderTag(@Deprecated(message = "Use version that returns multiple tags", replaceWith = @ReplaceWith(imports = {}, expression = "providerTags")) Supplier<String> providerTag)

  Callback to get the provider tag

• getProviderTags

   Supplier<List<String>> getProviderTags()

  Callback to get the provider tags

• setProviderTags

   Unit setProviderTags(Supplier<List<String>> providerTags)

  Callback to get the provider tags

• getProviderBranch

   Supplier<String> getProviderBranch()

  Callback to get the provider branch

• setProviderBranch

   Unit setProviderBranch(Supplier<String> providerBranch)

  Callback to get the provider branch

• getProjectClassLoader

   Supplier<ClassLoader> getProjectClassLoader()

  Callback to return the project classloader to use for looking up methods

• setProjectClassLoader

   Unit setProjectClassLoader(Supplier<ClassLoader> projectClassLoader)

  Callback to return the project classloader to use for looking up methods

• getResponseFactory

   Function<String, Object> getResponseFactory()

  Callback which is given an interaction description and returns a response

• setResponseFactory

   Unit setResponseFactory(Function<String, Object> responseFactory)

  Callback which is given an interaction description and returns a response

• publishingResultsDisabled

   Boolean publishingResultsDisabled()

  This will return true unless the pact.verifier.publishResults property has the value of "true"

• verifyResponseByInvokingProviderMethods

  @Deprecated(message = "Use the version that passes in any plugin configuration") VerificationResult verifyResponseByInvokingProviderMethods(IProviderInfo providerInfo, IConsumerInfo consumer, Interaction interaction, String interactionMessage, Map<String, Object> failures, Boolean pending)

  Verifies the interaction by invoking a method on a provider test class

• verifyResponseByInvokingProviderMethods

   VerificationResult verifyResponseByInvokingProviderMethods(IProviderInfo providerInfo, IConsumerInfo consumer, Interaction interaction, String interactionMessage, Map<String, Object> failures, Boolean pending, Map<String, PluginConfiguration> pluginConfiguration)

  Verifies the interaction by invoking a method on a provider test class

• verifyResponseByFactory

  @Deprecated(message = "Use the version that passes in any plugin configuration") VerificationResult verifyResponseByFactory(IProviderInfo providerInfo, IConsumerInfo consumer, Interaction interaction, String interactionMessage, Map<String, Object> failures, Boolean pending)

• verifyResponseByFactory

   VerificationResult verifyResponseByFactory(IProviderInfo providerInfo, IConsumerInfo consumer, Interaction interaction, String interactionMessage, Map<String, Object> failures, Boolean pending, Map<String, PluginConfiguration> pluginConfiguration)

• displayBodyResult

   final VerificationResult displayBodyResult(Map<String, Object> failures, Result<BodyComparisonResult, BodyTypeMismatch> comparison, String comparisonDescription, String interactionId, Boolean pending)

• verifyMessage

  @Deprecated(message = "Use version that takes the Plugin Config as a parameter", replaceWith = @ReplaceWith(imports = {}, expression = "verifyMessage(methods, message, interactionMessage, failures, pending, pluginConfiguration)")) final VerificationResult verifyMessage(Set<Method> methods, MessageInteraction message, String interactionMessage, Map<String, Object> failures, Boolean pending)

• verifyMessage

   final VerificationResult verifyMessage(Set<Method> methods, MessageInteraction message, String interactionMessage, Map<String, Object> failures, Boolean pending, Map<String, PluginConfiguration> pluginConfiguration)

• verifyMessage

  @Deprecated(message = "Use version that takes the Plugin Config as a parameter", replaceWith = @ReplaceWith(imports = {}, expression = "verifyMessage(messageFactory, message, interactionId, interactionMessage, failures, pending, pluginConfig)")) final VerificationResult verifyMessage(Function<String, Object> messageFactory, MessageInteraction message, String interactionId, String interactionMessage, Map<String, Object> failures, Boolean pending)

• verifyMessage

   final VerificationResult verifyMessage(Function<String, Object> messageFactory, MessageInteraction message, String interactionId, String interactionMessage, Map<String, Object> failures, Boolean pending, Map<String, PluginConfiguration> pluginConfiguration)

• displayFailures

   Unit displayFailures(List<VerificationResult.Failed> failures)

  Displays all the failures from the verification run

• finaliseReports

   Unit finaliseReports()

  Finalise all the reports after verification is complete

• verifyInteraction

  @JvmOverloads()@Deprecated(message = "Use the version of verifyInteraction that passes in the full Pact and transport entry", replaceWith = @ReplaceWith(imports = {}, expression = "verifyInteraction(provider, consumer, failures, interaction, pact, transportEntry, providerClient)")) final VerificationResult verifyInteraction(IProviderInfo provider, IConsumerInfo consumer, Map<String, Object> failures, Interaction interaction, ProviderClient providerClient)

• verifyInteraction

  @JvmOverloads()@Deprecated(message = "Use the version of verifyInteraction that passes in the full Pact and transport entry", replaceWith = @ReplaceWith(imports = {}, expression = "verifyInteraction(provider, consumer, failures, interaction, pact, transportEntry, providerClient)")) final VerificationResult verifyInteraction(IProviderInfo provider, IConsumerInfo consumer, Map<String, Object> failures, Interaction interaction)

• verifyInteraction

  @JvmOverloads() final VerificationResult verifyInteraction(IProviderInfo provider, IConsumerInfo consumer, Map<String, Object> failures, Interaction interaction, Pact pact, CatalogueEntry transportEntry, ProviderClient providerClient)

• verifyInteraction

  @JvmOverloads() final VerificationResult verifyInteraction(IProviderInfo provider, IConsumerInfo consumer, Map<String, Object> failures, Interaction interaction, Pact pact, CatalogueEntry transportEntry)

• reportInteractionDescription

   Unit reportInteractionDescription(Interaction interaction)

  Display info about the interaction about to be verified

• generateErrorStringFromVerificationResult

   String generateErrorStringFromVerificationResult(List<VerificationResult.Failed> result)

• reportStateChangeFailed

   Unit reportStateChangeFailed(ProviderState providerState, Exception error, Boolean isSetup)

• verifyRequestResponsePact

   VerificationResult verifyRequestResponsePact(IResponse expectedResponse, ProviderResponse actualResponse, String interactionMessage, Map<String, Object> failures, String interactionId, Boolean pending, Map<String, PluginConfiguration> pluginConfiguration)

  Compares the expected and actual responses

• displayStatusResult

   final VerificationResult displayStatusResult(Map<String, Object> failures, Integer status, StatusMismatch mismatch, String comparisonDescription, String interactionId, Boolean pending)

• displayHeadersResult

   final VerificationResult displayHeadersResult(Map<String, Object> failures, Map<String, List<String>> expected, Map<String, List<HeaderMismatch>> headers, String comparisonDescription, String interactionId, Boolean pending)

• verifyResponseFromProvider

   VerificationResult verifyResponseFromProvider(IProviderInfo provider, SynchronousRequestResponse interaction, String interactionMessage, Map<String, Object> failures, ProviderClient client)

  Verifies the response from the provider against the interaction

• verifyResponseFromProvider

   VerificationResult verifyResponseFromProvider(IProviderInfo provider, SynchronousRequestResponse interaction, String interactionMessage, Map<String, Object> failures, ProviderClient client, Map<String, Object> context, Boolean pending)

  Verifies the response from the provider against the interaction

• verifyProvider

   List<VerificationResult> verifyProvider(IProviderInfo provider)

  Run the verification for the given provider and return any failures

• initialiseReporters

   Unit initialiseReporters(IProviderInfo provider)

• runVerificationForConsumer

  @JvmOverloads() final VerificationResult runVerificationForConsumer(Map<String, Object> failures, IProviderInfo provider, IConsumerInfo consumer, IPactBrokerClient client)

• runVerificationForConsumer

  @JvmOverloads() final VerificationResult runVerificationForConsumer(Map<String, Object> failures, IProviderInfo provider, IConsumerInfo consumer)

• initialisePlugins

   final Unit initialisePlugins(Pact pact)

  Initialise any required plugins and plugin entries required for the verification

• reportVerificationForConsumer

   Unit reportVerificationForConsumer(IConsumerInfo consumer, IProviderInfo provider, PactSource pactSource)

• verifyInteractionViaPlugin

   VerificationResult verifyInteractionViaPlugin(IProviderInfo providerInfo, IConsumerInfo consumer, V4Pact pact, V4Interaction interaction, Object client, Object request, Map<String, Object> context)

  Verification executed by a plugin

• displayOutput

   Unit displayOutput(List<String> output)

  Display any output to the user

• loadPactFileForConsumer

   final Pact loadPactFileForConsumer(IConsumerInfo consumer)

• filterConsumers

   final Boolean filterConsumers(IConsumerInfo consumer)

• filterInteractions

   final Boolean filterInteractions(Interaction interaction)

• reportStateForInteraction

   Unit reportStateForInteraction(String state, IProviderInfo provider, IConsumerInfo consumer, Boolean isSetup)

  Reports the state of the interaction to all the registered reporters