com.sap.cloud.sdk.s4hana.datamodel.odata.helper

Class FluentHelperCustomHttpHeader<CallerT>

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperCustomHttpHeader<CallerT>

Type Parameters:

CallerT - The return type of the terminating methods. Usually this is the type of the FluentHelperBasic implementation that this helper was called on.

public class FluentHelperCustomHttpHeader<CallerT>
extends Object

Helper class to provide a fluent interface to specify custom header for an operation. Sample Usage (from a FluentHelperBasic named service):

 service.withCustomHttpHeader("Some Key", "Some Value").and("Another Key", "Another value").onRequestOnly().execute()
 

Method Summary

Modifier and Type	Method and Description
FluentHelperCustomHttpHeader<CallerT>	and(String headerName, String headerValue) Add an additional custom header pair to be used as a custom header.
CallerT	onRequestAndImplicitRequests() Adds the given header/value pairs to all requests, so for example CSRF token and metadata fetches, as well as the actual request to execute.
CallerT	onRequestOnly() Adds the given header/value pairs only to the actual request to execute.

Methods inherited from class java.lang.Object

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

Method Detail

and

public FluentHelperCustomHttpHeader<CallerT> and(String headerName,
                                                 String headerValue)

Add an additional custom header pair to be used as a custom header. This can be used to give multiple headers to the same terminating method.

Parameters:

headerName - The header name to add.

headerValue - The header value to add.

Returns:

This FluentHelper to provide a fluent API.

onRequestAndImplicitRequests

public CallerT onRequestAndImplicitRequests()

Adds the given header/value pairs to all requests, so for example CSRF token and metadata fetches, as well as the actual request to execute.

Returns:

The original fluent helper that called this fluent helper.

onRequestOnly

public CallerT onRequestOnly()

Adds the given header/value pairs only to the actual request to execute. These headers are not part of the implicit requests like CSRF token and metadata fetches.

Returns:

The original fluent helper that called this fluent helper.