javax.servlet
Интерфейс SessionCookieConfig


public interface SessionCookieConfig

Класс, который может использоваться, чтобы сконфигурировать различные свойства cookie, используемых в целях отслеживания сеанса.

Экземпляр этого class получается звонком ServletContext#getSessionCookieConfig.

С тех пор:
Сервлет 3.0

Сводка метода
 java.lang.String getComment()
          Получает комментарий, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 java.lang.String getDomain()
          Получает доменное имя, которое будет присвоено любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 int getMaxAge()
          Получает время жизни (в секундах) cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 java.lang.String getName()
          Завоевывает репутацию, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 java.lang.String getPath()
          Получает путь, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 boolean isHttpOnly()
          Проверки, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, будут отмечены как HttpOnly.
 boolean isSecure()
          Проверки, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, будут отмечены как безопасные, даже если запрос, который инициировал соответствующий сеанс, будет использовать плоскость HTTP вместо HTTPS.
 void setComment(java.lang.String comment)
          Устанавливает комментарий, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 void setDomain(java.lang.String domain)
          Устанавливает доменное имя, которое будет присвоено любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 void setHttpOnly(boolean httpOnly)
          Марки или снимают выделение с cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого этот SessionCookieConfig был получен как HttpOnly.
 void setMaxAge(int maxAge)
          Устанавливает время жизни (в секундах) для cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 void setName(java.lang.String name)
          Определяет имя, которое будет присвоено любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 void setPath(java.lang.String path)
          Устанавливает путь, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
 void setSecure(boolean secure)
          Марки или снимают выделение с cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого этот SessionCookieConfig был получен как безопасный.
 

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

setName

void setName(java.lang.String name)
Определяет имя, которое будет присвоено любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

ОТМЕТЬТЕ: Изменять название cookie отслеживания сеанса может повредить другие уровни (например, фронтэнд выравнивания нагрузки), которые берут имя cookie, чтобы быть равными значению по умолчанию JSESSIONID, и поэтому должны только быть сделаны осторожно.

Параметры:
name - имя cookie к использованию
Броски:
IllegalStateException - если ServletContext, от которого был получен этот SessionCookieConfig, был уже инициализирован

getName

java.lang.String getName()
Завоевывает репутацию, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

По умолчанию JSESSIONID будет использоваться в качестве имени cookie.

Возвраты:
набор имени cookie через setName(java.lang.String), или null, если setName(java.lang.String) никогда не вызывался
См. Также:
Cookie.getName()

setDomain

void setDomain(java.lang.String domain)
Устанавливает доменное имя, которое будет присвоено любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

Параметры:
domain - домен cookie, чтобы использовать
Броски:
IllegalStateException - если ServletContext, от которого был получен этот SessionCookieConfig, был уже инициализирован
См. Также:
Cookie.setDomain(String)

getDomain

java.lang.String getDomain()
Получает доменное имя, которое будет присвоено любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

Возвраты:
набор домена cookie через setDomain(java.lang.String), или null, если setDomain(java.lang.String) никогда не вызывался
См. Также:
Cookie.getDomain()

setPath

void setPath(java.lang.String path)
Устанавливает путь, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

Параметры:
path - путь cookie к использованию
Броски:
IllegalStateException - если ServletContext, от которого был получен этот SessionCookieConfig, был уже инициализирован
См. Также:
Cookie.setPath(String)

getPath

java.lang.String getPath()
Получает путь, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

По умолчанию путь контекста ServletContext, от которого был получен этот SessionCookieConfig, будет использоваться.

Возвраты:
набор пути cookie через setPath(java.lang.String), или null, если setPath(java.lang.String) никогда не вызывался
См. Также:
Cookie.getPath()

setComment

void setComment(java.lang.String comment)
Устанавливает комментарий, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

Как побочный эффект этого вызова, cookie отслеживания сеанса будут отмечены с a Version припишите равный 1.

