Spec-Zone .ru спецификации, руководства, описания, API

javax.servlet.http
Cookie класса

java.lang.Object
  javax.servlet.http.Cookie

Все Реализованные Интерфейсы:

java.io. Сериализуемый, java.lang. Cloneable

public class Cookie
расширяет java.lang. Объект
реализации java.lang. Cloneable, java.io. Сериализуемый

Создает cookie, небольшое количество информации, отправленной сервлетом Веб-браузеру, сохраненному браузером, и позже отосланный назад к серверу. Значение cookie может однозначно определить клиент, таким образом, cookie обычно используются для управления сеансами.

У cookie есть имя, единственное значение, и дополнительные атрибуты, такие как комментарий, путь и спецификаторы домена, максимальный возраст, и номер версии. У некоторых Веб-браузеров есть ошибки в том, как они обрабатывают дополнительные атрибуты, так что используйте их экономно, чтобы улучшить функциональную совместимость Ваших сервлетов.

Сервлет отправляет cookie браузеру при использовании HttpServletResponse#addCookie метод, который добавляет поля к заголовкам ответа HTTP, чтобы отправить cookie браузеру по одному. Браузер, как ожидают, будет поддерживать 20 cookie для каждого веб-сервера, 300 общих количеств cookie, и может ограничить размер cookie 4 Кбайтами каждый.

Браузер возвращает cookie сервлету, добавляя поля к заголовкам запроса HTTP. Cookie могут быть получены от запроса при использовании HttpServletRequest#getCookies метод. У нескольких cookie могло бы быть то же самое имя, но различные атрибуты пути.

Cookie влияют на кэширование Веб-страниц, которые используют их. HTTP 1.0 не кэширует страницы, которые используют cookie, создаваемые с этим class. Этот class не поддерживает управление кэшем, определенное с помощью HTTP 1.1.

Этот class поддерживает обоих Версия 0 (Netscape) и Версия 1 (RFC 2109) спецификации cookie. По умолчанию cookie создаются, используя Версию 0, чтобы гарантировать лучшую функциональную совместимость.

Автор:

Различный

См. Также:

Сериализированная Форма

Сводка конструктора

Cookie(java.lang.String name, java.lang.String value)
Создает cookie с указанным именем и значением.

Сводка метода

java.lang.Object	clone() Переопределяет стандарт java.lang.Object.clone метод, чтобы возвратить копию этого Cookie.
java.lang.String	getComment() Возвращает комментарий, описывающий цель этого cookie, или null если у cookie нет никакого комментария.
java.lang.String	getDomain() Получает доменное имя этого Cookie.
int	getMaxAge() Получает максимальный возраст в секундах этого Cookie.
java.lang.String	getName() Возвращает имя cookie.
java.lang.String	getPath() Возвращает путь на сервере, которому браузер возвращает этот cookie.
boolean	getSecure() Возвраты true если браузер отправляет cookie только по безопасному протоколу, или false если браузер может отправить cookie, используя какой-либо протокол.
java.lang.String	getValue() Получает текущую стоимость этого Cookie.
int	getVersion() Возвращает версию протокола, который выполняет этот cookie.
boolean	isHttpOnly() Проверки, был ли этот Cookie отмечен как HttpOnly.
void	setComment(java.lang.String purpose) Определяет комментарий, который описывает цель cookie.
void	setDomain(java.lang.String domain) Определяет домен, в пределах которого должен быть представлен этот cookie.
void	setHttpOnly(boolean isHttpOnly) Марки или снимают выделение с этого Cookie как с HttpOnly.
void	setMaxAge(int expiry) Устанавливает максимальный возраст в секундах для этого Cookie.
void	setPath(java.lang.String uri) Определяет путь для cookie, которому клиент должен возвратить cookie.
void	setSecure(boolean flag) Указывает к браузеру, должен ли cookie только быть отправлен, используя безопасный протокол, такой как HTTPS или SSL.
void	setValue(java.lang.String newValue) Присваивает новое значение этому Cookie.
void	setVersion(int v) Устанавливает версию протокола cookie, который выполняет этот Cookie.

Методы, наследованные от class java.lang. Объект

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Деталь конструктора

Cookie

public Cookie(java.lang.String name,
              java.lang.String value)

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

Имя должно соответствовать RFC 2109. Однако, поставщики могут обеспечить параметр конфигурации, который позволяет именам cookie, соответствующим исходной Спецификации Cookie Netscape быть принятыми.

Название cookie не может быть изменено, как только cookie был создан.

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

По умолчанию cookie создаются согласно спецификации cookie Netscape. Версия может быть изменена с setVersion метод.

Параметры:

name - имя cookie

value - значение cookie

Броски:

IllegalArgumentException - если имя cookie является нулем или пустой или содержит какие-либо запрещенные символы (например, запятая, пространство, или точка с запятой) или соответствует маркер, зарезервированный для использования протоколом cookie

