com.sap.cloud.sdk.cloudplatform.connectivity

Interface DestinationHeaderProvider

public interface DestinationHeaderProvider

Allows to provide additional headers for a specific destination.

Method Summary

Modifier and Type	Method and Description
default List<Header>	getHeaders(DestinationProperties destination) Deprecated. Please use getHeaders(DestinationRequestContext) instead. The destination reference can be extracted using DestinationRequestContext.getDestination().
default List<Header>	getHeaders(DestinationRequestContext requestContext) Provides a list of Header objects which should be used with the given destination for a request URI.
static DestinationHeaderProvider	of(Header... staticHeaders) Instantiate a local instance with static headers.

Method Detail

getHeaders

@Nonnull
 @Deprecated
default List<Header> getHeaders(@Nonnull
                                                      DestinationProperties destination)

Deprecated. Please use getHeaders(DestinationRequestContext) instead. The destination reference can be extracted using DestinationRequestContext.getDestination().

Provides a list of Header objects which should be used with the given destination.

Parameters:

destination - The destination to provide additional headers for.

Returns:

The headers to use with the given destination.

getHeaders

@Nonnull
default List<Header> getHeaders(@Nonnull
                                         DestinationRequestContext requestContext)

Provides a list of Header objects which should be used with the given destination for a request URI.

Parameters:

requestContext - The destination and request specific context.

Returns:

The headers to use with the given destination.

of

@Beta
 @Nonnull
static DestinationHeaderProvider of(@Nonnull
                                                    Header... staticHeaders)

Instantiate a local instance with static headers.

Parameters:

staticHeaders - The array of headers to be added.

Returns:

A new instance.