com.sap.cloud.sdk.service.prov.api.response

Interface ReadResponseBuilder

All Superinterfaces:

ResponseBuilder

All Known Implementing Classes:

ReadResponseBuilderImpl

public interface ReadResponseBuilder
extends ResponseBuilder

Provides the methods for creating a response, populating its header and content, and enabling audit logging in the case of a successful read operation.

Method Summary

Modifier and Type	Method and Description
ReadResponseBuilder	addHeader(String name, String value) Adds a header with the specified name and value in the ReadResponseBuilder object.
ReadResponseBuilder	addHeaders(Map<String,List<String>> headers) Adds headers in the ReadResponseBuilder object.
ReadResponseBuilder	audit(boolean enable) Deprecated.
ReadResponse	response() Returns an instance of ReadResponse object.
ReadResponseBuilder	setData(EntityData entityData) Sets an EntityData object corresponding to the read entity in the ReadResponseBuilder object.
ReadResponseBuilder	setData(Map<String,Object> data) Sets key-value pairs representing the properties of the read entity in the ReadResponseBuilder object.
ReadResponseBuilder	setData(Object pojo) Sets a POJO object corresponding to the read entity in the ReadResponseBuilder object.
ReadResponseBuilder	setHeader(String name, String value) Sets a header with the specified name and value in the ReadResponseBuilder object.

Method Detail

addHeaders

ReadResponseBuilder addHeaders(Map<String,List<String>> headers)

Adds headers in the ReadResponseBuilder object. If headers are already present in the ReadResponseBuilder object, the specified headers are added to the existing ones. The header name is case-insensitive. Note: The SDK framework might overwrite the values you add to the header in the final response that gets created.

Parameters:

headers - A java.util.Map> containing the headers to be added

Returns:

A ReadResponseBuilder object containing the added headers

setData

ReadResponseBuilder setData(Map<String,Object> data)

Sets key-value pairs representing the properties of the read entity in the ReadResponseBuilder object.

Parameters:

data - A Map object that represents the read entity

Returns:

A ReadResponseBuilder object containing the read entity

setData

ReadResponseBuilder setData(EntityData entityData)

Sets an EntityData object corresponding to the read entity in the ReadResponseBuilder object.

Parameters:

entityData - An EntityData object that represents the read entity

Returns:

A ReadResponseBuilder object containing the read entity

setData

ReadResponseBuilder setData(Object pojo)

Sets a POJO object corresponding to the read entity in the ReadResponseBuilder object.

Parameters:

pojo - A POJO Object that represents the read entity

Returns:

A ReadResponseBuilder object containing the read entity

setHeader

ReadResponseBuilder setHeader(String name,
                              String value)

Sets a header with the specified name and value in the ReadResponseBuilder object. If the header is already present in the ReadResponseBuilder object, the new value overwrites the previous one. The header name is case-insensitive. Note: The SDK framework might overwrite the value you set in the header in the final response that gets created.

Parameters:

name - A String containing the name of the header

value - A String containing the header value

Returns:

A ReadResponseBuilder object containing the newly added or updated header

addHeader

ReadResponseBuilder addHeader(String name,
                              String value)

Adds a header with the specified name and value in the ReadResponseBuilder object. If the header is already present in the ReadResponseBuilder object, the specified value is added to the existing values. The header name is case-insensitive. Note: The SDK framework might overwrite the value you add to the header in the final response that gets created.

Parameters:

name - A String containing the name of the header

value - A String containing the additional header value

Returns:

A ReadResponseBuilder object containing the additional header

audit

@Deprecated
ReadResponseBuilder audit(boolean enable)

Deprecated.

Enables auditing for read operation. Please note that auditing is disabled by default.

Parameters:

enable - A boolean to enable or disable auditing

Returns:

A ReadResponseBuilder object containing the updated auditing attribute

response

ReadResponse response()

Returns an instance of ReadResponse object.

Returns:

A ReadResponse object