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

javax.servlet.http
Интерфейс HttpServletRequest

Все Суперинтерфейсы:

ServletRequest

Все Известные Классы с реализацией:

HttpServletRequestWrapper

public interface HttpServletRequest
расширяет ServletRequest

Расширяется ServletRequest интерфейс, чтобы предоставить информацию о запросе для сервлетов HTTP.

Контейнер сервлета создает HttpServletRequest объект и передачи это как параметр методам службы сервлета (doGet, doPost, и т.д.).

Автор:

Различный

Полевая Сводка

static java.lang.String	BASIC_AUTH Строковый идентификатор для Стандартной аутентификации.
static java.lang.String	CLIENT_CERT_AUTH Строковый идентификатор для Клиентской аутентификации Сертификата.
static java.lang.String	DIGEST_AUTH Строковый идентификатор для Дайджест-аутентификации.
static java.lang.String	FORM_AUTH Строковый идентификатор для аутентификации Формы.

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

boolean	authenticate(HttpServletResponse response) Используйте контейнерный механизм входа в систему, сконфигурированный для ServletContext аутентифицировать пользователя, обращающегося с этой просьбой.
java.lang.String	getAuthType() Возвращает имя схемы аутентификации, используемой, чтобы защитить сервлет.
java.lang.String	getContextPath() Возвращает часть URI запроса, который указывает на контекст запроса.
Cookie[]	getCookies() Возвращает массив, содержащий весь из Cookie возражает клиенту, отправленному с этим запросом.
long	getDateHeader(java.lang.String name) Возвращает значение указанного заголовка запроса как a long значение, которое представляет a Date объект.
java.lang.String	getHeader(java.lang.String name) Возвращает значение указанного заголовка запроса как a String.
java.util.Enumeration<java.lang.String>	getHeaderNames() Возвращает перечисление всех имен заголовка, которые содержит этот запрос.
java.util.Enumeration<java.lang.String>	getHeaders(java.lang.String name) Возвраты все значения указанного заголовка запроса как Enumeration из String объекты.
int	getIntHeader(java.lang.String name) Возвращает значение указанного заголовка запроса как int.
java.lang.String	getMethod() Возвращает имя метода HTTP, с которым с этой просьбой обратились, например, ДОБЕРИТЕСЬ, POST, или ПОМЕСТИТЕ.
Часть	getPart(java.lang.String name) Добирается Part с именем.
java.util.Collection<Part>	getParts() Добирается весь Part компоненты этого запроса, при условии, что это имеет тип multipart/form-data.
java.lang.String	getPathInfo() Возвраты любая дополнительная информация о пути, связанная с URL, который отправил клиент, когда это обращалось с этой просьбой.
java.lang.String	getPathTranslated() Возвраты любая дополнительная информация о пути после имени сервлета, но перед строкой запроса, и преобразовывают это в реальный путь.
java.lang.String	getQueryString() Возвращает строку запроса, которая содержится в запросе URL после пути.
java.lang.String	getRemoteUser() Возвращает вход в систему пользователя, обращающегося с этой просьбой, если пользователь аутентифицировался, или null если пользователь не аутентифицировался.
java.lang.String	getRequestedSessionId() Возвращает ID сеанса, определенный клиентом.
java.lang.String	getRequestURI() Возвращает часть URL этого запроса с имени протокола до строки запроса в первой строке запроса HTTP.
java.lang.StringBuffer	getRequestURL() Восстанавливает URL клиент, используемый, чтобы обратиться с просьбой.
java.lang.String	getServletPath() Возвращает часть URL этого запроса, который вызывает сервлет.
HttpSession	getSession() Возвращает текущий сеанс, связанный с этим запросом, или если у запроса нет сеанса, создает тот.
HttpSession	getSession(boolean create) Возвращает ток HttpSession связанный с этим запросом или, если нет никакого текущего сеанса и create истина, возвращает новый сеанс.
java.security.Principal	getUserPrincipal() Возвраты a java.security.Principal объект, содержащий имя тока аутентифицируемый пользователь.
boolean	isRequestedSessionIdFromCookie() Проверки, вошел ли требуемый ID сеанса как cookie.
boolean	isRequestedSessionIdFromUrl() Осуждаемый. С Версии 2.1 API Сервлета Java использовать isRequestedSessionIdFromURL() вместо этого.
boolean	isRequestedSessionIdFromURL() Проверки, вошел ли требуемый ID сеанса как часть запроса URL.
boolean	isRequestedSessionIdValid() Проверки, допустим ли требуемый ID сеанса все еще.
boolean	isUserInRole(java.lang.String role) Возвращает булево указание, включается ли аутентифицируемый пользователь в указанную логическую "роль".
void	login(java.lang.String username, java.lang.String password) Проверьте обеспеченного имени пользователя и пароля в области проверки допустимости пароля, используемой веб-механизмом входа в систему контейнера, сконфигурированным для ServletContext.
void	logout() Установить null поскольку значение возвратилось когда getUserPrincipal, getRemoteUser, и getAuthType вызывается по запросу.

