HttpCookie (Платформа Java SE 7)

java.lang. Объект
- java.net. HttpCookie

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

Cloneable
```
public final class HttpCookie
extends Object
implements Cloneable
```
Объект HttpCookie представляет http cookie, который переносит информацию о состоянии между сервером и агентом пользователя. Cookie широко принимается, чтобы создать stateful сеансы.
Есть 3 http спецификации cookie:
Проект Netscape
RFC 2109 - http://www.ietf.org/rfc/rfc2109.txt
RFC 2965 - http://www.ietf.org/rfc/rfc2965.txt

Класс HttpCookie может принять все эти 3 формы синтаксиса.

С тех пор:

1.6

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

Конструкторы
Конструктор и Описание

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

Конструкторы
Конструктор и Описание
`HttpCookie(String name, String value)` Создает cookie с указанным именем и значением.

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

Методы
Модификатор и Тип	Метод и Описание
`Объект`	`clone()` Создайте и возвратите копию этого объекта.
`static boolean`	`domainMatches(String domain, String host)` Служебный метод, чтобы проверить, является ли имя хоста в домене или нет.
`boolean`	`equals(Object obj)` Протестируйте равенство двух http cookie.
`Строка`	`getComment()` Возвращает комментарий, описывающий цель этого cookie, или `null` если у cookie нет никакого комментария.
`Строка`	`getCommentURL()` Возвращает url комментария, описывающий цель этого cookie, или `null` если у cookie нет никакого url комментария.
`boolean`	`getDiscard()` Возвратите атрибут отбрасывания cookie
`Строка`	`getDomain()` Возвращает набор доменного имени для этого cookie.
`long`	`getMaxAge()` Возвращает максимальный возраст cookie, определенного в секундах.
`Строка`	`getName()` Возвращает имя cookie.
`Строка`	`getPath()` Возвращает путь на сервере, которому браузер возвращает этот cookie.
`Строка`	`getPortlist()` Возвратите атрибут списка порта cookie
`boolean`	`getSecure()` Возвраты `true` если отправка этого cookie должна быть ограничена безопасному протоколу, или `false` если это может быть отправлено, используя какой-либо протокол.
`Строка`	`getValue()` Возвращает значение cookie.
`int`	`getVersion()` Возвращает версию протокола, который выполняет этот cookie.
`boolean`	`hasExpired()` Отчеты, истек ли этот http cookie или нет.
`int`	`hashCode()` Возвратите хэш-код этого http cookie.
`boolean`	`isHttpOnly()` Возвраты `true` если этот cookie содержит атрибут HttpOnly.
`static List<HttpCookie>`	`parse(String header)` Cookie конструкций от cookie набора или строки заголовка набора-cookie2.
`void`	`setComment(String purpose)` Определяет комментарий, который описывает цель cookie.
`void`	`setCommentURL(String purpose)` Определяет url комментария, который описывает цель cookie.
`void`	`setDiscard(boolean discard)` Определите, должен ли агент пользователя отбросить cookie безоговорочно.
`void`	`setDomain(String pattern)` Определяет домен, в пределах которого должен быть представлен этот cookie.
`void`	`setHttpOnly(boolean httpOnly)` Указывает, нужно ли cookie считать HTTP Только.
`void`	`setMaxAge(long expiry)` Устанавливает максимальный возраст cookie в секундах.
`void`	`setPath(String uri)` Определяет путь для cookie, которому клиент должен возвратить cookie.
`void`	`setPortlist(String ports)` Определите portlist cookie, который ограничивает порт (ы), к которому cookie можно отослать назад в заголовке Cookie.
`void`	`setSecure(boolean flag)` Указывает, должен ли cookie только быть отправлен, используя безопасный протокол, такой как HTTPS или SSL.
`void`	`setValue(String newValue)` Присваивает новое значение cookie после того, как cookie создается.
`void`	`setVersion(int v)` Устанавливает версию протокола cookie, который выполняет этот cookie.
`Строка`	`toString()` Создает строковое представление заголовка cookie этого cookie, который находится в формате, определенном соответствующей спецификацией cookie, но без ведущего "Cookie:" маркер.

