Package org.mockserver.springboot

Class MockServerAutoConfiguration

java.lang.Object

org.mockserver.springboot.MockServerAutoConfiguration

@AutoConfiguration
@ConditionalOnProperty(prefix="mockserver",
                       name="enabled",
                       havingValue="true")
@EnableConfigurationProperties(MockServerProperties.class)
public class MockServerAutoConfiguration
extends Object

Spring Boot auto-configuration that starts a ClientAndServer and exposes it as a MockServerClient bean, driven by mockserver.* properties (see MockServerProperties).

Development / test only. This starts a real MockServer instance inside the application context, so it is intended for integration tests and local development - not production. It is disabled by default and only activates when mockserver.enabled=true is set.

Lifecycle: the ClientAndServer bean is created when the application context is refreshed (server starts) and stopped when the context is closed (via the bean destroyMethod).

A single ClientAndServer bean is registered. Because ClientAndServer extends MockServerClient, that one bean satisfies injection points typed as either ClientAndServer or MockServerClient (and getBean(MockServerClient.class)). Register your own ClientAndServer bean to override the auto-configured one - the ConditionalOnMissingBean guard then backs off.

Constructor Summary

Constructors

Constructor	Description
MockServerAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
ClientAndServer	mockServerClientAndServer(MockServerProperties properties)	Starts a MockServer instance and exposes it as a ClientAndServer bean.

Methods inherited from class java.lang.Object

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

Constructor Details

MockServerAutoConfiguration

public MockServerAutoConfiguration()

Method Details

mockServerClientAndServer

@Bean(destroyMethod="stop")
@ConditionalOnMissingBean
public ClientAndServer mockServerClientAndServer(MockServerProperties properties)

Starts a MockServer instance and exposes it as a ClientAndServer bean. Because ClientAndServer extends MockServerClient, this single bean also satisfies injection points that request a MockServerClient.

The bean's destroyMethod is stop, so the embedded server is shut down when the Spring context is closed.