Методы, наследованные от интерфейса javax.servlet. ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Полевая Деталь

BASIC_AUTH

static final java.lang.String BASIC_AUTH

Строковый идентификатор для Стандартной аутентификации. "ОСНОВНОЕ" значение

См. Также:

Постоянные Значения полей

FORM_AUTH

static final java.lang.String FORM_AUTH

Строковый идентификатор для аутентификации Формы. Значение "ФОРМА"

См. Также:

Постоянные Значения полей

CLIENT_CERT_AUTH

static final java.lang.String CLIENT_CERT_AUTH

Строковый идентификатор для Клиентской аутентификации Сертификата. Значение "CLIENT_CERT"

См. Также:

Постоянные Значения полей

DIGEST_AUTH

static final java.lang.String DIGEST_AUTH

Строковый идентификатор для Дайджест-аутентификации. Значение "ОБЗОР"

См. Также:

Постоянные Значения полей

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

getAuthType

java.lang.String getAuthType()

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

То же самое как значение переменной CGI AUTH_TYPE.

Возвраты:

один из статических элементов BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (подходящий для == сравнение) или контейнерно-специфичная строка, указывающая на схему аутентификации, или null если запрос не аутентифицировался.

getCookies

Cookie[] getCookies()

Возвращает массив, содержащий весь из Cookie возражает клиенту, отправленному с этим запросом. Этот метод возвраты null если никакие cookie не были отправлены.

Возвраты:

массив весь Cookies включенный с этим запросом, или null если у запроса нет никаких cookie

getDateHeader

long getDateHeader(java.lang.String name)

Возвращает значение указанного заголовка запроса как a long значение, которое представляет a Date объект. Используйте этот метод с заголовками, которые содержат даты, такой как If-Modified-Since.

Дата возвращается как число миллисекунд с 1 января 1970 GMT. Имя заголовка является нечувствительным к регистру.

Если у запроса не было заголовка указанного имени, этот метод возвращается-1. Если заголовок не может быть преобразован в дату, метод бросает IllegalArgumentException.

Параметры:

name - a String определение имени заголовка

Возвраты:

a long значение, представляющее дату, определенную в заголовке, выраженном как число миллисекунд с 1 января 1970 GMT, или-1, если именованный заголовок не был включен с запросом

Броски:

IllegalArgumentException - Если значение заголовка не может быть преобразовано в дату

getHeader

java.lang.String getHeader(java.lang.String name)

Возвращает значение указанного заголовка запроса как a String. Если запрос не включал заголовок указанного имени, этот метод возвраты null. Если есть многократные заголовки с тем же самым именем, этот метод возвращает первую голову в запросе. Имя заголовка является нечувствительным к регистру. Можно использовать этот метод с любым заголовком запроса.

Параметры:

name - a String определение имени заголовка

Возвраты:

a String содержа значение требуемого заголовка, или null если у запроса нет заголовка того имени

getHeaders

java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)

Возвраты все значения указанного заголовка запроса как Enumeration из String объекты.

Некоторые заголовки, такой как Accept-Language может быть отправлен клиентами как несколько заголовков каждый с различным значением вместо того, чтобы отправить заголовок как список разделенных запятой значений.

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

Параметры:

name - a String определение имени заголовка

Возвраты:

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

getHeaderNames

java.util.Enumeration<java.lang.String> getHeaderNames()

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

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

Возвраты:

перечисление всех имен заголовка передалось с этим запросом; если у запроса нет никаких заголовков, пустого перечисления; если контейнер сервлета не позволяет сервлетам использовать этот метод, null

getIntHeader

int getIntHeader(java.lang.String name)

