Package org.springframework.restdocs.operation.preprocess

Class HeadersModifyingOperationPreprocessor

java.lang.Object

org.springframework.restdocs.operation.preprocess.HeadersModifyingOperationPreprocessor

All Implemented Interfaces:

OperationPreprocessor

public class HeadersModifyingOperationPreprocessor
extends Object
implements OperationPreprocessor

An OperationPreprocessor that modifies a request or response by adding, setting, or removing headers.

Since:

3.0.0

Author:

Jihoon Cha, Andy Wilkinson

Constructor Summary

Constructors

Constructor	Description
HeadersModifyingOperationPreprocessor()

Method Summary

Modifier and Type	Method	Description
HeadersModifyingOperationPreprocessor	add(String name, String value)	Adds a header with the given name and value.
OperationRequest	preprocess(OperationRequest request)	Processes the given request.
OperationResponse	preprocess(OperationResponse response)	Processes the given response.
HeadersModifyingOperationPreprocessor	remove(String name)	Removes the header with the given name.
HeadersModifyingOperationPreprocessor	remove(String name, String value)	Removes the given value from the header with the given name.
HeadersModifyingOperationPreprocessor	removeMatching(String namePattern)	Remove headers that match the given namePattern regular expression.
HeadersModifyingOperationPreprocessor	set(String name, String... values)	Sets the header with the given name to have the given values.

Methods inherited from class java.lang.Object

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

Constructor Details

HeadersModifyingOperationPreprocessor

public HeadersModifyingOperationPreprocessor()

Method Details

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

add

public HeadersModifyingOperationPreprocessor add(String name,
 String value)

Adds a header with the given name and value.

Parameters:

name - the name

value - the value

Returns:

this

set

public HeadersModifyingOperationPreprocessor set(String name,
 String... values)

Sets the header with the given name to have the given values.

Parameters:

name - the name

values - the values

Returns:

this

remove

public HeadersModifyingOperationPreprocessor remove(String name)

Removes the header with the given name.

Parameters:

name - the name of the parameter

Returns:

this

remove

public HeadersModifyingOperationPreprocessor remove(String name,
 String value)

Removes the given value from the header with the given name.

Parameters:

name - the name

value - the value

Returns:

this

removeMatching

public HeadersModifyingOperationPreprocessor removeMatching(String namePattern)

Remove headers that match the given namePattern regular expression.

Parameters:

namePattern - the name pattern

Returns:

this

See Also:

• Matcher.matches()