См. Также:

setValue(java.lang.String), setVersion(int)

Деталь метода

setComment

public void setComment(java.lang.String purpose)

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

Параметры:

purpose - a String определение комментария, чтобы вывести на экран пользователю

См. Также:

getComment()

getComment

public java.lang.String getComment()

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

Возвраты:

комментарий cookie, или null если неуказанный

См. Также:

setComment(java.lang.String)

setDomain

public void setDomain(java.lang.String domain)

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

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

Параметры:

domain - доменное имя, в пределах которого этот cookie видим; форма согласно RFC 2109

См. Также:

getDomain()

getDomain

public java.lang.String getDomain()

Получает доменное имя этого Cookie.

Доменные имена форматируются согласно RFC 2109.

Возвраты:

доменное имя этого Cookie

См. Также:

setDomain(java.lang.String)

setMaxAge

public void setMaxAge(int expiry)

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

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

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

Параметры:

expiry - целое число, определяющее максимальный возраст cookie в секундах; если отрицание, означает, что cookie не сохранен; если нуль, удаляет cookie

См. Также:

getMaxAge()

getMaxAge

public int getMaxAge()

Получает максимальный возраст в секундах этого Cookie.

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

Возвраты:

целое число, определяющее максимальный возраст cookie в секундах; если отрицание, означает, что cookie сохраняется до завершения работы браузера

См. Также:

setMaxAge(int)

setPath

public void setPath(java.lang.String uri)

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

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

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

Параметры:

uri - a String определение пути

См. Также:

getPath()

getPath

public java.lang.String getPath()

Возвращает путь на сервере, которому браузер возвращает этот cookie. cookie видим ко всем подпутям на сервере.

Возвраты:

a String определяя путь, который содержит имя сервлета, например, / каталог

См. Также:

setPath(java.lang.String)

setSecure

public void setSecure(boolean flag)

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

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

Параметры:

flag - если true, отправляет cookie от браузера до сервера только при использовании безопасного протокола; если false, отправленный на любом протоколе

См. Также:

getSecure()

getSecure

public boolean getSecure()

Возвраты true если браузер отправляет cookie только по безопасному протоколу, или false если браузер может отправить cookie, используя какой-либо протокол.

Возвраты:

true если браузер использует безопасный протокол, false иначе

См. Также:

setSecure(boolean)

getName

public java.lang.String getName()

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

Возвраты:

имя cookie

setValue

public void setValue(java.lang.String newValue)

Присваивает новое значение этому Cookie.

Если Вы используете двоичное значение, можно хотеть использовать кодирование BASE64.

С cookie Версии 0 значения не должны содержать пробел, скобки, круглые скобки, равняется знакам, запятые, двойные кавычки, наклонные черты, вопросительные знаки, знаки at signs, двоеточия, и точки с запятой. Пустые значения, возможно, не ведут себя тот же самый путь на всех браузерах.

Параметры:

newValue - новое значение cookie

См. Также:

getValue()

getValue

public java.lang.String getValue()

Получает текущую стоимость этого Cookie.

Возвраты:

текущая стоимость этого Cookie

См. Также:

setValue(java.lang.String)

getVersion

public int getVersion()

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

Возвраты:

0, если cookie выполняет исходную спецификацию Netscape; 1, если cookie выполняет RFC 2109

См. Также:

setVersion(int)

setVersion

public void setVersion(int v)

Устанавливает версию протокола cookie, который выполняет этот Cookie.

Версия 0 выполняет исходную спецификацию cookie Netscape. Версия 1 выполняет RFC 2109.

Так как RFC 2109 все еще несколько нов, рассмотрите версию 1 как экспериментальную; еще не используйте это на местах производства.

Параметры:

v - 0, если cookie должен выполнить исходную спецификацию Netscape; 1, если cookie должен выполнить RFC 2109

См. Также:

getVersion()

клон

public java.lang.Object clone()

Переопределяет стандарт java.lang.Object.clone метод, чтобы возвратить копию этого Cookie.

Переопределения:

clone в class java.lang.Object

setHttpOnly

public void setHttpOnly(boolean isHttpOnly)

Марки или снимают выделение с этого Cookie как с HttpOnly.

Если isHttpOnly устанавливается в true, этот cookie отмечается как HttpOnly, добавляя, что HttpOnly приписывает этому.

Cookie HttpOnly, как предполагается, не представляются клиентскому коду сценариев, и могут поэтому помочь смягчить определенные виды атак с использованием кросс-сайтовых сценариев.

Параметры:

isHttpOnly - истина, если этот cookie должен быть отмечен как HttpOnly, ложь иначе

С тех пор:

Сервлет 3.0

isHttpOnly

public boolean isHttpOnly()

Проверки, был ли этот Cookie отмечен как HttpOnly.

Возвраты:

истина, если этот Cookie был отмечен как HttpOnly, ложь иначе

С тех пор:

Сервлет 3.0