public class UriConfigurer extends AbstractNestedConfigurer<MockMvcRestDocumentationConfigurer> implements org.springframework.test.web.servlet.setup.MockMvcConfigurer
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_HOST
The defalt host for documented URIs.
|
static int |
DEFAULT_PORT
The default port for documented URIs.
|
static java.lang.String |
DEFAULT_SCHEME
The default scheme for documented URIs.
|
Modifier and Type | Method and Description |
---|---|
void |
afterConfigurerAdded(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder) |
void |
apply(java.util.Map<java.lang.String,java.lang.Object> configuration,
RestDocumentationContext context)
Applies the configurer to the given
configuration . |
org.springframework.test.web.servlet.request.RequestPostProcessor |
beforeMockMvcCreated(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder,
org.springframework.web.context.WebApplicationContext context) |
UriConfigurer |
withHost(java.lang.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(java.lang.String scheme)
Configures any documented URIs to use the given
scheme . |
and
public static final java.lang.String DEFAULT_SCHEME
withScheme(String)
,
Constant Field Valuespublic static final java.lang.String DEFAULT_HOST
withHost(String)
,
Constant Field Valuespublic static final int DEFAULT_PORT
withPort(int)
,
Constant Field Valuespublic UriConfigurer withScheme(java.lang.String scheme)
scheme
. The default is
http
.scheme
- the URI schemethis
public UriConfigurer withHost(java.lang.String host)
host
. The default is
localhost
.host
- the URI hostthis
public UriConfigurer withPort(int port)
port
. The default is
8080
.port
- the URI portthis
public void apply(java.util.Map<java.lang.String,java.lang.Object> configuration, RestDocumentationContext context)
AbstractConfigurer
configuration
.apply
in class AbstractConfigurer
configuration
- the configuration to be configuredcontext
- the current documentation contextpublic void afterConfigurerAdded(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder)
afterConfigurerAdded
in interface org.springframework.test.web.servlet.setup.MockMvcConfigurer
public org.springframework.test.web.servlet.request.RequestPostProcessor beforeMockMvcCreated(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder, org.springframework.web.context.WebApplicationContext context)
beforeMockMvcCreated
in interface org.springframework.test.web.servlet.setup.MockMvcConfigurer