Class MockServer

java.lang.Object
org.mockserver.lifecycle.LifeCycle
org.mockserver.netty.MockServer
All Implemented Interfaces:
Closeable, AutoCloseable, Stoppable

public class MockServer extends LifeCycle
Author:
jamesdbloom
  • Constructor Details

    • MockServer

      public MockServer(Integer... localPorts)
      Start the instance using the ports provided
      Parameters:
      localPorts - the local port(s) to use, use 0 or no vararg values to specify any free port
    • MockServer

      public MockServer(Configuration configuration, Integer... localPorts)
      Start the instance using the ports provided
      Parameters:
      localPorts - the local port(s) to use, use 0 or no vararg values to specify any free port
    • MockServer

      public MockServer(ProxyConfiguration proxyConfiguration, Integer... localPorts)
      Start the instance using the ports provided configuring forwarded or proxied requests to go via an additional proxy
      Parameters:
      proxyConfiguration - the proxy configuration to send requests forwarded or proxied by MockServer via another proxy
      localPorts - the local port(s) to use, use 0 or no vararg values to specify any free port
    • MockServer

      public MockServer(Configuration configuration, List<ProxyConfiguration> proxyConfigurations, Integer... localPorts)
      Start the instance using the ports provided configuring forwarded or proxied requests to go via an additional proxy
      Parameters:
      proxyConfigurations - the proxy configuration to send requests forwarded or proxied by MockServer via another proxy
      localPorts - the local port(s) to use, use 0 or no vararg values to specify any free port
    • MockServer

      public MockServer(Integer remotePort, @Nullable String remoteHost, Integer... localPorts)
      Start the instance using the ports provided
      Parameters:
      remotePort - the port of the remote server to connect to
      remoteHost - the hostname of the remote server to connect to (if null defaults to "localhost")
      localPorts - the local port(s) to use
    • MockServer

      public MockServer(Configuration configuration, Integer remotePort, @Nullable String remoteHost, Integer... localPorts)
      Start the instance using the ports provided
      Parameters:
      remotePort - the port of the remote server to connect to
      remoteHost - the hostname of the remote server to connect to (if null defaults to "localhost")
      localPorts - the local port(s) to use
    • MockServer

      public MockServer(Configuration configuration, ProxyConfiguration proxyConfiguration, @Nullable String remoteHost, Integer remotePort, Integer... localPorts)
      Start the instance using the ports provided configuring forwarded or proxied requests to go via an additional proxy
      Parameters:
      localPorts - the local port(s) to use
      remoteHost - the hostname of the remote server to connect to (if null defaults to "localhost")
      remotePort - the port of the remote server to connect to
    • MockServer

      public MockServer(Configuration configuration, List<ProxyConfiguration> proxyConfigurations, @Nullable String remoteHost, Integer remotePort, Integer... localPorts)
      Start the instance using the ports provided configuring forwarded or proxied requests to go via an additional proxy
      Parameters:
      localPorts - the local port(s) to use
      remoteHost - the hostname of the remote server to connect to (if null defaults to "localhost")
      remotePort - the port of the remote server to connect to
  • Method Details

    • getRemoteAddress

      public InetSocketAddress getRemoteAddress()
    • registerListener

      public MockServer registerListener(ExpectationsListener expectationsListener)
      Overrides:
      registerListener in class LifeCycle
    • getDnsPort

      public int getDnsPort()
    • getHttp3Port

      public int getHttp3Port()
      Returns the bound HTTP/3 (QUIC) UDP port, or -1 if the HTTP/3 server is not running.
    • getHttp3ActiveConnectionCount

      public int getHttp3ActiveConnectionCount()
      Returns the current number of active HTTP/3 (QUIC) connections, or 0 if the HTTP/3 server is not running.
    • stopAsync

      public CompletableFuture<String> stopAsync()
      Overrides:
      stopAsync in class LifeCycle