Возвращает значение указанного заголовка запроса как int. Если у запроса нет заголовка указанного имени, этот метод возвращается-1. Если заголовок не может быть преобразован в целое число, этот метод бросает a NumberFormatException.

Имя заголовка является нечувствительным к регистру.

Параметры:

name - a String определение имени заголовка запроса

Возвраты:

целое число, выражающее значение заголовка запроса или-1, если у запроса нет заголовка этого имени

Броски:

java.lang.NumberFormatException - Если значение заголовка не может быть преобразовано в int

getMethod

java.lang.String getMethod()

Возвращает имя метода HTTP, с которым с этой просьбой обратились, например, ДОБЕРИТЕСЬ, POST, или ПОМЕСТИТЕ. То же самое как значение переменной CGI REQUEST_METHOD.

Возвраты:

a String определение имени метода, с которым обратились с этой просьбой

getPathInfo

java.lang.String getPathInfo()

Возвраты любая дополнительная информация о пути, связанная с URL, который отправил клиент, когда это обращалось с этой просьбой. Дополнительная информация о пути следует за путем сервлета, но предшествует строке запроса и запустится с "/" символ.

Этот метод возвраты null если не было никакой дополнительной информации о пути.

То же самое как значение переменной CGI PATH_INFO.

Возвраты:

a String, декодируемый веб-контейнером, определяя дополнительную информацию о пути, которая прибывает после пути сервлета, но перед строкой запроса в запросе URL; или null если у URL нет никакой дополнительной информации о пути

getPathTranslated

java.lang.String getPathTranslated()

Возвраты любая дополнительная информация о пути после имени сервлета, но перед строкой запроса, и преобразовывают это в реальный путь. То же самое как значение переменной CGI PATH_TRANSLATED.

Если у URL нет никакой дополнительной информации о пути, этот метод возвраты null или контейнер сервлета не может преобразовать виртуальный путь к реальному пути по любой причине (такой как тогда, когда веб-приложение выполняется от архива). Веб-контейнер не декодирует эту строку.

Возвраты:

a String определение реального пути, или null если у URL нет никакой дополнительной информации о пути

getContextPath

java.lang.String getContextPath()

Возвращает часть URI запроса, который указывает на контекст запроса. Путь контекста всегда на первом месте в URI запроса. Путь запускается с "/" символ, но не заканчивается "/" символ. Для сервлетов в значении по умолчанию (корень) контекст этот метод возвращается "". Контейнер не декодирует эту строку.

Возможно, что контейнер сервлета может соответствовать контекст больше чем одним путем контекста. В таких случаях этот метод возвратит фактический путь контекста, используемый запросом, и это может отличаться от пути, возвращенного ServletContext.getContextPath() метод. Путь контекста, возвращенный ServletContext.getContextPath() должен быть рассмотрен как главный или привилегированный путь контекста приложения.

Возвраты:

a String определение части URI запроса, который указывает на контекст запроса

См. Также:

ServletContext.getContextPath()

getQueryString

java.lang.String getQueryString()

Возвращает строку запроса, которая содержится в запросе URL после пути. Этот метод возвраты null если у URL нет строки запроса. То же самое как значение переменной CGI QUERY_STRING.

Возвраты:

a String содержа строку запроса или null если URL не содержит строки запроса. Значение не декодируется контейнером.

getRemoteUser

java.lang.String getRemoteUser()

Возвращает вход в систему пользователя, обращающегося с этой просьбой, если пользователь аутентифицировался, или null если пользователь не аутентифицировался. Отправляется ли имя пользователя с каждым последующим запросом, зависит от браузера и типа аутентификации. То же самое как значение переменной CGI REMOTE_USER.

Возвраты:

a String определение входа в систему пользователя, обращающегося с этой просьбой, или null если пользовательский вход в систему не известен

isUserInRole

boolean isUserInRole(java.lang.String role)

Возвращает булево указание, включается ли аутентифицируемый пользователь в указанную логическую "роль". Роли и ролевое членство могут быть определены, используя дескрипторы развертывания. Если пользователь не аутентифицировался, возвраты метода false.

Параметры:

role - a String определение имени роли

Возвраты:

a boolean указание, принадлежит ли пользователь, обращающийся с этой просьбой, данной роли; false если пользователь не аутентифицировался

getUserPrincipal

java.security.Principal getUserPrincipal()

Возвраты a java.security.Principal объект, содержащий имя тока аутентифицируемый пользователь. Если пользователь не аутентифицировался, возвраты метода null.

