org.springframework.restdocs.operation

Interface OperationResponse

public interface OperationResponse

The response that was received as part of performing an operation on a RESTful service.

Author:

Andy Wilkinson

See Also:

Operation, Operation.getRequest()

Method Summary

Modifier and Type	Method and Description
byte[]	getContent() Returns the content of the response.
String	getContentAsString() Returns the content of the response as a String.
org.springframework.http.HttpHeaders	getHeaders() Returns the headers in the response.
org.springframework.http.HttpStatus	getStatus() Returns the status of the response.

Method Detail

getStatus

org.springframework.http.HttpStatus getStatus()

Returns the status of the response.

Returns:

the status

getHeaders

org.springframework.http.HttpHeaders getHeaders()

Returns the headers in the response.

Returns:

the headers

getContent

byte[] getContent()

Returns the content of the response. If the response has no content an empty array is returned.

Returns:

the contents, never null

getContentAsString

String getContentAsString()

Returns the content of the response as a String. If the response has no content an empty string is returned. If the response has a Content-Type header that specifies a charset then that charset will be used when converting the contents to a String.

Returns:

the contents as string, never null