ClientConfiguration (MockServer Core 5.15.0 API)

java.lang.Object
- org.mockserver.configuration.ClientConfiguration

public class ClientConfiguration
extends Object

Constructor Summary

Constructors
Constructor and Description

ClientConfiguration()

ClientConfiguration(Configuration serverConfiguration)

Constructors
Constructor and Description
`ClientConfiguration()`
`ClientConfiguration(Configuration serverConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ClientConfiguration`	`clientConfiguration()`
`static ClientConfiguration`	`clientConfiguration(Configuration configuration)`
`Integer`	`clientNioEventLoopThreadCount()`
`ClientConfiguration`	`clientNioEventLoopThreadCount(Integer clientNioEventLoopThreadCount)` Client Netty worker thread pool size for handling requests and response.
`String`	`controlPlaneJWTAuthenticationJWKSource()`
`ClientConfiguration`	`controlPlaneJWTAuthenticationJWKSource(String controlPlaneJWTAuthenticationJWKSource)`
`Boolean`	`controlPlaneJWTAuthenticationRequired()`
`ClientConfiguration`	`controlPlaneJWTAuthenticationRequired(Boolean controlPlaneJWTAuthenticationRequired)`
`String`	`controlPlanePrivateKeyPath()`
`ClientConfiguration`	`controlPlanePrivateKeyPath(String controlPlanePrivateKeyPath)`
`String`	`controlPlaneTLSMutualAuthenticationCAChain()`
`ClientConfiguration`	`controlPlaneTLSMutualAuthenticationCAChain(String controlPlaneTLSMutualAuthenticationCAChain)`
`Boolean`	`controlPlaneTLSMutualAuthenticationRequired()`
`ClientConfiguration`	`controlPlaneTLSMutualAuthenticationRequired(Boolean controlPlaneTLSMutualAuthenticationRequired)`
`String`	`controlPlaneX509CertificatePath()`
`ClientConfiguration`	`controlPlaneX509CertificatePath(String controlPlaneX509CertificatePath)`
`Long`	`maxFutureTimeoutInMillis()`
`ClientConfiguration`	`maxFutureTimeoutInMillis(Long maxFutureTimeoutInMillis)` Maximum time allowed in milliseconds for any future to wait, for example when waiting for a response over a web socket callback.
`Long`	`maxSocketTimeoutInMillis()`
`ClientConfiguration`	`maxSocketTimeoutInMillis(Long maxSocketTimeoutInMillis)` Maximum time in milliseconds allowed for a response from a socket
`Integer`	`maxWebSocketExpectations()`
`ClientConfiguration`	`maxWebSocketExpectations(Integer maxWebSocketExpectations)` Maximum number of remote (not the same JVM) method callbacks (i.e.
`Configuration`	`toServerConfiguration()`
`Integer`	`webSocketClientEventLoopThreadCount()`
`ClientConfiguration`	`webSocketClientEventLoopThreadCount(Integer webSocketClientEventLoopThreadCount)` Client Netty worker thread pool size for handling requests and response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClientConfiguration
```
public ClientConfiguration()
```
  - ClientConfiguration
```
public ClientConfiguration(Configuration serverConfiguration)
```
- Method Detail
  - clientConfiguration
```
public static ClientConfiguration clientConfiguration()
```
  - clientConfiguration
```
public static ClientConfiguration clientConfiguration(Configuration configuration)
```
  - toServerConfiguration
```
public Configuration toServerConfiguration()
```
  - maxWebSocketExpectations
```
public Integer maxWebSocketExpectations()
```
  - maxWebSocketExpectations
```
public ClientConfiguration maxWebSocketExpectations(Integer maxWebSocketExpectations)
```
    Maximum number of remote (not the same JVM) method callbacks (i.e. web sockets) registered for expectations. The web socket client registry entries are stored in a circular queue so once this limit is reach the oldest are overwritten.
    
    The default is 1500
    
    Parameters:
    
    maxWebSocketExpectations - maximum number of method callbacks (i.e. web sockets) registered for expectations
  - webSocketClientEventLoopThreadCount
```
public Integer webSocketClientEventLoopThreadCount()
```
  - webSocketClientEventLoopThreadCount
```
public ClientConfiguration webSocketClientEventLoopThreadCount(Integer webSocketClientEventLoopThreadCount)
```
    Client Netty worker thread pool size for handling requests and response. These threads handle deserializing and serialising HTTP requests and responses and some other fast logic.
    
    Default is 5 threads
    
    Parameters:
    
    webSocketClientEventLoopThreadCount - Client Netty worker thread pool size
  - clientNioEventLoopThreadCount
```
public Integer clientNioEventLoopThreadCount()
```
  - clientNioEventLoopThreadCount
```
public ClientConfiguration clientNioEventLoopThreadCount(Integer clientNioEventLoopThreadCount)
```
    Client Netty worker thread pool size for handling requests and response. These threads handle deserializing and serialising HTTP requests and responses and some other fast logic.
    
    Default is 5 threads
    
    Parameters:
    
    clientNioEventLoopThreadCount - Client Netty worker thread pool size
  - maxSocketTimeoutInMillis
```
public Long maxSocketTimeoutInMillis()
```
  - maxSocketTimeoutInMillis
```
public ClientConfiguration maxSocketTimeoutInMillis(Long maxSocketTimeoutInMillis)
```
    Maximum time in milliseconds allowed for a response from a socket
    Default is 20,000 ms
    
    Parameters:
    
    maxSocketTimeoutInMillis - maximum time in milliseconds allowed
  - maxFutureTimeoutInMillis
```
public Long maxFutureTimeoutInMillis()
```
  - maxFutureTimeoutInMillis
```
public ClientConfiguration maxFutureTimeoutInMillis(Long maxFutureTimeoutInMillis)
```
    Maximum time allowed in milliseconds for any future to wait, for example when waiting for a response over a web socket callback.
    Default is 60,000 ms
    
    Parameters:
    
    maxFutureTimeoutInMillis - maximum time allowed in milliseconds
  - controlPlaneTLSMutualAuthenticationRequired
```
public Boolean controlPlaneTLSMutualAuthenticationRequired()
```
  - controlPlaneTLSMutualAuthenticationRequired
```
public ClientConfiguration controlPlaneTLSMutualAuthenticationRequired(Boolean controlPlaneTLSMutualAuthenticationRequired)
```
  - controlPlaneTLSMutualAuthenticationCAChain
```
public String controlPlaneTLSMutualAuthenticationCAChain()
```
  - controlPlaneTLSMutualAuthenticationCAChain
```
public ClientConfiguration controlPlaneTLSMutualAuthenticationCAChain(String controlPlaneTLSMutualAuthenticationCAChain)
```
  - controlPlanePrivateKeyPath
```
public String controlPlanePrivateKeyPath()
```
  - controlPlanePrivateKeyPath
```
public ClientConfiguration controlPlanePrivateKeyPath(String controlPlanePrivateKeyPath)
```
  - controlPlaneX509CertificatePath
```
public String controlPlaneX509CertificatePath()
```
  - controlPlaneX509CertificatePath
```
public ClientConfiguration controlPlaneX509CertificatePath(String controlPlaneX509CertificatePath)
```
  - controlPlaneJWTAuthenticationRequired
```
public Boolean controlPlaneJWTAuthenticationRequired()
```
  - controlPlaneJWTAuthenticationRequired
```
public ClientConfiguration controlPlaneJWTAuthenticationRequired(Boolean controlPlaneJWTAuthenticationRequired)
```
  - controlPlaneJWTAuthenticationJWKSource
```
public String controlPlaneJWTAuthenticationJWKSource()
```
  - controlPlaneJWTAuthenticationJWKSource
```
public ClientConfiguration controlPlaneJWTAuthenticationJWKSource(String controlPlaneJWTAuthenticationJWKSource)
```

Class ClientConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientConfiguration

ClientConfiguration

Method Detail

clientConfiguration

clientConfiguration

toServerConfiguration

maxWebSocketExpectations

maxWebSocketExpectations

webSocketClientEventLoopThreadCount

webSocketClientEventLoopThreadCount

clientNioEventLoopThreadCount

clientNioEventLoopThreadCount

maxSocketTimeoutInMillis

maxSocketTimeoutInMillis

maxFutureTimeoutInMillis

maxFutureTimeoutInMillis

controlPlaneTLSMutualAuthenticationRequired

controlPlaneTLSMutualAuthenticationRequired

controlPlaneTLSMutualAuthenticationCAChain

controlPlaneTLSMutualAuthenticationCAChain

controlPlanePrivateKeyPath

controlPlanePrivateKeyPath

controlPlaneX509CertificatePath

controlPlaneX509CertificatePath

controlPlaneJWTAuthenticationRequired

controlPlaneJWTAuthenticationRequired

controlPlaneJWTAuthenticationJWKSource

controlPlaneJWTAuthenticationJWKSource