de.codecentric.boot.admin.server.web.client.cookies

Interface PerInstanceCookieStore

All Known Implementing Classes:

JdkPerInstanceCookieStore

public interface PerInstanceCookieStore

A cookie store that stores cookies per Instance.

Method Summary

Modifier and Type	Method and Description
void	cleanupInstance(InstanceId instanceId) Informs the store that the cookies of the given instanceId could be removed.
org.springframework.util.MultiValueMap<String,String>	get(InstanceId instanceId, URI requestUri, org.springframework.util.MultiValueMap<String,String> requestHeaders) Gets all the applicable cookies (cookie name => string representation of cookie) for the given instanceId and the specified uri in the request header.
void	put(InstanceId instanceId, URI requestUri, org.springframework.util.MultiValueMap<String,String> responseHeaders) Stores all the applicable cookies (examples are response header fields that are named Set-Cookie) present in the response headers.

Method Detail

get

org.springframework.util.MultiValueMap<String,String> get(InstanceId instanceId,
                                                          URI requestUri,
                                                          org.springframework.util.MultiValueMap<String,String> requestHeaders)

Gets all the applicable cookies (cookie name => string representation of cookie) for the given instanceId and the specified uri in the request header. The URI passed as an argument specifies the intended use for the cookies.

Parameters:

instanceId - identifies the web client instance

requestUri - a URI representing the intended use for the cookies

requestHeaders - a Map from request header field names to lists of field values representing the current request

Returns:

an immutable map from cookie names to text representations of cookies to be included into a request header

put

void put(InstanceId instanceId,
         URI requestUri,
         org.springframework.util.MultiValueMap<String,String> responseHeaders)

Stores all the applicable cookies (examples are response header fields that are named Set-Cookie) present in the response headers.

Parameters:

instanceId - identifies the web client instance

requestUri - an URI where the cookies come from

responseHeaders - a map from field names to lists of field values representing the response header fields

cleanupInstance

void cleanupInstance(InstanceId instanceId)

Informs the store that the cookies of the given instanceId could be removed.

Parameters:

instanceId - identifies the Instance