Package com.github.tomakehurst.wiremock.message

Class MessageStubMapping.Builder

java.lang.Object

com.github.tomakehurst.wiremock.message.MessageStubMapping.Builder

All Implemented Interfaces:

MessageStubMappingBuilder

Enclosing class:

MessageStubMapping

public static class MessageStubMapping.Builder
extends Object
implements MessageStubMappingBuilder

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(MessageStubMapping existing)

Method Summary

Modifier and Type	Method	Description
MessageStubMapping.Builder	atPriority(Integer priority)	Sets the priority for this message stub mapping.
MessageStubMapping	build()	Builds the MessageStubMapping from the current builder state.
long	getInsertionIndex()
MessageStubMapping.Builder	onChannelFromRequestMatching(ChannelType channelType, RequestPattern requestPattern)
MessageStubMapping.Builder	onChannelFromRequestMatching(ChannelType channelType, RequestPatternBuilder channelPatternBuilder)
MessageStubMapping.Builder	onChannelFromRequestMatching(ChannelType channelType, String urlPath)
MessageStubMapping.Builder	onWebsocketChannelFromRequestMatching(RequestPatternBuilder channelPatternBuilder)
MessageStubMapping.Builder	onWebsocketChannelFromRequestMatching(String urlPath)
MessageStubMapping.Builder	setInsertionIndex(long insertionIndex)
MessageStubMapping.Builder	triggeredByHttpRequest(RequestPattern requestPattern)
MessageStubMapping.Builder	triggeredByHttpRequest(RequestPatternBuilder requestPatternBuilder)
MessageStubMapping.Builder	triggeredByHttpStub(String stubId)
MessageStubMapping.Builder	triggeredByHttpStub(UUID stubId)
MessageStubMapping.Builder	triggersAction(MessageAction action)
MessageStubMapping	willTriggerActions(MessageAction... actions)	Configures the actions to trigger when this stub matches.
MessageStubMapping.Builder	withActions(List<MessageAction> actions)
MessageStubMapping.Builder	withBody(ContentPattern<?> bodyPattern)
MessageStubMapping.Builder	withId(UUID id)	Sets the unique identifier for this message stub mapping.
MessageStubMapping.Builder	withMessageBody(StringValuePattern messagePattern)	Sets a pattern to match the message content.
MessageStubMapping.Builder	withMetadata(Metadata metadata)	Sets metadata for this message stub mapping.
MessageStubMapping.Builder	withMetadata(Metadata.Builder metadata)	Sets metadata for this message stub mapping.
MessageStubMapping.Builder	withMetadata(Map<String,?> metadataMap)	Sets metadata for this message stub mapping.
MessageStubMapping.Builder	withName(String name)	Sets a human-readable name for this message stub mapping.
MessageStubMapping.Builder	withPriority(Integer priority)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Builder

public Builder(MessageStubMapping existing)

Method Details

withId

public MessageStubMapping.Builder withId(UUID id)

Description copied from interface: MessageStubMappingBuilder

Sets the unique identifier for this message stub mapping.

Specified by:

withId in interface MessageStubMappingBuilder

Parameters:

id - the UUID to assign

Returns:

this builder

withName

public MessageStubMapping.Builder withName(String name)

Description copied from interface: MessageStubMappingBuilder

Sets a human-readable name for this message stub mapping.

Specified by:

withName in interface MessageStubMappingBuilder

Parameters:

name - the name to assign

Returns:

this builder

atPriority

public MessageStubMapping.Builder atPriority(Integer priority)

Description copied from interface: MessageStubMappingBuilder

Sets the priority for this message stub mapping. Lower numbers indicate higher priority.

Specified by:

atPriority in interface MessageStubMappingBuilder

Parameters:

priority - the priority value

Returns:

this builder

withPriority

public MessageStubMapping.Builder withPriority(Integer priority)

withMessageBody

public MessageStubMapping.Builder withMessageBody(StringValuePattern messagePattern)

Description copied from interface: MessageStubMappingBuilder

Sets a pattern to match the message content.

Specified by:

withMessageBody in interface MessageStubMappingBuilder

Parameters:

messagePattern - the pattern to match against incoming messages

Returns:

this builder

onWebsocketChannelFromRequestMatching

public MessageStubMapping.Builder onWebsocketChannelFromRequestMatching(String urlPath)

onWebsocketChannelFromRequestMatching

public MessageStubMapping.Builder onWebsocketChannelFromRequestMatching(RequestPatternBuilder channelPatternBuilder)

onChannelFromRequestMatching

public MessageStubMapping.Builder onChannelFromRequestMatching(ChannelType channelType,
 String urlPath)

onChannelFromRequestMatching

public MessageStubMapping.Builder onChannelFromRequestMatching(ChannelType channelType,
 RequestPatternBuilder channelPatternBuilder)

onChannelFromRequestMatching

public MessageStubMapping.Builder onChannelFromRequestMatching(ChannelType channelType,
 RequestPattern requestPattern)

withBody

public MessageStubMapping.Builder withBody(ContentPattern<?> bodyPattern)

triggeredByHttpStub

public MessageStubMapping.Builder triggeredByHttpStub(UUID stubId)

triggeredByHttpStub

public MessageStubMapping.Builder triggeredByHttpStub(String stubId)

triggeredByHttpRequest

public MessageStubMapping.Builder triggeredByHttpRequest(RequestPattern requestPattern)

triggeredByHttpRequest

public MessageStubMapping.Builder triggeredByHttpRequest(RequestPatternBuilder requestPatternBuilder)

withActions

public MessageStubMapping.Builder withActions(List<MessageAction> actions)

willTriggerActions

public MessageStubMapping willTriggerActions(MessageAction... actions)

Description copied from interface: MessageStubMappingBuilder

Configures the actions to trigger when this stub matches. This method terminates the builder chain and returns the built MessageStubMapping.

Specified by:

willTriggerActions in interface MessageStubMappingBuilder

Parameters:

actions - the actions to execute when matched

Returns:

the built MessageStubMapping

triggersAction

public MessageStubMapping.Builder triggersAction(MessageAction action)

withMetadata

public MessageStubMapping.Builder withMetadata(Map<String,?> metadataMap)

Description copied from interface: MessageStubMappingBuilder

Sets metadata for this message stub mapping.

Specified by:

withMetadata in interface MessageStubMappingBuilder

Parameters:

metadataMap - the metadata map

Returns:

this builder

withMetadata

public MessageStubMapping.Builder withMetadata(Metadata metadata)

Description copied from interface: MessageStubMappingBuilder

Sets metadata for this message stub mapping.

Specified by:

withMetadata in interface MessageStubMappingBuilder

Parameters:

metadata - the metadata object

Returns:

this builder

withMetadata

public MessageStubMapping.Builder withMetadata(Metadata.Builder metadata)

Description copied from interface: MessageStubMappingBuilder

Sets metadata for this message stub mapping.

Specified by:

withMetadata in interface MessageStubMappingBuilder

Parameters:

metadata - the metadata builder

Returns:

this builder

getInsertionIndex

public long getInsertionIndex()

setInsertionIndex

public MessageStubMapping.Builder setInsertionIndex(long insertionIndex)

build

public MessageStubMapping build()

Description copied from interface: MessageStubMappingBuilder

Builds the MessageStubMapping from the current builder state.

Specified by:

build in interface MessageStubMappingBuilder

Returns:

the built MessageStubMapping