Класс HttpCookie

public HttpCookie(String name, String value)

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

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

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

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

public static List<HttpCookie> parse(String header)

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

public boolean hasExpired()

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

public void setComment(String purpose)

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

public String getComment()

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

public void setCommentURL(String purpose)

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

public String getCommentURL()

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

public void setDiscard(boolean discard)

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

public boolean getDiscard()

Возвращает атрибут discard куки

public void setPortlist(String ports)

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

public String getPortlist()

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

public void setDomain(String pattern)

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

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

public String getDomain()

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

public void setMaxAge(long expiry)

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

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

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

public long getMaxAge()

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

public void setPath(String uri)

Устанавливает путь для куки, на который клиент должен возвращать куки.

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

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

public String getPath()

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

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, если нет

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

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

Хост не находится в домене (RFC 2965, раздел 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: имени, домена и пути. То есть, хэш-код — значение выражения:

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

public Object clone()

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