org.springframework.restdocs.response

Class ResponsePostProcessors

java.lang.Object

org.springframework.restdocs.response.ResponsePostProcessors

public abstract class ResponsePostProcessors
extends Object

Static factory methods for accessing various ResponsePostProcessors.

Author:

Andy Wilkinson, Dewet Diener

Method Summary

Modifier and Type	Method and Description
static ResponsePostProcessor	maskLinks() Returns a ResponsePostProcessor that will update the content of the response to mask any links that it contains.
static ResponsePostProcessor	maskLinksWith(String mask) Returns a ResponsePostProcessor that will update the content of the response to mask any links that it contains.
static ResponsePostProcessor	prettyPrintContent() Returns a ResponsePostProcessor that will pretty print the content of the response.
static ResponsePostProcessor	removeHeaders(String... headerNames) Returns a ResponsePostProcessor that will remove the headers with the given headerNames from the response.
static ResponsePostProcessor	replacePattern(Pattern pattern, String replacement) Returns a ResponsePostProcessor that will update the content of the response by replacing any occurrences of the given pattern with the given replacement.

Methods inherited from class java.lang.Object

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

Method Detail

prettyPrintContent

public static ResponsePostProcessor prettyPrintContent()

Returns a ResponsePostProcessor that will pretty print the content of the response.

Returns:

the response post-processor

removeHeaders

public static ResponsePostProcessor removeHeaders(String... headerNames)

Returns a ResponsePostProcessor that will remove the headers with the given headerNames from the response.

Parameters:

headerNames - the name of the headers to remove

Returns:

the response post-processor

maskLinks

public static ResponsePostProcessor maskLinks()

Returns a ResponsePostProcessor that will update the content of the response to mask any links that it contains. Each link is masked my replacing its href with ....

Returns:

the response post-processor

maskLinksWith

public static ResponsePostProcessor maskLinksWith(String mask)

Returns a ResponsePostProcessor that will update the content of the response to mask any links that it contains. Each link is masked my replacing its href with the given mask.

Parameters:

mask - the mask to apply

Returns:

the response post-processor

replacePattern

public static ResponsePostProcessor replacePattern(Pattern pattern,
                                                   String replacement)

Returns a ResponsePostProcessor that will update the content of the response by replacing any occurrences of the given pattern with the given replacement.

Parameters:

pattern - the pattern to match

replacement - the replacement to apply

Returns:

the response post-processor