Класс HttpCookie

public HttpCookie(String name, String value)

Создаёт cookie с заданным именем и значением.

Имя должно соответствовать RFC 2965. Это означает, что оно может содержать только символы ASCII алфавитно-цифрового набора и не может содержать запятые, точки с запятой или пробелы, а также не может начинаться с символа $. Имя cookie нельзя изменить после создания.

Значение может быть любым, которое сервер выбирает для отправки. Его значение, вероятно, интересует только сервер. Значение cookie можно изменить после создания с помощью метода setValue.

По умолчанию cookie создаются в соответствии со спецификацией RFC 2965 для cookie. Версию можно изменить с помощью метода setVersion.

public static List<HttpCookie> parse(String header)

Создаёт cookie из строки заголовка set-cookie или set-cookie2. Синтаксис RFC 2965, раздел 3.2.2, set-cookie2, указывает, что одна строка заголовка может содержать более одного определения cookie, поэтому это статический вспомогательный метод, а не другой конструктор.

public boolean hasExpired()

Указывает, истек срок действия данного HTTP cookie или нет.

public void setComment(String purpose)

Устанавливает комментарий, описывающий назначение cookie. Комментарий полезен, если браузер отображает cookie пользователю. Комментарии не поддерживаются cookie версии 0 Netscape.

public String getComment()

Возвращает комментарий, описывающий назначение этого cookie, или null, если cookie не имеет комментария.

public void setCommentURL(String purpose)

Устанавливает URL комментария, описывающего назначение cookie. URL комментария полезен, если браузер отображает cookie пользователю. URL комментария поддерживается только в RFC 2965.

public String getCommentURL()

Возвращает URL комментария, описывающий назначение этого cookie, или null, если у cookie нет URL комментария.

public void setDiscard(boolean discard)

Указывает, должен ли пользовательский агент безоговорочно удалить cookie. Это атрибут только RFC 2965.

public boolean getDiscard()

Возвращает атрибут удаления cookie

public void setPortlist(String ports)

Устанавливает список портов cookie, который ограничивает порт(ы), на которые cookie может быть отправлен обратно в заголовке Cookie.

public String getPortlist()

Возвращает атрибут списка портов cookie

public void setDomain(String pattern)

Устанавливает домен, в пределах которого этот cookie должен быть представлен.

Формат имени домена задаётся RFC 2965. Имя домена начинается с точки (.foo.com) и означает, что cookie доступен для серверов в заданной зоне DNS (например, www.foo.com, но не a.b.foo.com). По умолчанию cookie возвращаются только серверу, который их отправил.

public String getDomain()

Возвращает имя домена, установленное для этого cookie. Формат имени домена задаётся RFC 2965.

public void setMaxAge(long expiry)

Устанавливает максимальный срок действия cookie в секундах.

Положительное значение указывает, что cookie истечёт через заданное количество секунд. Обратите внимание, что значение является максимальным сроком действия, когда cookie истечёт, а не текущим возрастом cookie.

Отрицательное значение означает, что cookie не хранится постоянно и будет удалён при выходе браузера. Ноль приводит к удалению cookie.

public long getMaxAge()

Возвращает максимальный срок действия cookie в секундах. По умолчанию -1, что cookie сохраняется до закрытия браузера.

public void setPath(String uri)

Устанавливает путь для cookie, к которому клиент должен вернуть cookie.

Cookie доступен для всех страниц в указанном каталоге и для всех страниц в подкаталогах этого каталога. Путь cookie должен содержать сервлет, который установил cookie, например, /catalog, что делает cookie доступным для всех каталогов на сервере под /catalog.

Обратитесь к RFC 2965 (доступен в Интернете) для получения дополнительной информации о настройке имён путей для cookie.

public String getPath()

Возвращает путь на сервере, на который браузер возвращает этот cookie. Cookie доступен для всех подпутей на сервере.

public void setSecure(boolean flag)

Указывает, должен ли cookie отправляться только с помощью защищённого протокола, такого как HTTPS или SSL.

Значение по умолчанию — false.

