Package org.apache.jmeter.protocol.http.control

# Interface CookieHandler

All Known Implementing Classes:
  `HC4CookieHandler`

public interface CookieHandler
Interface to be implemented by CookieHandler

## Method Summary

Modifier and Type
Method
Description
`void`
`addCookieFromHeader(CookieManager cookieManager, boolean checkCookies, String cookieHeader, URL url)`
Add cookie to CookieManager from cookieHeader and URL
`String`
`getCookieHeaderForURL(CollectionProperty cookiesCP, URL url, boolean allowVariableCookie)`
Find cookies applicable to the given URL and build the Cookie header from them.
`String`
`getDefaultPolicy()`
`String[]`
`getPolicies()`

## Method Details

### addCookieFromHeader

void addCookieFromHeader(CookieManager cookieManager, boolean checkCookies, String cookieHeader, URL url)
Add cookie to CookieManager from cookieHeader and URL

Parameters:
  `cookieManager` - CookieManager on which cookies are added
  `checkCookies` - boolean to indicate if cookies must be validated against spec
  `cookieHeader` - String cookie Header
  `url` - URL

### getCookieHeaderForURL

String getCookieHeaderForURL(CollectionProperty cookiesCP, URL url, boolean allowVariableCookie)
Find cookies applicable to the given URL and build the Cookie header from them.

Parameters:
  `cookiesCP` - `CollectionProperty` of `Cookie`
  `url` - URL of the request to which the returned header will be added.
  `allowVariableCookie` - flag whether to allow jmeter variables in cookie values
Returns:
  the value string for the cookie header (goes after "Cookie: ") or null if no cookie matches

### getDefaultPolicy

String getDefaultPolicy()

Returns:
  Cookie default policy name

### getPolicies

String[] getPolicies()

Returns:
  Supported cookie policies