au.com.dius.pact.consumer.dsl

Class MetadataBuilder

au.com.dius.pact.consumer.dsl.MetadataBuilder

public class MetadataBuilder

Constructor Detail

MetadataBuilder

public MetadataBuilder(@NotNull
                       java.util.Map<java.lang.String,java.lang.Object> values,
                       @NotNull
                       au.com.dius.pact.core.model.matchingrules.Category matchers,
                       @NotNull
                       java.util.Map<java.lang.String,au.com.dius.pact.core.model.generators.Generator> generators)

MetadataBuilder

public MetadataBuilder()

Method Detail

add

@NotNull
public MetadataBuilder add(@NotNull
                                    java.lang.String key,
                                    @Nullable
                                    java.lang.Object value)

Add an entry to the metadata

like

@NotNull
public MetadataBuilder like(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.Object example)

Attribute that must be the same type as the example

Parameters:

name - attribute name

numberType

@NotNull
public MetadataBuilder numberType(@NotNull
                                           java.lang.String name,
                                           @NotNull
                                           java.lang.Number number)

Attribute that can be any number

Parameters:

name - attribute name

number - example number to use for generated messages

integerType

@NotNull
public MetadataBuilder integerType(@NotNull
                                            java.lang.String name,
                                            long number)

Attribute that must be an integer

Parameters:

name - attribute name

number - example integer value to use for generated messages

integerType

@NotNull
public MetadataBuilder integerType(@NotNull
                                            java.lang.String name,
                                            int number)

Attribute that must be an integer

Parameters:

name - attribute name

number - example integer value to use for generated messages

decimalType

@NotNull
public MetadataBuilder decimalType(@NotNull
                                            java.lang.String name,
                                            @NotNull
                                            java.math.BigDecimal number)

Attribute that must be a decimalType value

Parameters:

name - attribute name

number - example decimalType value

decimalType

@NotNull
public MetadataBuilder decimalType(@NotNull
                                            java.lang.String name,
                                            double number)

Attribute that must be a decimalType value

Parameters:

name - attribute name

number - example decimalType value

booleanType

@NotNull
public MetadataBuilder booleanType(@NotNull
                                            java.lang.String name,
                                            boolean example)

Attribute that must be a boolean

Parameters:

name - attribute name

example - example boolean to use for generated bodies

matchRegex

@NotNull
public MetadataBuilder matchRegex(@NotNull
                                           java.lang.String name,
                                           @NotNull
                                           java.lang.String regex,
                                           @NotNull
                                           java.lang.String value)

Attribute that must match the regular expression

Parameters:

name - attribute name

regex - regular expression

value - example value to use for generated bodies

datetime

@NotNull
public MetadataBuilder datetime(@NotNull
                                         java.lang.String name)

Attribute that must be an ISO formatted datetime

Parameters:

name -

datetime

@NotNull
public MetadataBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

datetime

@NotNull
public MetadataBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.util.Date example)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

datetime

@NotNull
public MetadataBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.util.Date example,
                                         @NotNull
                                         java.util.TimeZone timeZone)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

datetime

@NotNull
public MetadataBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.time.Instant example)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - datetime format

example - example date and time to use for generated bodies

datetime

@NotNull
public MetadataBuilder datetime(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String format,
                                         @NotNull
                                         java.time.Instant example,
                                         @NotNull
                                         java.util.TimeZone timeZone)

Attribute that must match the given datetime format

Parameters:

name - attribute name

format - timestamp format

example - example date and time to use for generated bodies

timeZone - time zone used for formatting of example date and time

date

@NotNull
public MetadataBuilder date(@NotNull
                                     java.lang.String name)

Attribute that must be formatted as an ISO date

Parameters:

name - attribute name

date