public boolean getSecure()

Возвращает true, если отправка этого cookie должна быть ограничена защищённым протоколом, или false, если он может быть отправлен по любому протоколу.

public String getName()

Возвращает имя cookie. Имя не может быть изменено после создания.

public void setValue(String newValue)

Присваивает новое значение cookie после его создания. Если вы используете двоичное значение, возможно, вам понадобится использовать кодирование BASE64.

Для cookie версии 0 значения не должны содержать пробелов, скобок, знаков равенства, запятых, двойных кавычек, слешей, вопросительных знаков, символов @, двоеточий и точек с запятой. Пустые значения могут вести себя по-разному в разных браузерах.

public String getValue()

Возвращает значение cookie.

public int getVersion()

Возвращает версию протокола, с которым соответствует этот cookie. Версия 1 соответствует RFC 2965/2109, а версия 0 соответствует оригинальной спецификации cookie, разработанной Netscape. Cookie, предоставленные браузером, используют и идентифицируют версию cookie браузера.

public void setVersion(int v)

Устанавливает версию протокола cookie, которому соответствует этот cookie. Версия 0 соответствует оригинальной спецификации cookie Netscape. Версия 1 соответствует RFC 2965/2109.

public boolean isHttpOnly()

Возвращает true, если этот cookie содержит атрибут HttpOnly. Это означает, что к cookie не должен иметь доступ скриптовый движок, например, javascript.

public void setHttpOnly(boolean httpOnly)

Указывает, следует ли рассматривать cookie как HTTP Only. Если установлено true, это означает, что к cookie не должен иметь доступ скриптовый движок, например, javascript.

public static boolean domainMatches(String domain, String host)

Утилитарный метод для проверки того, находится ли имя хоста в домене.

Эта концепция описана в спецификации cookie. Для понимания концепции необходимо определить некоторые термины:

эффективное имя хоста = имя хоста, если имя хоста содержит точку
или = имя_хоста.local, если нет

Имя хоста А совпадает с доменным именем хоста Б, если:

• их имена хоста совпадают при сравнении строк; или
• А — строка HDN и имеет вид NB, где N — непустая строка имени, Б имеет вид .B', а B' — строка HDN. (Например, x.y.com совпадает с .Y.com, но не с Y.com.)

Хост не находится в домене (RFC 2965 sec. 3.3.2), если:

• Значение атрибута Domain не содержит вложенных точек и не равно .local.
• Эффективное имя хоста, полученное из имени хоста запроса, не совпадает с атрибутом Domain.
• Имя хоста запроса — HDN (не IP-адрес) и имеет вид HD, где D — значение атрибута Domain, а H — строка, содержащая одну или несколько точек.

Примеры:

• Set-Cookie2 с request-host y.x.foo.com и Domain=.foo.com будет отклонен, так как H — y.x и содержит точку.
• Set-Cookie2 с request-host x.foo.com и Domain=.foo.com будет принят.
• Set-Cookie2 с Domain=.com или Domain=.com., всегда будет отклонен, так как нет вложенной точки.
• Set-Cookie2 с request-host example и Domain=.local будет принят, так как эффективное имя хоста для request-host — example.local, и example.local совпадает с .local.

public String toString()

Создаёт строковое представление cookie-заголовка этого cookie, которое соответствует определённому в соответствующей спецификации cookie формату, но без ведущего токена "Cookie:".

public boolean equals(Object obj)

Проверяет равенство двух HTTP cookie.

Результатом является true только если два cookie происходят из одного домена (без учёта регистра), имеют одинаковое имя (без учёта регистра) и одинаковый путь (с учётом регистра).

public int hashCode()

Возвращает хэш-код этого HTTP cookie. Результатом является сумма хэш-кодов трёх значимых компонентов этого cookie: имени, домена и пути. То есть, хэш-код — это значение выражения:

getName().toLowerCase().hashCode()
+ getDomain().toLowerCase().hashCode()
+ getPath().hashCode()

public Object clone()

Создаёт и возвращает копию этого объекта.