Методы java.lang унаследованный от класса. Объект
finalize, getClass, notify, notifyAll, wait, wait, wait

- Деталь конструктора
  - HttpCookie
```
public HttpCookie(String name,
          String value)
```
    Создает cookie с указанным именем и значением.
    Имя должно соответствовать RFC 2965. Это означает, что может содержать только алфавитно-цифровые символы ASCII и не может содержать запятые, точки с запятой, или пробел или начаться с символа $. Название cookie не может быть изменено после создания.
    Значение может быть чем-либо, что сервер хочет отправлять. Его значение имеет, вероятно, интерес только для сервера. Значение cookie может быть изменено после создания с setValue метод.
    По умолчанию cookie создаются согласно спецификации cookie RFC 2965. Версия может быть изменена с setVersion метод.
    
    Параметры:
    name - a String определение имени cookie
    value - a String определение значения cookie
    
    Броски:
    
    IllegalArgumentException - если имя cookie содержит запрещенные символы, или это - один из маркеров, зарезервированных для использования протоколом cookie
    
    NullPointerException - если name является null
    См. Также:
    setValue(java.lang.String), setVersion(int)
- Деталь метода
  - синтаксический анализ
```
public static List<HttpCookie> parse(String header)
```
    Cookie конструкций от cookie набора или строки заголовка набора-cookie2. Раздел RFC 2965 3.2.2 синтаксиса набора-cookie2 указывают, что одна строка заголовка может содержать больше чем одно определение cookie, таким образом, это - статический служебный метод вместо другого конструктора.
    
    Параметры:
    header - String, определяющий заголовок cookie набора. Заголовок должен запуститься с "cookie набора", или маркера "набора-cookie2"; или у этого не должно быть никакого ведущего маркера вообще.
    
    Возвраты:
    Список cookie проанализирован от строки строки заголовка
    
    Броски:
    
    IllegalArgumentException - если строка заголовка нарушает синтаксис спецификации cookie, или имя cookie содержит llegal символы, или имя cookie является одним из маркеров, зарезервированных для использования протоколом cookie
    
    NullPointerException - если строкой заголовка является null
  - hasExpired
```
public boolean hasExpired()
```
    Отчеты, истек ли этот http cookie или нет.
    
    Возвраты:
    true, чтобы указать на этот http cookie истек; иначе, false
  - setComment
```
public void setComment(String purpose)
```
    Определяет комментарий, который описывает цель cookie. Комментарий полезен, если браузер представляет cookie пользователю. Комментарии не поддерживаются cookie Версии 0 Netscape.
    
    Параметры:
    purpose - a String определение комментария, чтобы вывести на экран пользователю
    См. Также:
    getComment()
  - getComment
```
public String getComment()
```
    Возвращает комментарий, описывающий цель этого cookie, или null если у cookie нет никакого комментария.
    
    Возвраты:
    a String содержа комментарий, или null если ни один
    См. Также:
    setComment(java.lang.String)
  - setCommentURL
```
public void setCommentURL(String purpose)
```
    Определяет url комментария, который описывает цель cookie. url комментария полезен, если браузер представляет cookie пользователю. url комментария является RFC 2965 только.
    
    Параметры:
    purpose - a String определение url комментария, чтобы вывести на экран пользователю
    См. Также:
    getCommentURL()
  - getCommentURL
```
public String getCommentURL()
```
    Возвращает url комментария, описывающий цель этого cookie, или null если у cookie нет никакого url комментария.
    
    Возвраты:
    a String содержа url комментария, или null если ни один
    См. Также:
    setCommentURL(java.lang.String)
  - setDiscard
