org.mockserver.maven

Class MockServerAbstractMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.mockserver.maven.MockServerAbstractMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

MockServerRunAndWaitMojo, MockServerRunForkedMojo, MockServerStartMojo, MockServerStopForkedMojo, MockServerStopMojo

public abstract class MockServerAbstractMojo
extends org.apache.maven.plugin.AbstractMojo

Author:

jamesdbloom

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	compileClasspath The main classpath location of the project using this plugin
protected List<org.apache.maven.model.Dependency>	dependencies The plugin dependencies
protected String	initializationClass To enable the creation of default expectations that are generic across all tests or mocking scenarios a class can be specified to initialize expectations in the MockServer, this class must implement org.mockserver.initialize.PluginExpectationInitializer interface, the initializeExpectations(MockServerClient mockServerClient) method will be called once the MockServer has been started (but ONLY if serverPort has been set), however it should be noted that it is generally better practice to create all expectations locally in each test (or test class) for clarity, simplicity and to avoid brittle tests
protected String	initializationJson To enable the creation of default expectations that are generic across all tests or mocking scenarios a json filed can be specified to initialize expectations in the MockServer.
protected static InstanceHolder	instanceHolder Holds reference to jetty across plugin execution
protected String	logLevel Optionally specify log level as TRACE, DEBUG, INFO, WARN, ERROR or OFF.
protected boolean	pipeLogToConsole If true the console of the forked JVM will be piped to the Maven console
protected String	proxyRemoteHost Specified the host to forward all proxy requests to when port forwarding mode has been enabled using the proxyRemotePort option.
protected Integer	proxyRemotePort Optionally enables port forwarding mode.
protected String	serverPort The HTTP, HTTPS, SOCKS and HTTP CONNECT port for the MockServer for both mocking and proxying requests.
protected boolean	skip Skip the plugin execution completely
protected List<String>	testClasspath The test classpath location of the project using this plugin
protected Integer	timeout Timeout to wait before stopping MockServer, to run MockServer indefinitely do not set a value

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
MockServerAbstractMojo()

Method Summary

Modifier and Type	Method and Description
protected org.mockserver.client.initialize.ExpectationInitializer	createInitializerClass()
protected String	createInitializerJson()
protected InstanceHolder	getLocalMockServerInstance()
static void	mockServerPort(Integer... port)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

instanceHolder

protected static InstanceHolder instanceHolder

Holds reference to jetty across plugin execution

serverPort

@Parameter(property="mockserver.serverPort")
protected String serverPort

The HTTP, HTTPS, SOCKS and HTTP CONNECT port for the MockServer for both mocking and proxying requests. Port unification is used to support all protocols for proxying and mocking on the same port.

proxyRemotePort

@Parameter(property="mockserver.proxyRemotePort",
           defaultValue="-1")
protected Integer proxyRemotePort

Optionally enables port forwarding mode. When specified all requests received will be forwarded to the specified port, unless they match an expectation.

proxyRemoteHost

@Parameter(property="mockserver.proxyRemoteHost")
protected String proxyRemoteHost

Specified the host to forward all proxy requests to when port forwarding mode has been enabled using the proxyRemotePort option. This setting is ignored unless proxyRemotePort has been specified. If no value is provided for proxyRemoteHost when proxyRemotePort has been specified, proxyRemoteHost will default to \"localhost\".

timeout

@Parameter(property="mockserver.timeout")
protected Integer timeout

Timeout to wait before stopping MockServer, to run MockServer indefinitely do not set a value

logLevel

@Parameter(property="mockserver.logLevel",
           defaultValue="INFO")
protected String logLevel

Optionally specify log level as TRACE, DEBUG, INFO, WARN, ERROR or OFF. If not specified default is INFO.

skip

@Parameter(property="mockserver.skip",
           defaultValue="false")
protected boolean skip

Skip the plugin execution completely

pipeLogToConsole

@Parameter(property="mockserver.pipeLogToConsole",
           defaultValue="false")
protected boolean pipeLogToConsole

If true the console of the forked JVM will be piped to the Maven console

initializationClass

@Parameter(property="mockserver.initializationClass")
protected String initializationClass

To enable the creation of default expectations that are generic across all tests or mocking scenarios a class can be specified to initialize expectations in the MockServer, this class must implement org.mockserver.initialize.PluginExpectationInitializer interface, the initializeExpectations(MockServerClient mockServerClient) method will be called once the MockServer has been started (but ONLY if serverPort has been set), however it should be noted that it is generally better practice to create all expectations locally in each test (or test class) for clarity, simplicity and to avoid brittle tests

initializationJson

@Parameter(property="mockserver.initializationJson")
protected String initializationJson

To enable the creation of default expectations that are generic across all tests or mocking scenarios a json filed can be specified to initialize expectations in the MockServer. It should be noted that it is generally better practice to create all expectations locally in each test (or test class) for clarity, simplicity and to avoid brittle tests

compileClasspath

@Parameter(property="project.compileClasspathElements",
           required=true,
           readonly=true)
protected List<String> compileClasspath

The main classpath location of the project using this plugin

testClasspath

@Parameter(property="project.testClasspathElements",
           required=true,
           readonly=true)
protected List<String> testClasspath

The test classpath location of the project using this plugin

dependencies

@Parameter(property="pluginDescriptor.plugin.dependencies",
           required=true,
           readonly=true)
protected List<org.apache.maven.model.Dependency> dependencies

The plugin dependencies

Constructor Detail

MockServerAbstractMojo

public MockServerAbstractMojo()

Method Detail

getLocalMockServerInstance

protected InstanceHolder getLocalMockServerInstance()

createInitializerClass

protected org.mockserver.client.initialize.ExpectationInitializer createInitializerClass()

createInitializerJson

protected String createInitializerJson()

mockServerPort

public static void mockServerPort(Integer... port)