@NotNull
public MetadataBuilder date(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

date

@NotNull
public MetadataBuilder date(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

date

@NotNull
public MetadataBuilder date(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example,
                                     @NotNull
                                     java.util.TimeZone timeZone)

Attribute that must match the provided date format

Parameters:

name - attribute date

format - date format to match

example - example date to use for generated values

timeZone - time zone used for formatting of example date

time

@NotNull
public MetadataBuilder time(@NotNull
                                     java.lang.String name)

Attribute that must be an ISO formatted time

Parameters:

name - attribute name

time

@NotNull
public MetadataBuilder time(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

time

@NotNull
public MetadataBuilder time(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated bodies

time

@NotNull
public MetadataBuilder time(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String format,
                                     @NotNull
                                     java.util.Date example,
                                     @NotNull
                                     java.util.TimeZone timeZone)

Attribute that must match the given time format

Parameters:

name - attribute name

format - time format to match

example - example time to use for generated bodies

timeZone - time zone used for formatting of example time

ipAddress

@NotNull
public MetadataBuilder ipAddress(@NotNull
                                          java.lang.String name)

Attribute that must be an IP4 address

Parameters:

name - attribute name

hexValue

@NotNull
public MetadataBuilder hexValue(@NotNull
                                         java.lang.String name)

Attribute that must be encoded as a hexadecimal value

Parameters:

name - attribute name

hexValue

@NotNull
public MetadataBuilder hexValue(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String hexValue)

Attribute that must be encoded as a hexadecimal value

Parameters:

name - attribute name

hexValue - example value to use for generated bodies

uuid

@NotNull
public MetadataBuilder uuid(@NotNull
                                     java.lang.String name)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid

@NotNull
public MetadataBuilder uuid(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.util.UUID uuid)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid - example UUID to use for generated bodies

uuid

@NotNull
public MetadataBuilder uuid(@NotNull
                                     java.lang.String name,
                                     @NotNull
                                     java.lang.String uuid)

Attribute that must be encoded as an UUID

Parameters:

name - attribute name

uuid - example UUID to use for generated bodies

includesStr

@NotNull
public MetadataBuilder includesStr(@NotNull
                                            java.lang.String name,
                                            @NotNull
                                            java.lang.String value)

Attribute that must include the provided string value

Parameters:

name - attribute name

value - Value that must be included

matchUrl

@NotNull
public MetadataBuilder matchUrl(@NotNull
                                         java.lang.String name,
                                         @NotNull
                                         java.lang.String basePath,
                                         @NotNull
                                         java.lang.Object... pathFragments)

Matches a URL that is composed of a base path and a sequence of path expressions

Parameters:

name - Attribute name

basePath - The base path for the URL (like "http://localhost:8080/") which will be excluded from the matching

pathFragments - Series of path fragments to match on. These can be strings or regular expressions.

valueFromProviderState

@NotNull
public MetadataBuilder valueFromProviderState(@NotNull
                                                       java.lang.String name,
                                                       @NotNull
                                                       java.lang.String expression,
                                                       @NotNull
                                                       java.lang.Object example)

Adds an attribute that will have it's value injected from the provider state

Parameters:

name - Attribute name

expression - Expression to be evaluated from the provider state

example - Example value to be used in the consumer test

dateExpression

@NotNull
public MetadataBuilder dateExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression)

Adds a date attribute formatted as an ISO date with the value generated by the date expression

Parameters:

name - Attribute name

expression - Date expression to use to generate the values

dateExpression

@NotNull
public MetadataBuilder dateExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression,
                                               @NotNull
                                               java.lang.String format)

Adds a date attribute with the value generated by the date expression

Parameters:

name - Attribute name

expression - Date expression to use to generate the values

format - Date format to use

timeExpression

@NotNull
public MetadataBuilder timeExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression)

Adds a time attribute formatted as an ISO time with the value generated by the time expression

Parameters:

name - Attribute name

expression - Time expression to use to generate the values

timeExpression

@NotNull
public MetadataBuilder timeExpression(@NotNull
                                               java.lang.String name,
                                               @NotNull
                                               java.lang.String expression,
                                               @NotNull
                                               java.lang.String format)

Adds a time attribute with the value generated by the time expression

Parameters:

name - Attribute name

expression - Time expression to use to generate the values

format - Time format to use

datetimeExpression

@NotNull
public MetadataBuilder datetimeExpression(@NotNull
                                                   java.lang.String name,
                                                   @NotNull
                                                   java.lang.String expression)

Adds a datetime attribute formatted as an ISO datetime with the value generated by the expression

Parameters:

name - Attribute name

expression - Datetime expression to use to generate the values

datetimeExpression

@NotNull
public MetadataBuilder datetimeExpression(@NotNull
                                                   java.lang.String name,
                                                   @NotNull
                                                   java.lang.String expression,
                                                   @NotNull
                                                   java.lang.String format)

Adds a datetime attribute with the value generated by the expression

Parameters:

name - Attribute name

expression - Datetime expression to use to generate the values

format - Datetime format to use

getValues

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getValues()

getMatchers

@NotNull
public au.com.dius.pact.core.model.matchingrules.Category getMatchers()

getGenerators

@NotNull
public java.util.Map<java.lang.String,au.com.dius.pact.core.model.generators.Generator> getGenerators()