HC4CookieHandler 5.6.3 API

All Implemented Interfaces:: org.apache.jmeter.protocol.http.control.CookieHandler


public class HC4CookieHandler
 implements CookieHandler

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`DEFAULT_POLICY_NAME`

Constructor Summary

Constructors
Constructor	Description
`HC4CookieHandler()`	Default constructor that uses DEFAULT_POLICY_NAME
`HC4CookieHandler(String policy)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

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()`
`Array<String>`	`getPolicies()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HC4CookieHandler
```
HC4CookieHandler()
```
    Default constructor that uses DEFAULT_POLICY_NAME
  - HC4CookieHandler
```
HC4CookieHandler(String policy)
```
- Method Detail
  - 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
```
 Array<String> getPolicies()
```
    Returns:
    
    Supported cookie policies