Package org.mockserver.model

Class TcpChaosProfile

java.lang.Object

org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

org.mockserver.model.ObjectWithJsonToString

org.mockserver.model.TcpChaosProfile

public class TcpChaosProfile
extends ObjectWithJsonToString

Declarative TCP-layer fault/chaos injection profile, applied at the raw byte level before HTTP decoding. Each fault type mirrors one of Toxiproxy's named toxics:

• latency — delay all inbound data by latencyMs milliseconds
• down — silently drop all inbound data (service appears down)
• bandwidth — throttle inbound data to bandwidthBytesPerSec
• slow_close — delay the TCP FIN by 2 seconds
• timeout — never send FIN; connection hangs on close
• reset_peer — send TCP RST and close immediately
• slicer — fragment inbound data into chunks of slicerChunkSize bytes
• limit_data — close the connection after limitDataBytes bytes received

Profiles are registered in the TcpChaosRegistry and applied by the TcpChaosHandler Netty handler. When multiple faults are configured on the same profile, they are evaluated in priority order: down, resetPeer, limitData, slicer, bandwidth, latency.

Follows the model field/withX/getter convention so it round-trips through Jackson without a bespoke (de)serializer.

Constructor Summary

Constructors

Constructor	Description
TcpChaosProfile()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Long	getBandwidthBytesPerSec()
Boolean	getDown()
Long	getLatencyMs()
Long	getLimitDataBytes()
Boolean	getResetPeer()
Integer	getSlicerChunkSize()
Boolean	getSlowClose()
Boolean	getTimeout()
boolean	hasAnyFault()	Returns true when at least one fault is configured (non-null and meaningful).
int	hashCode()
static TcpChaosProfile	tcpChaosProfile()
TcpChaosProfile	withBandwidthBytesPerSec(Long bandwidthBytesPerSec)
TcpChaosProfile	withDown(Boolean down)
TcpChaosProfile	withLatencyMs(Long latencyMs)
TcpChaosProfile	withLimitDataBytes(Long limitDataBytes)
TcpChaosProfile	withResetPeer(Boolean resetPeer)
TcpChaosProfile	withSlicerChunkSize(Integer slicerChunkSize)
TcpChaosProfile	withSlowClose(Boolean slowClose)
TcpChaosProfile	withTimeout(Boolean timeout)

Methods inherited from class org.mockserver.model.ObjectWithJsonToString

toString

Methods inherited from class org.mockserver.model.ObjectWithReflectiveEqualsHashCodeToString

fieldsExcludedFromEqualsAndHashCode

Methods inherited from class java.lang.Object

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

Constructor Details

TcpChaosProfile

public TcpChaosProfile()

Method Details

tcpChaosProfile

public static TcpChaosProfile tcpChaosProfile()

getLatencyMs

public Long getLatencyMs()

withLatencyMs

public TcpChaosProfile withLatencyMs(Long latencyMs)

getDown

public Boolean getDown()

withDown

public TcpChaosProfile withDown(Boolean down)

getBandwidthBytesPerSec

public Long getBandwidthBytesPerSec()

withBandwidthBytesPerSec

public TcpChaosProfile withBandwidthBytesPerSec(Long bandwidthBytesPerSec)

getSlowClose

public Boolean getSlowClose()

withSlowClose

public TcpChaosProfile withSlowClose(Boolean slowClose)

getTimeout

public Boolean getTimeout()

withTimeout

public TcpChaosProfile withTimeout(Boolean timeout)

getResetPeer

public Boolean getResetPeer()

withResetPeer

public TcpChaosProfile withResetPeer(Boolean resetPeer)

getSlicerChunkSize

public Integer getSlicerChunkSize()

withSlicerChunkSize

public TcpChaosProfile withSlicerChunkSize(Integer slicerChunkSize)

getLimitDataBytes

public Long getLimitDataBytes()

withLimitDataBytes

public TcpChaosProfile withLimitDataBytes(Long limitDataBytes)

hasAnyFault

public boolean hasAnyFault()

Returns true when at least one fault is configured (non-null and meaningful).

equals

public boolean equals(Object o)

Overrides:

equals in class ObjectWithReflectiveEqualsHashCodeToString

hashCode

public int hashCode()

Overrides:

hashCode in class ObjectWithReflectiveEqualsHashCodeToString