Spec-Zone .ru
спецификации, руководства, описания, API
|
|
|||||||||
ПРЕДЫДУЩИЙ СЛЕДУЮЩИЙ КЛАСС КЛАССА | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
java.lang.Object javax.servlet.http.Cookie
public class Cookie
Создает 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 |
Деталь конструктора |
---|
public Cookie(java.lang.String name, java.lang.String value)
Имя должно соответствовать RFC 2109. Однако, поставщики могут обеспечить параметр конфигурации, который позволяет именам cookie, соответствующим исходной Спецификации Cookie Netscape быть принятыми.
Название cookie не может быть изменено, как только cookie был создан.
Значение может быть чем-либо, что сервер хочет отправлять. Его значение имеет, вероятно, интерес только для сервера. Значение cookie может быть изменено после создания с setValue
метод.
По умолчанию cookie создаются согласно спецификации cookie Netscape. Версия может быть изменена с setVersion
метод.
name
- имя cookievalue
- значение cookie IllegalArgumentException
- если имя cookie является нулем или пустой или содержит какие-либо запрещенные символы (например, запятая, пространство, или точка с запятой) или соответствует маркер, зарезервированный для использования протоколом cookiesetValue(java.lang.String)
, setVersion(int)
Деталь метода |
---|
public void setComment(java.lang.String purpose)
purpose
- a String
определение комментария, чтобы вывести на экран пользователюgetComment()
public java.lang.String getComment()
null
если у cookie нет никакого комментария.
null
если неуказанныйsetComment(java.lang.String)
public void setDomain(java.lang.String domain)
Форма доменного имени определяется RFC 2109. Доменное имя начинается с точки (.foo.com
) и средства, что cookie видим к серверам в указанной Системе доменных имен (DNS) зона (например, www.foo.com
, но нет a.b.foo.com
). По умолчанию cookie только возвращаются к серверу, который отправил им.
domain
- доменное имя, в пределах которого этот cookie видим; форма согласно RFC 2109getDomain()
public java.lang.String getDomain()
Доменные имена форматируются согласно RFC 2109.
setDomain(java.lang.String)
public void setMaxAge(int expiry)
Положительное значение указывает, что cookie истечет после этого много секунд передали. Отметьте, что значение является максимальным возрастом, когда cookie истечет, не текущий возраст cookie.
Отрицательная величина означает, что cookie постоянно не сохранен и будет удален, когда Веб-браузер выходит. Нулевое значение заставляет cookie быть удаленным.
expiry
- целое число, определяющее максимальный возраст cookie в секундах; если отрицание, означает, что cookie не сохранен; если нуль, удаляет cookiegetMaxAge()
public int getMaxAge()
По умолчанию, -1
возвращается, который указывает, что cookie сохранится до завершения работы браузера.
setMaxAge(int)
public void setPath(java.lang.String uri)
cookie видим ко всем страницам в каталоге, который Вы определяете, и все страницы в подкаталогах того каталога. Путь cookie должен включать сервлет, которые устанавливают cookie, например, / каталог, который делает cookie видимым ко всем каталогам на сервере в соответствии с / каталогом.
Консультируйтесь с RFC 2109 (доступный в Интернете) для получения дополнительной информации об установке путей для cookie.
uri
- a String
определение путиgetPath()
public java.lang.String getPath()
String
определяя путь, который содержит имя сервлета, например, / каталогsetPath(java.lang.String)
public void setSecure(boolean flag)
Значение по умолчанию false
.
flag
- если true
, отправляет cookie от браузера до сервера только при использовании безопасного протокола; если false
, отправленный на любом протоколеgetSecure()
public boolean getSecure()
true
если браузер отправляет cookie только по безопасному протоколу, или false
если браузер может отправить cookie, используя какой-либо протокол.
true
если браузер использует безопасный протокол, false
иначеsetSecure(boolean)
public java.lang.String getName()
public void setValue(java.lang.String newValue)
Если Вы используете двоичное значение, можно хотеть использовать кодирование BASE64.
С cookie Версии 0 значения не должны содержать пробел, скобки, круглые скобки, равняется знакам, запятые, двойные кавычки, наклонные черты, вопросительные знаки, знаки at signs, двоеточия, и точки с запятой. Пустые значения, возможно, не ведут себя тот же самый путь на всех браузерах.
newValue
- новое значение cookiegetValue()
public java.lang.String getValue()
setValue(java.lang.String)
public int getVersion()
setVersion(int)
public void setVersion(int v)
Версия 0 выполняет исходную спецификацию cookie Netscape. Версия 1 выполняет RFC 2109.
Так как RFC 2109 все еще несколько нов, рассмотрите версию 1 как экспериментальную; еще не используйте это на местах производства.
v
- 0, если cookie должен выполнить исходную спецификацию Netscape; 1, если cookie должен выполнить RFC 2109getVersion()
public java.lang.Object clone()
java.lang.Object.clone
метод, чтобы возвратить копию этого Cookie.
clone
в class java.lang.Object
public void setHttpOnly(boolean isHttpOnly)
Если isHttpOnly устанавливается в true, этот cookie отмечается как HttpOnly, добавляя, что HttpOnly приписывает этому.
Cookie HttpOnly, как предполагается, не представляются клиентскому коду сценариев, и могут поэтому помочь смягчить определенные виды атак с использованием кросс-сайтовых сценариев.
isHttpOnly
- истина, если этот cookie должен быть отмечен как HttpOnly, ложь иначеpublic boolean isHttpOnly()
|
|||||||||
ПРЕДЫДУЩИЙ СЛЕДУЮЩИЙ КЛАСС КЛАССА | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается
Сгенерированный на 10-February-2011 12:41