Top Description Fields Constructors Methods

org.apache.hc.client5.http.impl.cookie

public Class BasicHttpOnlyHandler

Class Inheritance

extends Object
implements CommonCookieAttributeHandler

java.lang.Object
org.apache.hc.client5.http.impl.cookie.BasicHttpOnlyHandler

All Implemented Interfaces

org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler, org.apache.hc.client5.http.cookie.CookieAttributeHandler

Annotations

@Contract
threading:STATELESS

Imports

org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler, .Cookie, .CookieOrigin, .MalformedCookieException, .SetCookie, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.util.Args

Cookie HttpOnly attribute handler.

Since: 5.2

Field Summary

Modifier and Type	Field and Description
public static final BasicHttpOnlyHandler	INSTANCE Singleton instance.

Constructor Summary

Access	Constructor and Description
public	BasicHttpOnlyHandler()

Method Summary

Modifier and Type	Method and Description
public String	getAttributeName() Implements org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler.getAttributeName.
public boolean	match(final Cookie `org.apache.hc.client5.http.cookie.Cookie` to match cookie, final CookieOrigin the cookie source to match against origin) Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.match. Matches the given value (property of the destination host where request is being submitted) with the corresponding cookie attribute.
public void	parse(final SetCookie `org.apache.hc.client5.http.cookie.Cookie` to be updated cookie, final String cookie attribute value from the cookie response header value) Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.parse. Parse the given cookie attribute value and processChallenge the corresponding `org.apache.hc.client5.http.cookie.Cookie` property.
public void	validate(final Cookie `org.apache.hc.client5.http.cookie.Cookie` to validate cookie, final CookieOrigin the cookie source to validate against origin) Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.validate. Performs cookie validation for the given attribute value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INSTANCE

back to summary

public static final BasicHttpOnlyHandler INSTANCE

Singleton instance.

Since: 5.2

Constructor Detail

BasicHttpOnlyHandler	back to summary
public BasicHttpOnlyHandler()

Method Detail

getAttributeName

back to summary

public String getAttributeName()

Implements org.apache.hc.client5.http.cookie.CommonCookieAttributeHandler.getAttributeName.

Annotations

@Override

match back to summary

public boolean match(final Cookie cookie, final CookieOrigin origin)

Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.match.

Doc from org.apache.hc.client5.http.cookie.CookieAttributeHandler.match.

Matches the given value (property of the destination host where request is being submitted) with the corresponding cookie attribute.

Parameters

cookie:Cookie: org.apache.hc.client5.http.cookie.Cookie to match
origin:CookieOrigin: the cookie source to match against

Returns:boolean

true if the match is successful; false otherwise

Annotations

@Override

parse back to summary

public void parse(final SetCookie cookie, final String value) throws MalformedCookieException

Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.parse.

Doc from org.apache.hc.client5.http.cookie.CookieAttributeHandler.parse.

Parse the given cookie attribute value and processChallenge the corresponding org.apache.hc.client5.http.cookie.Cookie property.

Parameters

cookie:SetCookie: org.apache.hc.client5.http.cookie.Cookie to be updated
value:String: cookie attribute value from the cookie response header

Annotations

@Override

Exceptions

MalformedCookieException:: if cookie parsing fails for this attribute

validate back to summary

public void validate(final Cookie cookie, final CookieOrigin origin) throws MalformedCookieException

Implements org.apache.hc.client5.http.cookie.CookieAttributeHandler.validate.

Doc from org.apache.hc.client5.http.cookie.CookieAttributeHandler.validate.

Performs cookie validation for the given attribute value.

Parameters

cookie:Cookie: org.apache.hc.client5.http.cookie.Cookie to validate
origin:CookieOrigin: the cookie source to validate against

Annotations

@Override

Exceptions

MalformedCookieException:: if cookie validation fails for this attribute