```
public void setDiscard(boolean discard)
```
    Определите, должен ли агент пользователя отбросить cookie безоговорочно. Это - RFC 2965, только приписывают.
    
    Параметры:
    discard - true указывает, чтобы отбросить cookie безоговорочно
    См. Также:
    getDiscard()
  - getDiscard
```
public boolean getDiscard()
```
    Возвратите атрибут отбрасывания cookie
    
    Возвраты:
    boolean, чтобы представить атрибут отбрасывания этого cookie
    См. Также:
    setDiscard(boolean)
  - setPortlist
```
public void setPortlist(String ports)
```
    Определите portlist cookie, который ограничивает порт (ы), к которому cookie можно отослать назад в заголовке Cookie.
    
    Параметры:
    ports - String определяет список порта, который является запятой seperated серия цифр
    См. Также:
    getPortlist()
  - getPortlist
```
public String getPortlist()
```
    Возвратите атрибут списка порта cookie
    
    Возвраты:
    String содержит список порта или null если ни один
    См. Также:
    setPortlist(java.lang.String)
  - setDomain
```
public void setDomain(String pattern)
```
    Определяет домен, в пределах которого должен быть представлен этот cookie.
    Форма доменного имени определяется RFC 2965. Доменное имя начинается с точки (.foo.com) и средства, что cookie видим к серверам в указанной Системе доменных имен (DNS) зона (например, www.foo.com, но нет a.b.foo.com). По умолчанию cookie только возвращаются к серверу, который отправил им.
    
    Параметры:
    pattern - a String содержа доменное имя, в пределах которого этот cookie видим; форма согласно RFC 2965
    См. Также:
    getDomain()
  - getDomain
```
public String getDomain()
```
    Возвращает набор доменного имени для этого cookie. Форма доменного имени устанавливается RFC 2965.
    
    Возвраты:
    a String содержа доменное имя
    См. Также:
    setDomain(java.lang.String)
  - setMaxAge
```
public void setMaxAge(long expiry)
```
    Устанавливает максимальный возраст cookie в секундах.
    Положительное значение указывает, что cookie истечет после этого много секунд передали. Отметьте, что значение является максимальным возрастом, когда cookie истечет, не текущий возраст cookie.
    Отрицательная величина означает, что cookie постоянно не сохранен и будет удален, когда Веб-браузер выходит. Нулевое значение заставляет cookie быть удаленным.
    
    Параметры:
    expiry - целое число, определяющее максимальный возраст cookie в секундах; если нуль, cookie должен быть сразу отброшен; иначе, максимальный возраст cookie является неуказанным.
    См. Также:
    getMaxAge()
  - getMaxAge
```
public long getMaxAge()
```
    Возвращает максимальный возраст cookie, определенного в секундах. По умолчанию, -1 указание на cookie сохранится до завершения работы браузера.
    
    Возвраты:
    целое число, определяющее максимальный возраст cookie в секундах
    См. Также:
    setMaxAge(long)
  - setPath
```
public void setPath(String uri)
```
    Определяет путь для cookie, которому клиент должен возвратить cookie.
    cookie видим ко всем страницам в каталоге, который Вы определяете, и все страницы в подкаталогах того каталога. Путь cookie должен включать сервлет, которые устанавливают cookie, например, / каталог, который делает cookie видимым ко всем каталогам на сервере в соответствии с / каталогом.
    Консультируйтесь с RFC 2965 (доступный в Интернете) для получения дополнительной информации об установке путей для cookie.
    
    Параметры:
    uri - a String определение пути
    См. Также:
    getPath()
  - getPath
```
public String getPath()
```
    Возвращает путь на сервере, которому браузер возвращает этот cookie. cookie видим ко всем подпутям на сервере.
    
    Возвраты:
    a String определяя путь, который содержит имя сервлета, например, / каталог
    См. Также:
    setPath(java.lang.String)
  - setSecure
