Package org.springframework.cloud.contract.stubrunner

Interface HttpServerStub

All Known Implementing Classes:

WireMockHttpServerStub

public interface HttpServerStub

Describes an HTTP Server Stub.

Since:

1.1.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method	Description
default int	httpsPort()
boolean	isAccepted(File file)
boolean	isRunning()
int	port()
String	registeredMappings()
HttpServerStub	registerMappings(Collection<File> stubFiles)	Registers the stub files in the HTTP server stub.
default HttpServerStub	reset()	Resets the server.
HttpServerStub	start(HttpServerStubConfiguration configuration)	Starts the server.
HttpServerStub	stop()	Stops the server.

Method Detail

port

int port()

Returns:

port on which the server is running. Return -1 if not applicable.

httpsPort

default int httpsPort()

Returns:

https port on which the server is running. Return -1 if not applicable.

isRunning

boolean isRunning()

Returns:

true if the server is running

start

HttpServerStub start(HttpServerStubConfiguration configuration)

Starts the server. Should return itself to allow chaining.

Parameters:

configuration - - setup for the given stub

Returns:

this

stop

HttpServerStub stop()

Stops the server. Should return itself to allow chaining.

Returns:

this

reset

default HttpServerStub reset()

Resets the server. Should return itself to allow chaining.

Returns:

this

registerMappings

HttpServerStub registerMappings(Collection<File> stubFiles)

Registers the stub files in the HTTP server stub. Should return itself to allow chaining.

Parameters:

stubFiles - collection of files containing stubs

Returns:

this

registeredMappings

String registeredMappings()

Returns:

a collection of registered mappings.

isAccepted

boolean isAccepted(File file)

Parameters:

file - file to check if can be accepted.

Returns:

true if the file is a valid stub mapping