Возвраты:

a java.security.Principal содержа имя пользователя, обращающегося с этой просьбой; null если пользователь не аутентифицировался

getRequestedSessionId

java.lang.String getRequestedSessionId()

Возвращает ID сеанса, определенный клиентом. Это, возможно, не то же самое как ID текущего допустимого сеанса для этого запроса. Если клиент не определял ID сеанса, этот метод возвраты null.

Возвраты:

a String определение ID сеанса, или null если запрос не определял ID сеанса

См. Также:

isRequestedSessionIdValid()

getRequestURI

java.lang.String getRequestURI()

Возвращает часть URL этого запроса с имени протокола до строки запроса в первой строке запроса HTTP. Веб-контейнер не декодирует эту Строку. Например:

Первая строка запроса HTTP	Возвращенное Значение
POST /some/path.html HTTP/1.1		/some/path.html
ПОЛУЧИТЕ http://foo.bar/a.html HTTP/1.0		/a.html
ГЛАВНЫЙ/xyz? a=b HTTP/1.1		/xyz

Чтобы восстановить URL со схемой и узлом, использовать HttpUtils#getRequestURL.

Возвраты:

a String содержа часть URL из протокола называет до строки запроса

См. Также:

HttpUtils#getRequestURL

getRequestURL

java.lang.StringBuffer getRequestURL()

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

Если этот запрос был передан, используя RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse), путь сервера в восстановленном URL должен отразить путь, используемый, чтобы получить RequestDispatcher, а не путь сервера, определенный клиентом.

Поскольку этот метод возвращает a StringBuffer, не строка, можно изменить URL легко, например, к параметрам запроса на добавление.

Этот метод полезен для создания сообщений перенаправления и для создания отчетов об ошибках.

Возвраты:

a StringBuffer объект, содержащий восстановленный URL

getServletPath

java.lang.String getServletPath()

Возвращает часть URL этого запроса, который вызывает сервлет. Этот путь запускается с "/" символ и включает или имя сервлета или путь к сервлету, но не включает дополнительной информации о пути или строки запроса. То же самое как значение переменной CGI SCRIPT_NAME.

Этот метод возвратит пустую строку (""), если сервлет, используемый, чтобы обработать этот запрос, был соответствующим, используя "/*" образец.

Возвраты:

a String содержа имя или путь вызываемого сервлета, как определено в запросе URL, декодируемый, или пустая строка, если сервлет, используемый, чтобы обработать запрос, является соответствующим, используя "/*" образец.

getSession

HttpSession getSession(boolean create)

Возвращает ток HttpSession связанный с этим запросом или, если нет никакого текущего сеанса и create истина, возвращает новый сеанс.

Если create false и запрос имеет не допустимый HttpSession, этот метод возвраты null.

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

Параметры:

create - true создать новый сеанс для этого запроса в случае необходимости; false возвратиться null если нет никакого текущего сеанса

Возвраты:

HttpSession связанный с этим запросом или null если create false и у запроса нет никакого допустимого сеанса

См. Также:

getSession()

getSession

HttpSession getSession()

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

Возвраты:

HttpSession связанный с этим запросом

См. Также:

getSession(boolean)

isRequestedSessionIdValid

boolean isRequestedSessionIdValid()

Проверки, допустим ли требуемый ID сеанса все еще.

Если клиент не определял ID сеанса, этот метод возвраты false.

Возвраты:

true если у этого запроса есть идентификатор для допустимого сеанса в текущем контексте сеанса; false иначе

См. Также:

getRequestedSessionId(), getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

boolean isRequestedSessionIdFromCookie()

Проверки, вошел ли требуемый ID сеанса как cookie.

Возвраты:

true если ID сеанса вошел как cookie; иначе, false

См. Также:

getSession(boolean)

isRequestedSessionIdFromURL

boolean isRequestedSessionIdFromURL()

Проверки, вошел ли требуемый ID сеанса как часть запроса URL.

Возвраты:

true если ID сеанса вошел как часть URL; иначе, false

См. Также:

getSession(boolean)

isRequestedSessionIdFromUrl

boolean isRequestedSessionIdFromUrl()

Осуждаемый. С Версии 2.1 API Сервлета Java использовать isRequestedSessionIdFromURL() вместо этого.

аутентифицировать