Параметры:
comment - комментарий cookie, чтобы использовать
Броски:
IllegalStateException - если ServletContext, от которого был получен этот SessionCookieConfig, был уже инициализирован
См. Также:
Cookie.setComment(String), Cookie.getVersion()

getComment

java.lang.String getComment()
Получает комментарий, который будет присвоен любым cookie отслеживания сеанса, создаваемым от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

Возвраты:
набор комментария cookie через setComment(java.lang.String), или null, если setComment(java.lang.String) никогда не вызывался
См. Также:
Cookie.getComment()

setHttpOnly

void setHttpOnly(boolean httpOnly)
Марки или снимают выделение с cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого этот SessionCookieConfig был получен как HttpOnly.

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

Параметры:
httpOnly - истина, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, должны быть отмечены как HttpOnly, ложь иначе
Броски:
IllegalStateException - если ServletContext, от которого был получен этот SessionCookieConfig, был уже инициализирован
См. Также:
Cookie.setHttpOnly(boolean)

isHttpOnly

boolean isHttpOnly()
Проверки, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, будут отмечены как HttpOnly.

Возвраты:
истина, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, будут отмечены как HttpOnly, ложь иначе
См. Также:
Cookie.isHttpOnly()

setSecure

void setSecure(boolean secure)
Марки или снимают выделение с cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого этот SessionCookieConfig был получен как безопасный.

Один вариант использования для того, чтобы отметить cookie отслеживания сеанса как secure, даже при том, что запрос, который инициировал сеанс, прибыл через HTTP, должен поддерживать топологию, где веб-контейнер заканчивается передней стороной SSL, разгружающим стабилизатор загрузки. В этом случае трафик между клиентом и стабилизатором загрузки будет по HTTPS, тогда как трафик между стабилизатором загрузки и веб-контейнером будет по HTTP.

Параметры:
secure - истина, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, должны быть отмечены как безопасные, даже если запрос, который инициировал соответствующий сеанс, будет использовать плоскость HTTP вместо HTTPS, и ложь, если они должны быть отмечены как безопасные, только если запрос, который инициировал соответствующий сеанс, был также безопасен
Броски:
IllegalStateException - если ServletContext, от которого был получен этот SessionCookieConfig, был уже инициализирован
См. Также:
Cookie.setSecure(boolean), ServletRequest#isSecure()

isSecure

boolean isSecure()
Проверки, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, будут отмечены как безопасные, даже если запрос, который инициировал соответствующий сеанс, будет использовать плоскость HTTP вместо HTTPS.

Возвраты:
истина, если cookie отслеживания сеанса, создаваемые от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig, будут отмечены как безопасные, даже если запрос, который инициировал соответствующий сеанс, будет использовать плоскость HTTP вместо HTTPS, и ложь, если они будут отмечены как безопасные, только если запрос, который инициировал соответствующий сеанс, был также безопасен
См. Также:
Cookie.getSecure(), ServletRequest#isSecure()

setMaxAge

void setMaxAge(int maxAge)
Устанавливает время жизни (в секундах) для cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

Параметры:
maxAge - время жизни (в секундах) cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.
Броски:
IllegalStateException - если ServletContext, от которого был получен этот SessionCookieConfig, был уже инициализирован
См. Также:
Cookie.setMaxAge(int)

getMaxAge

int getMaxAge()
Получает время жизни (в секундах) cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого был получен этот SessionCookieConfig.

По умолчанию -1 возвращается.

Возвраты:
время жизни (в секундах) cookie отслеживания сеанса, создаваемых от имени приложения, представленного ServletContext, от которого этот SessionCookieConfig был получен, или -1 (значение по умолчанию)
См. Также:
Cookie.getMaxAge()


Представьте ошибку или функцию

Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается срокам действия лицензии.

Сгенерированный на 10-February-2011 12:41


Spec-Zone.ru - all specs in one place



free hit counter