```
public void setSecure(boolean flag)
```
    Указывает, должен ли cookie только быть отправлен, используя безопасный протокол, такой как HTTPS или SSL.
    Значение по умолчанию false.
    
    Параметры:
    flag - Если true, cookie может только быть отправлен по безопасному протоколу как https. Если false, это может быть отправлено по любому протоколу.
    См. Также:
    getSecure()
  - getSecure
```
public boolean getSecure()
```
    Возвраты true если отправка этого cookie должна быть ограничена безопасному протоколу, или false если это может быть отправлено, используя какой-либо протокол.
    
    Возвраты:
    false если cookie может быть отправлен по какому-либо стандартному протоколу; иначе, true
    См. Также:
    setSecure(boolean)
  - getName
```
public String getName()
```
    Возвращает имя cookie. Название не может быть изменено после создания.
    
    Возвраты:
    a String определение имени cookie
  - setValue
```
public void setValue(String newValue)
```
    Присваивает новое значение cookie после того, как cookie создается. Если Вы используете двоичное значение, можно хотеть использовать кодирование BASE64.
    С cookie Версии 0 значения не должны содержать пробел, скобки, круглые скобки, равняется знакам, запятые, двойные кавычки, наклонные черты, вопросительные знаки, знаки at signs, двоеточия, и точки с запятой. Пустые значения, возможно, не ведут себя тот же самый путь на всех браузерах.
    
    Параметры:
    newValue - a String определение нового значения
    См. Также:
    getValue()
  - getValue
```
public String getValue()
```
    Возвращает значение cookie.
    
    Возвраты:
    a String содержа текущую стоимость cookie
    См. Также:
    setValue(java.lang.String)
  - getVersion
```
public int getVersion()
```
    Возвращает версию протокола, который выполняет этот cookie. Версия 1 выполняет RFC 2965/2109, и версия 0 выполняет исходную спецификацию cookie, проектированную Netscape. Cookie, обеспеченные браузером, используют и идентифицируют версию cookie браузера.
    
    Возвраты:
    0, если cookie выполняет исходную спецификацию Netscape; 1, если cookie выполняет RFC 2965/2109
    См. Также:
    setVersion(int)
  - setVersion
```
public void setVersion(int v)
```
    Устанавливает версию протокола cookie, который выполняет этот cookie. Версия 0 выполняет исходную спецификацию cookie Netscape. Версия 1 выполняет RFC 2965/2109.
    
    Параметры:
    v - 0, если cookie должен выполнить исходную спецификацию Netscape; 1, если cookie должен выполнить RFC 2965/2109
    
    Броски:
    
    IllegalArgumentException - если v не ни 0, ни 1
    См. Также:
    getVersion()
  - isHttpOnly
```
public boolean isHttpOnly()
```
    Возвраты true если этот cookie содержит атрибут HttpOnly. Это означает, что cookie не должен быть доступным для механизмов выполнения сценариев, как javascript.
    
    Возвраты:
    true если этот cookie нужно считать http только.
    См. Также:
    setHttpOnly(boolean)
  - setHttpOnly
```
public void setHttpOnly(boolean httpOnly)
```
    Указывает, нужно ли cookie считать HTTP Только. Если установлено в true это означает, что cookie не должен быть доступным для механизмов выполнения сценариев как javascript.
    
    Параметры:
    httpOnly - если true сделайте cookie HTTP только, то есть только видимый как часть запроса HTTP.
    См. Также:
    isHttpOnly()
  - domainMatches