boolean authenticate(HttpServletResponse response)
                     throws java.io.IOException,
                            ServletException

Используйте контейнерный механизм входа в систему, сконфигурированный для ServletContext аутентифицировать пользователя, обращающегося с этой просьбой.

Этот метод может изменить и фиксировать параметр HttpServletResponse.

Параметры:

response - HttpServletResponse связанный с этим HttpServletRequest

Возвраты:

true когда ненулевые значения были или были установлены как значения, возвращенные getUserPrincipal, getRemoteUser, и getAuthType. Возвратиться false если аутентификация является неполной, и базовый механизм входа в систему фиксировал, в ответе, сообщение (например, проблема) и код состояния HTTP, который будет возвращен пользователю.

Броски:

java.io.IOException - если ошибка ввода или вывода произошла, читая из этого запроса или при записи в данный ответ

IllegalStateException - если механизм входа в систему, предпринятый, чтобы изменить ответ и это уже фиксировалось

ServletException - если аутентификация перестала работать, и вызывающая сторона ответственна за обработку ошибки (то есть, базовый механизм входа в систему НЕ устанавливал сообщение и код состояния HTTP, который будет возвращен пользователю),

С тех пор:

Сервлет 3.0

вход в систему

void login(java.lang.String username,
           java.lang.String password)
           throws ServletException

Проверьте обеспеченного имени пользователя и пароля в области проверки допустимости пароля, используемой веб-механизмом входа в систему контейнера, сконфигурированным для ServletContext.

Этот метод возвращается, не бросая a ServletException когда механизм входа в систему, сконфигурированный для ServletContext поддерживает проверку допустимости пароля имени пользователя, и когда, во время вызова, чтобы войти в систему, идентификационные данные вызывающей стороны запроса не были установлены (то есть, весь из getUserPrincipal, getRemoteUser, и getAuthType возвратите нуль), и когда проверка допустимости обеспеченных учетных данных успешна. Иначе, этот метод бросает a ServletException как описано ниже.

Когда этот метод возвращается, не выдавая исключение, он, должно быть, установил ненулевые значения как значения, возвращенные getUserPrincipal, getRemoteUser, и getAuthType.

Параметры:

username - String значение, соответствующее идентификатору для входа в систему пользователя.

password - Пароль String соответствие идентифицированному пользователю.

Броски:

ServletException - если сконфигурированный механизм входа в систему не поддерживает аутентификацию по паролю имени пользователя, или если ненулевые идентификационные данные вызывающей стороны были уже установлены (до вызова, чтобы войти в систему), или если проверка допустимости обеспеченного имени пользователя и пароля перестала работать.

С тех пор:

Сервлет 3.0

выход из системы

void logout()
            throws ServletException

Установить null поскольку значение возвратилось когда getUserPrincipal, getRemoteUser, и getAuthType вызывается по запросу.

Броски:

ServletException - если выход из системы перестал работать

С тех пор:

Сервлет 3.0

getParts

java.util.Collection<Part> getParts()
                                    throws java.io.IOException,
                                           ServletException

Добирается весь Part компоненты этого запроса, при условии, что это имеет тип multipart/form-data.

Если этот запрос будет иметь тип multipart/form-data, но не будет содержать компонентов Части, то возвращенный Collection будет пуст.

Любые изменения к возвращенному Collection не должен влиять на это HttpServletRequest.

Возвраты:

(возможно пустой) Collection из компонентов Части этого запроса

Броски:

java.io.IOException - если ошибка ввода-вывода произошла во время извлечения Part компоненты этого запроса

ServletException - если этот запрос не имеет типа multipart/form-data

IllegalStateException - если тело запроса больше чем maxRequestSize, или любая Часть в запросе больше чем maxFileSize

С тех пор:

Сервлет 3.0

См. Также:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()

getPart

Part getPart(java.lang.String name)
             throws java.io.IOException,
                    ServletException

Добирается Part с именем.

Параметры:

name - имя требуемой Части

Возвраты:

Часть с именем, или null, если этот запрос имеет тип multipart/form-data, но не содержит требуемую Часть

Броски:

java.io.IOException - если ошибка ввода-вывода произошла во время извлечения требуемой Части

ServletException - если этот запрос не имеет типа multipart/form-data

IllegalStateException - если тело запроса больше чем maxRequestSize, или любая Часть в запросе больше чем maxFileSize

С тех пор:

Сервлет 3.0

См. Также:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()