com.sap.cloud.server.odata.http

Class HttpCookies

java.lang.Object

com.sap.cloud.server.odata.http.HttpCookies

public class HttpCookies
extends java.lang.Object

Encapsulates a map of HTTP cookies.

Field Summary

Fields

Modifier and Type	Field and Description
static HttpCookies	empty

Constructor Summary

Constructors

Constructor and Description
HttpCookies()

Method Summary

Modifier and Type	Method and Description
void	addAll(HttpCookies other) Add all of the cookies from another cookies object into this cookies object.
void	clear() Clear all the cookies.
HttpCookies	concurrent() Return a thread-safe cookies object that delegates to this cookies object.
HttpCookies	copy() Return a copy of these cookies.
boolean	delete(java.lang.String name) Delete the value of a cookie, if present.
StringMap.EntryList	entries() Return the cookie entries (name/value pairs).
java.lang.String	get(java.lang.String name) Return (nullable) The value of a cookie, or null if not found.
boolean	has(java.lang.String name) Return true if a specified cookie exists.
StringList	keys() Return the cookie names.
void	set(java.lang.String name, java.lang.String value) Set the value of a cookie.
int	size() Return the number of cookies.
StringMap.EntryList	sortedEntries() Return the cookie entries (name/value pairs) sorted by name (case insensitive).
java.lang.String	toString() Return cookies as a JSON string.

Methods inherited from class java.lang.Object

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

Field Detail

empty

public static final HttpCookies empty

Constructor Detail

HttpCookies

public HttpCookies()

Method Detail

addAll

public void addAll(HttpCookies other)

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

Parameters:

other - Another cookies object.

clear

public void clear()

Clear all the cookies.

concurrent

public HttpCookies concurrent()

Return a thread-safe cookies object that delegates to this cookies object. A regular HttpCookies object is not thread-safe for concurrent read/write access. This function will return a thread-safe wrapper.

Returns:

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

copy

public HttpCookies copy()

Return a copy of these cookies.

Returns:

A copy of these cookies.

delete

public boolean delete(java.lang.String name)

Delete the value of a cookie, if present.

Parameters:

name - Cookie name.

Returns:

true if a cookie was deleted.

entries

public StringMap.EntryList entries()

Return the cookie entries (name/value pairs).

Returns:

The cookie entries (name/value pairs).

get

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

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

Parameters:

name - Cookie name.

Returns:

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

has

public boolean has(java.lang.String name)

Return true if a specified cookie exists.

Parameters:

name - Cookie name.

Returns:

true if a specified cookie exists.

keys

public StringList keys()

Return the cookie names.

Returns:

The cookie names.

set

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

Set the value of a cookie.

Parameters:

name - Cookie name.

value - Cookie value.

size

public int size()

Return the number of cookies.

Returns:

The number of cookies.

sortedEntries

public StringMap.EntryList sortedEntries()

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

Returns:

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

toString

public java.lang.String toString()

Return cookies as a JSON string.

Overrides:

toString in class java.lang.Object

Returns:

Cookies as a JSON string.