com.sap.cloud.server.odata.http

Class HttpHeaders

java.lang.Object

com.sap.cloud.server.odata.http.HttpHeaders

public class HttpHeaders
extends java.lang.Object

Encapsulates a map of HTTP headers, allowing case-insensitive lookup.

Field Summary

Fields

Modifier and Type	Field and Description
static HttpHeaders	empty

Constructor Summary

Constructors

Constructor and Description
HttpHeaders()

Method Summary

Modifier and Type	Method and Description
void	addAll(HttpHeaders other) Add all of the headers from another headers object into this headers object.
void	clear() Clear all the headers.
HttpHeaders	concurrent() Return a thread-safe headers object that delegates to this headers object.
HttpHeaders	copy() Return a copy of these headers.
boolean	delete(java.lang.String name) Delete the value of a header, if present.
static HttpHeaders	emptyIfNull(HttpHeaders headers) Construct an empty HttpHeaders if the headers parameter is null.
StringMap.EntryList	entries() Return the header entries (name/value pairs).
java.lang.String	get(java.lang.String name) Return (nullable) The value of a header, or null if not found.
boolean	has(java.lang.String name) Return true if a specified header exists.
StringList	keys() Return the header names.
void	parse(java.lang.String text, HttpRequest request) For internal use only.
void	set(java.lang.String name, java.lang.String value) Set the value of a header.
int	size() Return the number of headers.
StringMap.EntryList	sortedEntries() Return the header entries (name/value pairs) sorted by name (case insensitive).
java.lang.String	toString() Return headers as a JSON string.
HttpHeaders	with(java.lang.String name, java.lang.String value) Set the value of a header.
HttpHeaders	withClientCredentials(StructureBase credentials) Equivalent to withData("X-Client-Credentials", value).
HttpHeaders	withCreateParameters(StructureBase parameters) Equivalent to withData("X-Create-Parameters", value).
HttpHeaders	withData(java.lang.String header, java.lang.Object value) Convert value to OData 4.0 JSON format, then set a header with the JSON-encoded value as a data URI with media type "application/json" and base64-encoded data.
HttpHeaders	withDeleteParameters(StructureBase parameters) Equivalent to withData("X-Delete-Parameters", parameters).
HttpHeaders	withUpdateParameters(StructureBase parameters) Equivalent to withData("X-Update-Parameters", value).

Methods inherited from class java.lang.Object

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

Field Detail

empty

public static final HttpHeaders empty

Constructor Detail

HttpHeaders

public HttpHeaders()

Method Detail

addAll

public void addAll(HttpHeaders other)

Add all of the headers from another headers object into this headers object.

Parameters:

other - Another headers object.

clear

public void clear()

Clear all the headers.

concurrent

public HttpHeaders concurrent()

Return a thread-safe headers object that delegates to this headers object. An HttpHeaders object is not thread-safe for concurrent read/write access. This function will return a thread-safe wrapper.

Returns:

a thread-safe headers object that delegates to this headers object.

copy

public HttpHeaders copy()

Return a copy of these headers.

Returns:

A copy of these headers.

delete

public boolean delete(java.lang.String name)

Delete the value of a header, if present.

Parameters:

name - Header name.

Returns:

true if a cookie was deleted.

emptyIfNull

public static HttpHeaders emptyIfNull(HttpHeaders headers)

Construct an empty HttpHeaders if the headers parameter is null.

Parameters:

headers - (nullable) HttpHeaders to be checked.

Returns:

The headers parameter, if non-null. Otherwise an empty HttpHeaders.

entries

public StringMap.EntryList entries()

Return the header entries (name/value pairs).

Returns:

The header entries (name/value pairs).

get

public java.lang.String get(java.lang.String name)

Return (nullable) The value of a header, or null if not found.

Parameters:

name - Header name.

Returns:

(nullable) The value of a header, or null if not found.

has

public boolean has(java.lang.String name)

Return true if a specified header exists.

Parameters:

name - Header name.

Returns:

true if a specified header exists.

keys

public StringList keys()

Return the header names.

Returns:

The header names.

parse

public void parse(java.lang.String text,
                  HttpRequest request)

For internal use only.

Parameters:

text - (internal use only)

request - (internal use only)

set

public void set(java.lang.String name,
                java.lang.String value)

Set the value of a header.

Parameters:

name - Header name.

value - Header value.

size

public int size()

Return the number of headers.

Returns:

The number of headers.

sortedEntries

public StringMap.EntryList sortedEntries()

Return the header entries (name/value pairs) sorted by name (case insensitive).

Returns:

The header entries (name/value pairs) sorted by name (case insensitive).

toString

public java.lang.String toString()

Return headers as a JSON string.

Overrides:

toString in class java.lang.Object

Returns:

Headers as a JSON string.

with

public HttpHeaders with(java.lang.String name,
                        java.lang.String value)

Set the value of a header.

Parameters:

name - Header name.

value - Header value.

Returns:

This object.

withClientCredentials

public HttpHeaders withClientCredentials(StructureBase credentials)

Equivalent to withData("X-Client-Credentials", value).

Parameters:

credentials - Client credentials.

Returns:

This object.

withCreateParameters

public HttpHeaders withCreateParameters(StructureBase parameters)

Equivalent to withData("X-Create-Parameters", value).

Parameters:

parameters - Create parameters.

Returns:

This object.

withData

public HttpHeaders withData(java.lang.String header,
                            java.lang.Object value)

Convert value to OData 4.0 JSON format, then set a header with the JSON-encoded value as a data URI with media type "application/json" and base64-encoded data.

Parameters:

header - Header name.

value - (nullable) Header value.

Returns:

This object.

withDeleteParameters

public HttpHeaders withDeleteParameters(StructureBase parameters)

Equivalent to withData("X-Delete-Parameters", parameters).

Parameters:

parameters - Delete parameters.

Returns:

This object.

withUpdateParameters

public HttpHeaders withUpdateParameters(StructureBase parameters)

Equivalent to withData("X-Update-Parameters", value).

Parameters:

parameters - Update parameters.

Returns:

This object.