Package org.springframework.restdocs.operation.preprocess

Class UriModifyingOperationPreprocessor

java.lang.Object

org.springframework.restdocs.operation.preprocess.UriModifyingOperationPreprocessor

All Implemented Interfaces:

OperationPreprocessor

public class UriModifyingOperationPreprocessor
extends Object
implements OperationPreprocessor

An OperationPreprocessor that modifies URIs in the request and in the response by changing one or more of their host, scheme, and port. URIs in the following locations are modified:

• Request URI
• Request headers
• Request content
• Request part headers
• Request part content
• Response headers
• Response content

Since:

2.0.1

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor	Description
UriModifyingOperationPreprocessor()

Method Summary

Modifier and Type	Method	Description
UriModifyingOperationPreprocessor	host(String host)	Modifies the URI to use the given host.
UriModifyingOperationPreprocessor	port(int port)	Modifies the URI to use the given port.
OperationRequest	preprocess(OperationRequest request)	Processes the given request.
OperationResponse	preprocess(OperationResponse response)	Processes the given response.
UriModifyingOperationPreprocessor	removePort()	Removes the port from the URI.
UriModifyingOperationPreprocessor	scheme(String scheme)	Modifies the URI to use the given scheme.

Methods inherited from class java.lang.Object

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

Constructor Details

UriModifyingOperationPreprocessor

public UriModifyingOperationPreprocessor()

Method Details

scheme

public UriModifyingOperationPreprocessor scheme(String scheme)

Modifies the URI to use the given scheme. null, the default, will leave the scheme unchanged.

Parameters:

scheme - the scheme

Returns:

this

host

public UriModifyingOperationPreprocessor host(String host)

Modifies the URI to use the given host. null, the default, will leave the host unchanged.

Parameters:

host - the host

Returns:

this

port

public UriModifyingOperationPreprocessor port(int port)

Modifies the URI to use the given port.

Parameters:

port - the port

Returns:

this

removePort

public UriModifyingOperationPreprocessor removePort()

Removes the port from the URI.

Returns:

this

preprocess

public OperationRequest preprocess(OperationRequest request)

Description copied from interface: OperationPreprocessor

Processes the given request.

Specified by:

preprocess in interface OperationPreprocessor

Parameters:

request - the request to process

Returns:

the processed request

preprocess

public OperationResponse preprocess(OperationResponse response)

Description copied from interface: OperationPreprocessor

Processes the given response.

Specified by:

preprocess in interface OperationPreprocessor

Parameters:

response - the response to process

Returns:

the processed response