org.springframework.restdocs.mockmvc

Class UriConfigurer

java.lang.Object

org.springframework.restdocs.mockmvc.UriConfigurer

All Implemented Interfaces:

MockMvcConfigurer

public class UriConfigurer
extends Object

A configurer that can be used to configure the documented URIs

Author:

Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST The defalt host for documented URIs
static int	DEFAULT_PORT The default port for documented URIs
static String	DEFAULT_SCHEME The default scheme for documented URIs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UriConfigurer(RestDocumentationMockMvcConfigurer parent)

Method Summary

Modifier and Type	Method and Description
void	afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)
PARENT	and() Returns the configurer's parent
RequestPostProcessor	beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context)
UriConfigurer	withHost(String host) Configures any documented URIs to use the given host.
UriConfigurer	withPort(int port) Configures any documented URIs to use the given port.
UriConfigurer	withScheme(String scheme) Configures any documented URIs to use the given scheme.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

The default scheme for documented URIs

See Also:

withScheme(String), Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

The defalt host for documented URIs

See Also:

withHost(String), Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port for documented URIs

See Also:

withPort(int), Constant Field Values

Constructor Detail

UriConfigurer

protected UriConfigurer(RestDocumentationMockMvcConfigurer parent)

Method Detail

withScheme

public UriConfigurer withScheme(String scheme)

Configures any documented URIs to use the given scheme. The default is http.

Parameters:

scheme - The URI scheme

Returns:

this

withHost

public UriConfigurer withHost(String host)

Configures any documented URIs to use the given host. The default is localhost.

Parameters:

host - The URI host

Returns:

this

withPort

public UriConfigurer withPort(int port)

Configures any documented URIs to use the given port. The default is 8080.

Parameters:

port - The URI port

Returns:

this

and

public PARENT and()

Returns the configurer's parent

Returns:

the parent

afterConfigurerAdded

public void afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)

Specified by:

afterConfigurerAdded in interface MockMvcConfigurer

beforeMockMvcCreated

public RequestPostProcessor beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder,
                                                 WebApplicationContext context)

Specified by:

beforeMockMvcCreated in interface MockMvcConfigurer