Apache HttpClient 4.5.14 · org.apache.http.cookie.Cookie

Method Summary

Modifier and Type	Method and Description
public String	Returns: comment getComment() Returns the comment describing the purpose of this cookie, or `null` if no such comment has been defined.
public String	getCommentURL() If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.
public String	Returns: the value of the domain attribute. getDomain() Returns domain attribute of the cookie.
public Date	Returns: Expiration `Date`, or `null`. getExpiryDate() Returns the expiration `Date` of the cookie, or `null` if none exists.
public String	Returns: String name The name getName() Returns the name.
public String	Returns: The value of the path attribute. getPath() Returns the path attribute of the cookie.
public int[]	getPorts() Get the Port attribute.
public String	Returns: String value The current value. getValue() Returns the value.
public int	Returns: the version of the cookie. getVersion() Returns the version of the cookie specification to which this cookie conforms.
public boolean	Returns: `true` if the cookie has expired. isExpired(final Date Current time date) Returns true if this cookie has expired.
public boolean	Returns: `false` if the cookie should be discarded at the end of the "session"; `true` otherwise isPersistent() Returns `false` if the cookie should be discarded at the end of the "session"; `true` otherwise.
public boolean	Returns: `true` if this cookie should only be sent over secure connections, `false` otherwise. isSecure() Indicates whether this cookie requires a secure connection.

Method Detail

getComment back to summary

getComment	back to summary
public String getComment() Returns the comment describing the purpose of this cookie, or `null` if no such comment has been defined. Returns:String comment Annotations @Obsolete

public String getComment()

Returns the comment describing the purpose of this cookie, or null if no such comment has been defined.

Returns:String

comment

Annotations

@Obsolete

getCommentURL	back to summary
public String getCommentURL() If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL. Annotations @Obsolete

getCommentURL

back to summary

public String getCommentURL()

If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.

Annotations

@Obsolete

getDomain	back to summary
public String getDomain() Returns domain attribute of the cookie. The value of the Domain attribute specifies the domain for which the cookie is valid. Returns:String the value of the domain attribute.

getDomain

back to summary

public String getDomain()

Returns domain attribute of the cookie. The value of the Domain attribute specifies the domain for which the cookie is valid.

Returns:String: the value of the domain attribute.

getExpiryDate back to summary

getExpiryDate	back to summary
public Date getExpiryDate() Returns the expiration `Date` of the cookie, or `null` if none exists. Note the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril. Returns:Date Expiration `Date`, or `null`.

public Date getExpiryDate()

Returns the expiration Date of the cookie, or null if none exists.

Note

the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril.

Returns:Date: Expiration Date, or null.

getName	back to summary
public String getName() Returns the name. Returns:String String name The name

getName

back to summary

public String getName()

Returns the name.

Returns:String: String name The name

getPath	back to summary
public String getPath() Returns the path attribute of the cookie. The value of the Path attribute specifies the subset of URLs on the origin server to which this cookie applies. Returns:String The value of the path attribute.

getPath

back to summary

public String getPath()

Returns the path attribute of the cookie. The value of the Path attribute specifies the subset of URLs on the origin server to which this cookie applies.

Returns:String: The value of the path attribute.

getPorts	back to summary
public int[] getPorts() Get the Port attribute. It restricts the ports to which a cookie may be returned in a Cookie request header. Annotations @Obsolete

getPorts

back to summary

public int[] getPorts()

Get the Port attribute. It restricts the ports to which a cookie may be returned in a Cookie request header.

Annotations

@Obsolete

getValue	back to summary
public String getValue() Returns the value. Returns:String String value The current value.

getValue

back to summary

public String getValue()

Returns the value.

Returns:String: String value The current value.

getVersion	back to summary
public int getVersion() Returns the version of the cookie specification to which this cookie conforms. Returns:int the version of the cookie. Annotations @Obsolete

getVersion

back to summary

public int getVersion()

Returns the version of the cookie specification to which this cookie conforms.

Returns:int

the version of the cookie.

Annotations

@Obsolete

isExpired back to summary

isExpired	back to summary
public boolean isExpired(final Date date) Returns true if this cookie has expired. Parameters date:Date Current time Returns:boolean `true` if the cookie has expired.

public boolean isExpired(final Date date)

Returns true if this cookie has expired.

Parameters

date:Date: Current time

Returns:boolean

true if the cookie has expired.

isPersistent back to summary

isPersistent	back to summary
public boolean isPersistent() Returns `false` if the cookie should be discarded at the end of the "session"; `true` otherwise. Returns:boolean `false` if the cookie should be discarded at the end of the "session"; `true` otherwise

public boolean isPersistent()

Returns false if the cookie should be discarded at the end of the "session"; true otherwise.

Returns:boolean: false if the cookie should be discarded at the end of the "session"; true otherwise

isSecure back to summary

isSecure	back to summary
public boolean isSecure() Indicates whether this cookie requires a secure connection. Returns:boolean `true` if this cookie should only be sent over secure connections, `false` otherwise.

public boolean isSecure()

Indicates whether this cookie requires a secure connection.

Returns:boolean: true if this cookie should only be sent over secure connections, false otherwise.

public Interface Cookie

Method Summary

Method Detail