Spec-Zone .ru
спецификации, руководства, описания, API
|
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
public interface ServletRequest
Определяет объект предоставить клиентскую информацию о запросе сервлету. Контейнер сервлета создает a ServletRequest
объект и передачи это как параметр сервлету service
метод.
A ServletRequest
объект обеспечивает данные включая название параметра и значения, атрибуты, и входной поток. Интерфейсы, которые расширяются ServletRequest
может обеспечить дополнительные специфичные для протокола данные (например, данными HTTP обеспечивают HttpServletRequest
.
HttpServletRequest
Сводка метода | |
---|---|
AsyncContext |
getAsyncContext()
Получает AsyncContext, который был создан или повторно инициализирован новым вызовом startAsync() или startAsync(ServletRequest,ServletResponse) по этому запросу. |
java.lang.Object |
getAttribute(java.lang.String name)
Возвращает значение именованного атрибута как Object , или null если никакой атрибут имени не существует. |
java.util.Enumeration<java.lang.String> |
getAttributeNames()
Возвраты Enumeration содержа имена атрибутов, доступных этому запросу. |
java.lang.String |
getCharacterEncoding()
Возвращает имя кодировки символов, используемой в теле этого запроса. |
int |
getContentLength()
Возвращает длину, в байтах, тела запроса и сделанный доступный входным потоком, или-1, если длина не известна. |
java.lang.String |
getContentType()
Возвращает тип MIME тела запроса, или null если тип не известен. |
DispatcherType |
getDispatcherType()
Получает тип диспетчера этого запроса. |
ServletInputStream |
getInputStream()
Получает тело запроса как двоичные данные, используя a ServletInputStream . |
java.lang.String |
getLocalAddr()
Возвращает интернет-Протокол (IP) адрес интерфейса, в котором был получен запрос. |
java.util.Locale |
getLocale()
Возвращает привилегированное Locale то, что клиент примет контент в, основанный на заголовке Принимать-языка. |
java.util.Enumeration<java.util.Locale> |
getLocales()
Возвраты Enumeration из Locale указание объектов, в порядке убывания запускающееся с привилегированной локали, локали, которые являются приемлемыми для клиента, основанного на заголовке Принимать-языка. |
java.lang.String |
getLocalName()
Возвращает имя хоста интернет-Протокола (IP) интерфейс, в котором был получен запрос. |
int |
getLocalPort()
Возвращает интернет-Протокол (IP) номер порта интерфейса, в котором был получен запрос. |
java.lang.String |
getParameter(java.lang.String name)
Возвращает значение параметра запроса как a String , или null если параметр не существует. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameterMap()
Возвращает java.util. Карта параметров этого запроса. |
java.util.Enumeration<java.lang.String> |
getParameterNames()
Возвраты Enumeration из String объекты, содержащие имена параметров, содержатся в этом запросе. |
java.lang.String[] |
getParameterValues(java.lang.String name)
Возвращает массив String объекты, содержащие все значения данный параметр запроса, имеют, или null если параметр не существует. |
java.lang.String |
getProtocol()
Возвращает имя и версию протокола использование запроса в форме protocol/majorVersion.minorVersion, например, HTTP/1.1. |
java.io.BufferedReader |
getReader()
Получает тело запроса как символьные данные, используя a BufferedReader . |
java.lang.String |
getRealPath(java.lang.String path)
Осуждаемый. С Версии 2.1 API Сервлета Java использовать ServletContext#getRealPath вместо этого. |
java.lang.String |
getRemoteAddr()
Возвращает интернет-Протокол (IP) адрес клиента или последнего прокси, который отправил запрос. |
java.lang.String |
getRemoteHost()
Возвращает полностью определенное имя клиента или последнего прокси, который отправил запрос. |
int |
getRemotePort()
Возвращает интернет-Протокол (IP) исходный порт клиента или последнего прокси, который отправил запрос. |
RequestDispatcher |
getRequestDispatcher(java.lang.String path)
Возвраты a RequestDispatcher возразите что действия как обертка для ресурса, расположенного в данном пути. |
java.lang.String |
getScheme()
Возвращает имя схемы, используемой, чтобы обратиться с этой просьбой, например, http , https , или ftp . |
java.lang.String |
getServerName()
Возвращает имя хоста сервера, которому был отправлен запрос. |
int |
getServerPort()
Возвращает номер порта, которому был отправлен запрос. |
ServletContext |
getServletContext()
Получает контекст сервлета, к которому этот ServletRequest был последний диспетчеризированный. |
boolean |
isAsyncStarted()
Проверки, если этот запрос был помещен в асинхронный режим. |
boolean |
isAsyncSupported()
Проверки, если этот запрос поддерживает асинхронную работу. |
boolean |
isSecure()
Возвращает булево указание, обратились ли с этой просьбой, используя безопасный канал, такой как HTTPS. |
void |
removeAttribute(java.lang.String name)
Удаляет атрибут из этого запроса. |
void |
setAttribute(java.lang.String name, java.lang.Object o)
Хранит атрибут в этом запросе. |
void |
setCharacterEncoding(java.lang.String env)
Переопределяет имя кодировки символов, используемой в теле этого запроса. |
AsyncContext |
startAsync()
Помещает этот запрос в асинхронный режим, и инициализирует AsyncContext с исходными (развернутыми) объектами ServletRequest и ServletResponse. |
AsyncContext |
startAsync(ServletRequest servletRequest, ServletResponse servletResponse)
Помещает этот запрос в асинхронный режим, и инициализирует AsyncContext с данным запросом и объектами ответа. |
Деталь метода |
---|
java.lang.Object getAttribute(java.lang.String name)
Object
, или null
если никакой атрибут имени не существует. Атрибуты могут быть установлены два пути. Контейнер сервлета может установить атрибуты, чтобы сделать доступным пользовательская информация о запросе. Например, для просьб, обращенных, используя HTTPS, атрибут javax.servlet.request.X509Certificate
может использоваться, чтобы получить информацию о сертификате о клиенте. Атрибуты могут также быть установлены использование programatically ServletRequest#setAttribute
. Это позволяет информации быть встроенной в запрос прежде a RequestDispatcher
вызвать.
Названия атрибута должны следовать за теми же самыми соглашениями как имена пакета. Эта спецификация резервирует соответствие имен java.*
, javax.*
, и sun.*
.
name
- a String
определение имени атрибута Object
содержа значение атрибута, или null
если атрибут не существуетjava.util.Enumeration<java.lang.String> getAttributeNames()
Enumeration
содержа имена атрибутов, доступных этому запросу. Этот метод возвращает пустое Enumeration
если запрос не имеет атрибутов в наличии для этого.
Enumeration
из строк, содержащих имена атрибутов запросаjava.lang.String getCharacterEncoding()
null
если запрос не определяет кодировку символов
String
содержа имя кодировки символов, или null
если запрос не определяет кодировку символовvoid setCharacterEncoding(java.lang.String env) throws java.io.UnsupportedEncodingException
env
- String
содержа имя кодировки символов. java.io.UnsupportedEncodingException
- если этот ServletRequest находится все еще в состоянии, где кодировка символов может быть установлена, но указанное кодирование недопустимоint getContentLength()
java.lang.String getContentType()
null
если тип не известен. Для сервлетов HTTP, то же самое как значение переменной CGI CONTENT_TYPE.
String
содержа имя типа MIME запроса, или нуль, если тип не известенServletInputStream getInputStream() throws java.io.IOException
ServletInputStream
. Или этот метод или getReader()
может быть вызван, чтобы считать тело, не обоих.
ServletInputStream
объект, содержащий тело запроса IllegalStateException
- если getReader()
метод уже вызвали для этого запроса java.io.IOException
- если исключение ввода или вывода произошлоjava.lang.String getParameter(java.lang.String name)
String
, или null
если параметр не существует. Параметры запроса являются дополнительной информацией, отправленной с запросом. Для сервлетов HTTP параметры содержатся в строке запроса или отправили данные формы. Следует только использовать этот метод, когда Вы уверены, что у параметра есть только одно значение. Если у параметра могло бы быть больше чем одно значение, использовать getParameterValues(java.lang.String)
.
Если Вы используете этот метод с многозначным параметром, возвращенное значение равно первому значению в массиве, возвращенном getParameterValues
.
Если данные параметра были отправлены в теле запроса, том, которое происходит с запросом POST HTTP, то, читая тело непосредственно через getInputStream()
или getReader()
может вмешаться в выполнение этого метода.
name
- a String
определение имени параметра String
представление единственного значения параметраgetParameterValues(java.lang.String)
java.util.Enumeration<java.lang.String> getParameterNames()
Enumeration
из String
объекты, содержащие имена параметров, содержатся в этом запросе. Если у запроса нет никаких параметров, метод возвращает пустое Enumeration
.
Enumeration
из String
объекты, каждый String
содержа имя параметра запроса; или пустое Enumeration
если у запроса нет никаких параметровjava.lang.String[] getParameterValues(java.lang.String name)
String
объекты, содержащие все значения данный параметр запроса, имеют, или null
если параметр не существует. Если у параметра есть единственное значение, у массива есть длина 1.
name
- a String
содержа имя параметра, значение которого требуют String
объекты, содержащие значения параметраgetParameter(java.lang.String)
java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
Параметры запроса являются дополнительной информацией, отправленной с запросом. Для сервлетов HTTP параметры содержатся в строке запроса или отправили данные формы.
java.lang.String getProtocol()
SERVER_PROTOCOL
.
String
содержа имя протокола и номер версииjava.lang.String getScheme()
http
, https
, или ftp
. У различных схем есть различные правила для того, чтобы создать URL, как отмечено в RFC 1738.
String
содержа имя схемы, используемой, чтобы обратиться с этой просьбойjava.lang.String getServerName()
Host
значение заголовка, если таковые вообще имеются, или разрешенное имя сервера, или IP-адрес сервера.
String
содержа имя сервераint getServerPort()
Host
значение заголовка, если таковые вообще имеются, или порт сервера, где клиентское соединение было принято на.
java.io.BufferedReader getReader() throws java.io.IOException
BufferedReader
. Читатель преобразовывает символьные данные согласно кодировке символов, используемой на теле. Или этот метод или getInputStream()
может быть вызван, чтобы считать тело, не обоих.
BufferedReader
содержа тело запроса java.io.UnsupportedEncodingException
- если используемое кодирование набора символов не поддерживается, и текст не может декодироваться IllegalStateException
- если getInputStream()
метод вызвали по этому запросу java.io.IOException
- если исключение ввода или вывода произошлоgetInputStream()
java.lang.String getRemoteAddr()
REMOTE_ADDR
.
String
содержа IP-адрес клиента, который отправил запросjava.lang.String getRemoteHost()
REMOTE_HOST
.
String
содержа полностью определенное имя клиентаvoid setAttribute(java.lang.String name, java.lang.Object o)
RequestDispatcher
. Названия атрибута должны следовать за теми же самыми соглашениями как имена пакета. Начинающиеся имена java.*
, javax.*
, и com.sun.*
, резервируются для использования Sun Microsystems.
Если объект, который передают в, является нулем, эффект является тем же самым как вызовом removeAttribute(java.lang.String)
.
Это предупреждается, что то, когда запрос диспетчеризируется от сервлета, находится в различном веб-приложении RequestDispatcher
, объект, установленный этим методом, не может быть правильно получен в сервлете вызывающей стороны.
name
- a String
определение имени атрибутаo
- Object
быть сохраненнымvoid removeAttribute(java.lang.String name)
Названия атрибута должны следовать за теми же самыми соглашениями как имена пакета. Начинающиеся имена java.*
, javax.*
, и com.sun.*
, резервируются для использования Sun Microsystems.
name
- a String
определение имени атрибута, чтобы удалитьjava.util.Locale getLocale()
Locale
то, что клиент примет контент в, основанный на заголовке Принимать-языка. Если клиентский запрос не обеспечивает заголовок Принимать-языка, этот метод возвращает локаль значения по умолчанию для сервера.
Locale
для клиентаjava.util.Enumeration<java.util.Locale> getLocales()
Enumeration
из Locale
указание объектов, в порядке убывания запускающееся с привилегированной локали, локали, которые являются приемлемыми для клиента, основанного на заголовке Принимать-языка. Если клиентский запрос не обеспечивает заголовок Принимать-языка, этот метод возвращается Enumeration
содержа один Locale
, локаль значения по умолчанию для сервера.
Enumeration
из привилегированных Locale
объекты для клиентаboolean isSecure()
RequestDispatcher getRequestDispatcher(java.lang.String path)
RequestDispatcher
возразите что действия как обертка для ресурса, расположенного в данном пути. A RequestDispatcher
объект может использоваться, чтобы передать запрос к ресурсу или включать ресурс в ответ. Ресурс может быть динамичным или статичным. Определенный путь может быть относительным, хотя он не может расшириться вне текущего контекста сервлета. Если путь начинается "/", он интерпретируется как относительно текущего корня контекста. Этот метод возвраты null
если контейнер сервлета не может возвратить a RequestDispatcher
.
Различие между этим методом и ServletContext#getRequestDispatcher
тот этот метод, может взять относительный путь.
path
- a String
определение пути к ресурсу. Если это относительно, это должно быть относительно против текущего сервлета. RequestDispatcher
возразите что действия как обертка для ресурса в указанном пути, или null
если контейнер сервлета не может возвратить a RequestDispatcher
RequestDispatcher
, ServletContext#getRequestDispatcher
java.lang.String getRealPath(java.lang.String path)
ServletContext#getRealPath
вместо этого.
int getRemotePort()
java.lang.String getLocalName()
String
содержа имя хоста IP, на котором был получен запрос.java.lang.String getLocalAddr()
String
содержа IP-адрес, на котором был получен запрос.int getLocalPort()
ServletContext getServletContext()
AsyncContext startAsync() throws java.lang.IllegalStateException
AsyncContext
с исходными (развернутыми) объектами ServletRequest и ServletResponse. Вызов этого метода заставит поддержку связанного ответа не быть задержанной до AsyncContext#complete
вызывается на возвращенном AsyncContext
, или асинхронная работа имеет синхронизированный.
Вызов AsyncContext#hasOriginalRequestAndResponse()
на возвращенном AsyncContext возвратится true
. Любые фильтры, вызванные в исходящем направлении после этого запроса, были помещены в асинхронный режим, может использовать это в качестве индикации, что любой запрос и/или обертки ответа, которые они добавили во время их входящего вызова, не должны остаться вокруг для продолжительности асинхронной работы, и поэтому любые из их связанных средств могут быть высвобождены.
Этот метод очищает список AsyncListener
экземпляры (если любой), которые были зарегистрированы в AsyncContext, возвращенном предыдущим звонком в один из startAsync методов после вызова каждого AsyncListener в onStartAsync
метод.
Последующие вызовы этого метода, или его перегруженная разновидность, возвратят тот же самый экземпляр AsyncContext, повторно инициализированный как соответствующий.
IllegalStateException
- если этот запрос в рамках фильтра или сервлета, который не поддерживает асинхронные операции (то есть, isAsyncSupported()
возвращает false), или если этот метод вызывают снова ни с кем асинхронным, диспетчеризируют (следующий из одного из AsyncContext#dispatch
методы), вызывается вне контекста любого такого диспетчеризировать, или вызывается снова в рамках того же самого, диспетчеризируют, или если ответ был уже закрытAsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) throws java.lang.IllegalStateException
AsyncContext
с данным запросом и объектами ответа. Параметрами ServletRequest и ServletResponse должны быть те же самые экземпляры, или экземпляры ServletRequestWrapper
и ServletResponseWrapper
это обертывает их, которых передали к service
метод Сервлета или doFilter
метод Фильтра, соответственно, в чьем контексте вызывают этот метод.
Вызов этого метода заставит поддержку связанного ответа не быть задержанной до AsyncContext#complete
вызывается на возвращенном AsyncContext
, или асинхронная работа имеет синхронизированный.
Вызов AsyncContext#hasOriginalRequestAndResponse()
на возвращенном AsyncContext возвратится false
, если переданные в параметрах ServletRequest и ServletResponse не являются исходными или не переносят обеспеченных приложением оберток. Любые фильтры, вызванные в исходящем направлении после этого запроса, были помещены в асинхронный режим, может использовать это в качестве индикации, что часть запроса и/или оберток ответа, которые они добавили во время их входящего вызова, возможно, должна остаться на месте для продолжительности асинхронной работы, и их связанные средства не могут быть высвобождены. ServletRequestWrapper, примененный во время входящего вызова фильтра, может быть выпущен исходящим вызовом фильтра только если данный servletRequest
, который используется, чтобы инициализировать AsyncContext и будет возвращен звонком AsyncContext#getRequest()
, не содержит сказал ServletRequestWrapper. То же самое сохраняется для экземпляров ServletResponseWrapper.
Этот метод очищает список AsyncListener
экземпляры (если любой), которые были зарегистрированы в AsyncContext, возвращенном предыдущим звонком в один из startAsync методов после вызова каждого AsyncListener в onStartAsync
метод.
Последующие вызовы этого метода, или его разновидность нулевого параметра, возвратят тот же самый экземпляр AsyncContext, повторно инициализированный как соответствующий. Если звонок в этот метод будет сопровождаться звонком в его разновидность нулевого параметра, указанное (и возможно обертываться), то запрос и объекты ответа останутся привязанными на возвращенном AsyncContext.
servletRequest
- ServletRequest имел обыкновение инициализировать AsyncContextservletResponse
- ServletResponse имел обыкновение инициализировать AsyncContext IllegalStateException
- если этот запрос в рамках фильтра или сервлета, который не поддерживает асинхронные операции (то есть, isAsyncSupported()
возвращает false), или если этот метод вызывают снова ни с кем асинхронным, диспетчеризируют (следующий из одного из AsyncContext#dispatch
методы), вызывается вне контекста любого такого диспетчеризировать, или вызывается снова в рамках того же самого, диспетчеризируют, или если ответ был уже закрытboolean isAsyncStarted()
ServletRequest помещается в асинхронный режим, вызывая startAsync()
или startAsync(ServletRequest,ServletResponse)
на этом.
Этот метод возвращает false, если этот запрос был помещен в асинхронный режим, но был с тех пор диспетчеризирован, используя один из AsyncContext#dispatch
методы или выпущенный от асинхронного режима через звонок AsyncContext#complete
.
boolean isAsyncSupported()
Асинхронная работа отключается для этого запроса, если этот запрос в рамках фильтра или сервлета, который не был аннотирован или отмечен в дескрипторе развертывания как возможность поддерживать асинхронную обработку.
AsyncContext getAsyncContext()
startAsync()
или startAsync(ServletRequest,ServletResponse)
по этому запросу.
startAsync()
или startAsync(ServletRequest,ServletResponse)
по этому запросу IllegalStateException
- если этот запрос не был помещен в асинхронный режим, то есть, если ни один startAsync()
ни startAsync(ServletRequest,ServletResponse)
был вызванDispatcherType getDispatcherType()
Тип диспетчера запроса используется контейнером, чтобы выбрать фильтры, которые должны быть применены к запросу: Только фильтры с соответствием типа диспетчера и образцов url будут применены.
Разрешение фильтра, который был сконфигурирован для многократных типов диспетчера, чтобы запросить запрос на его тип диспетчера, позволяет фильтру обрабатывать запрос по-другому в зависимости от его типа диспетчера.
Начальный тип диспетчера запроса определяется как DispatcherType.REQUEST
. Тип диспетчера запроса, диспетчеризированного через RequestDispatcher#forward(ServletRequest, ServletResponse)
или RequestDispatcher#include(ServletRequest, ServletResponse)
дается как DispatcherType.FORWARD
или DispatcherType.INCLUDE
, соответственно, в то время как тип диспетчера асинхронного запроса, диспетчеризированного через один из AsyncContext#dispatch
методы даются как DispatcherType.ASYNC
. Наконец, тип диспетчера запроса, диспетчеризированного ошибочной странице механизмом обработки ошибок контейнера, дается как DispatcherType.ERROR
.
DispatcherType
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС | ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ | ||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается
Сгенерированный на 10-February-2011 12:41