```
public static boolean domainMatches(String domain,
                    String host)
```
    Служебный метод, чтобы проверить, является ли имя хоста в домене или нет.
    Это понятие описывается в спецификации cookie. Чтобы понять понятие, некоторая терминология должна быть определена сначала:
    эффективное имя хоста = имя хоста, если имя хоста содержит точку
    или = hostname.local, если нет
    
    Разместите узел доменных соответствий имени А Б если:
    их строковая строка имени хоста - сравнивается равный; или
    
    A является строкой HDN и имеет форму NB, где N является строкой непустого названия, у B есть форма.B', и B' является строкой HDN. (Так, x.y.com доменные соответствия .Y.com, но не Y.com.)
    Узел не находится в домене (секунда RFC 2965. 3.3.2), если:
    Значение для Доменного атрибута не содержит встроенных точек, и значение не является.local.
    
    Эффективное имя хоста, которое происходит из узла запроса, не делает доменного соответствия Доменный атрибут.
    
    Узел запроса является HDN (не IP-адрес) и имеет HD формы, где D является значением Доменного атрибута, и H является строкой, которая содержит одну или более точек.
    Примеры:
    Набор-Cookie2 от узла запроса y.x.foo.com к Domain=.foo.com был бы отклонен, потому что H является y.x и содержит точку.
    
    Набор-Cookie2 от узла запроса x.foo.com к Domain=.foo.com был бы принят.
    
    Набор-Cookie2 с Domain=.com или Domain=.com., будет всегда отклоняться, потому что нет никакой встроенной точки.
    
    Набор-Cookie2 с Domain=ajax.com будет принят, и значение для Домена будет принято, чтобы быть .ajax.com, потому что точка предварительно ожидается к значению.
    
    Набор-Cookie2 от примера узла запроса для Домена =. локальный будет принят, потому что эффективное имя хоста для запроса - узел является example.local, и example.local доменными соответствиями.local.
    Параметры:
    domain - доменное имя, чтобы проверить имя хоста с
    host - рассматриваемое имя хоста
    
    Возвраты:
    true, если они доменные соответствия; false, если нет
  - toString
```
public String toString()
```
    Создает строковое представление заголовка cookie этого cookie, который находится в формате, определенном соответствующей спецификацией cookie, но без ведущего "Cookie:" маркер.
    
    Переопределения:
    
    toString в классе Object
    
    Возвраты:
    строковая форма cookie. У строки есть определенный формат
  - равняется
```
public boolean equals(Object obj)
```
    Протестируйте равенство двух http cookie.
    Результатом является true, только если два cookie, прибывшие от того же самого (нечувствительного к регистру) домена, имейте то же самое (нечувствительное к регистру) имя, и имейте тот же самый (чувствительный к регистру) путь.
    
    Переопределения:
    
    equals в классе Object
    
    Параметры:
    obj - ссылочный объект, с которым можно сравниться.
    
    Возвраты:
    true, если 2 http cookie, равные друг другу; иначе, false
    См. Также:
    Object.hashCode(), HashMap
  - хэш-код
```
public int hashCode()
```
    Возвратите хэш-код этого http cookie. Результатом является сумма значения хэш-кода трех существенных компонентов этого cookie: имя, домен, и путь. Таким образом, хэш-код является значением выражения:
    getName ().toLowerCase ().hashCode ()
    + getDomain ().toLowerCase ().hashCode ()
    + getPath ().hashCode ()
    
    Переопределения:
    
    hashCode в классе Object
    
    Возвраты:
    хэш-код этого http cookie
    См. Также:
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - клон
```
public Object clone()
```
    Создайте и возвратите копию этого объекта.
    
    Переопределения:
    
    clone в классе Object
    
    Возвраты:
    клон этого http cookie
    См. Также:
    Cloneable

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Класс HttpCookie

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

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

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

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

HttpCookie

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

синтаксический анализ

hasExpired

setComment

getComment

setCommentURL

getCommentURL

setDiscard

getDiscard

setPortlist

getPortlist

setDomain

getDomain

setMaxAge

getMaxAge

setPath

getPath

setSecure

getSecure

getName

setValue

getValue

getVersion

setVersion

isHttpOnly

setHttpOnly

domainMatches

toString

равняется

хэш-код

клон