Package com.sap.cloud.sdk.cloudplatform.requestheader

Interface RequestHeaderContainer.Builder

All Known Implementing Classes:

DefaultRequestHeaderContainer.Builder

Enclosing interface:

RequestHeaderContainer

@Beta
public static interface RequestHeaderContainer.Builder

Convenience class for constructing and manipulating RequestHeaderContainers.

Method Summary

Modifier and Type	Method	Description
RequestHeaderContainer	build()	Initializes a new instance of RequestHeaderContainer from the HTTP headers and cookies contained in this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	clear()	Removes all HTTP headers and cookies from this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	replaceHeader(String name, RequestHeaderContainer headerContainer)	Replaces an HTTP header in this RequestHeaderContainer.Builder by copying the HTTP header of the given headerContainer.
RequestHeaderContainer.Builder	replaceHeader(String name, Iterable<String> values)	Replaces an HTTP header in this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	replaceHeader(String name, String firstValue, String... furtherValues)	Replaces an HTTP header in this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	withHeader(String name, RequestHeaderContainer headerContainer)	Copies the HTTP header with the given name - including all it's values - from the headerContainer.
RequestHeaderContainer.Builder	withHeader(String name, Iterable<String> values)	Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	withHeader(String name, String firstValue, String... furtherValues)	Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	withHeaders(RequestHeaderContainer headerContainer)	Copies all existing headers from the given RequestHeaderContainer.
RequestHeaderContainer.Builder	withoutHeader(String name)	Removes an HTTP header from this RequestHeaderContainer.Builder.

Method Details

withHeaders

@Nonnull
RequestHeaderContainer.Builder withHeaders(@Nonnull
 RequestHeaderContainer headerContainer)

Copies all existing headers from the given RequestHeaderContainer.

Parameters:

headerContainer - The RequestHeaderContainer to copy the headers from.

Returns:

This RequestHeaderContainer.Builder instance.

withHeader

@Nonnull
RequestHeaderContainer.Builder withHeader(@Nonnull
 String name,
 @Nonnull
 String firstValue,
 @Nonnull
 String... furtherValues)

Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.

If the header does already exist, all given values will be added to it.

Parameters:

name - The name of the HTTP header. This is treated case insensitively.

firstValue - The first value of the HTTP header.

furtherValues - Further values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

withHeader

@Nonnull
RequestHeaderContainer.Builder withHeader(@Nonnull
 String name,
 @Nonnull
 Iterable<String> values)

Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.

If the header does already exist, all given values will be added to it.

Parameters:

name - The name of the HTTP header. This is treated case insensitively.

values - The values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

withHeader

@Nonnull
RequestHeaderContainer.Builder withHeader(@Nonnull
 String name,
 @Nonnull
 RequestHeaderContainer headerContainer)

Copies the HTTP header with the given name - including all it's values - from the headerContainer.

Parameters:

name - The name of the HTTP header.

headerContainer - The RequestHeaderContainer to copy the HTTP header from.

Returns:

This RequestHeaderContainer.Builder instance.

withoutHeader

@Nonnull
RequestHeaderContainer.Builder withoutHeader(@Nonnull
 String name)

Removes an HTTP header from this RequestHeaderContainer.Builder.

Parameters:

name - The case insensitive name of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

replaceHeader

@Nonnull
RequestHeaderContainer.Builder replaceHeader(@Nonnull
 String name,
 @Nonnull
 String firstValue,
 @Nonnull
 String... furtherValues)

Replaces an HTTP header in this RequestHeaderContainer.Builder.

This method is semantically equivalent to withoutHeader(name).withHeader(name, firstValue, furtherValues).

Parameters:

name - The case insensitive name of the HTTP header.

firstValue - The first new value of the HTTP header.

furtherValues - Further new values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

replaceHeader

@Nonnull
RequestHeaderContainer.Builder replaceHeader(@Nonnull
 String name,
 @Nonnull
 Iterable<String> values)

Replaces an HTTP header in this RequestHeaderContainer.Builder.

This method is semantically equivalent to withoutHeader(name).withHeader(name, values).

Parameters:

name - The case insensitive name of the HTTP header.

values - The new values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

replaceHeader

@Nonnull
RequestHeaderContainer.Builder replaceHeader(@Nonnull
 String name,
 @Nonnull
 RequestHeaderContainer headerContainer)

Replaces an HTTP header in this RequestHeaderContainer.Builder by copying the HTTP header of the given headerContainer.

This method is equivalent to withoutHeader(name).withHeader(name, headerContainer).

Parameters:

name - The case insensitive name of the HTTP header.

headerContainer - The RequestHeaderContainer to copy the HTTP header from.

Returns:

This RequestHeaderContainer.Builder instance.

clear

@Nonnull
RequestHeaderContainer.Builder clear()

Removes all HTTP headers and cookies from this RequestHeaderContainer.Builder.

Returns:

This RequestHeaderContainer.Builder instance.

build

@Nonnull
RequestHeaderContainer build()

Initializes a new instance of RequestHeaderContainer from the HTTP headers and cookies contained in this RequestHeaderContainer.Builder.

Returns:

A new instance of RequestHeaderContainer.