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

Interface CreateResponseBuilder

All Superinterfaces:

ResponseBuilder

All Known Implementing Classes:

CreateResponseBuilderImpl

public interface CreateResponseBuilder
extends ResponseBuilder

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

Method Summary

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

Method Detail

addHeaders

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

Adds headers in the CreateResponseBuilder object. If headers are already present in the CreateResponseBuilder 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 CreateResponseBuilder object containing the added headers

setData

CreateResponseBuilder setData(Map<String,Object> data)

Sets key-value pairs representing the properties of the created entity in the CreateResponseBuilder object.

Parameters:

data - A Map object that represents the created entity

Returns:

A CreateResponseBuilder object containing the created entity

setData

CreateResponseBuilder setData(EntityData entityData)

Sets an EntityData object corresponding to the created entity in the CreateResponseBuilder object.

Parameters:

entityData - An EntityData object that represents the created entity

Returns:

A CreateResponseBuilder object containing the created entity

setData

CreateResponseBuilder setData(Object pojo)

Sets a POJO object corresponding to the created entity in the CreateResponseBuilder object.

Parameters:

pojo - A POJO Object that represents the created entity

Returns:

A CreateResponseBuilder object containing the created entity

setHeader

CreateResponseBuilder setHeader(String name,
                                String value)

Sets a header with the specified name and value in the CreateResponseBuilder object. If the header is already present in the CreateResponseBuilder 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 CreateResponseBuilder object containing the newly added or updated header

addHeader

CreateResponseBuilder addHeader(String name,
                                String value)

Adds a header with the specified name and value in the CreateResponseBuilder object. If the header is already present in the CreateResponseBuilder 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 CreateResponseBuilder object containing the additional header

audit

@Deprecated
CreateResponseBuilder audit(boolean enable)

Deprecated.

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

Parameters:

enable - A boolean to enable or disable auditing

Returns:

A CreateResponseBuilder object containing the updated auditing attribute

response

CreateResponse response()

Returns an instance of CreateResponse object.

Returns:

A CreateResponse object