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

javax.servlet
Класс ServletRequestWrapper

java.lang.Object
  javax.servlet.ServletRequestWrapper

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

ServletRequest

Прямые Известные Подклассы:

HttpServletRequestWrapper

public class ServletRequestWrapper
расширяет java.lang. Объект
реализации ServletRequest

Обеспечивает удобную реализацию интерфейса ServletRequest, который может быть разделен на подклассы разработчиками, желающими адаптировать запрос к Сервлету. Этот class реализует Обертку или Шаблон "декоратор". Значение по умолчанию методов к вызову через к обернутому объекту запроса.

С тех пор:

Сервлет 2.3

См. Также:

ServletRequest

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

ServletRequestWrapper(ServletRequest request)
Создает адаптер ServletRequest, обертывающий данный объект запроса.

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

AsyncContext	getAsyncContext() Получает AsyncContext, который был создан или повторно инициализирован новым вызовом startAsync() или startAsync(ServletRequest,ServletResponse) по обернутому запросу.
java.lang.Object	getAttribute(java.lang.String name) Поведение значения по умолчанию этого метода должно вызвать getAttribute (Имя строки) на обернутом объекте запроса.
java.util.Enumeration<java.lang.String>	getAttributeNames() Поведение значения по умолчанию этого метода должно возвратить getAttributeNames () на обернутом объекте запроса.
java.lang.String	getCharacterEncoding() Поведение значения по умолчанию этого метода должно возвратить getCharacterEncoding () на обернутом объекте запроса.
int	getContentLength() Поведение значения по умолчанию этого метода должно возвратить getContentLength () на обернутом объекте запроса.
java.lang.String	getContentType() Поведение значения по умолчанию этого метода должно возвратить getContentType () на обернутом объекте запроса.
DispatcherType	getDispatcherType() Получает тип диспетчера обернутого запроса.
ServletInputStream	getInputStream() Поведение значения по умолчанию этого метода должно возвратить getInputStream () на обернутом объекте запроса.
java.lang.String	getLocalAddr() Поведение значения по умолчанию этого метода должно возвратить getLocalAddr () на обернутом объекте запроса.
java.util.Locale	getLocale() Поведение значения по умолчанию этого метода должно возвратить getLocale () на обернутом объекте запроса.
java.util.Enumeration<java.util.Locale>	getLocales() Поведение значения по умолчанию этого метода должно возвратить getLocales () на обернутом объекте запроса.
java.lang.String	getLocalName() Поведение значения по умолчанию этого метода должно возвратить getLocalName () на обернутом объекте запроса.
int	getLocalPort() Поведение значения по умолчанию этого метода должно возвратить getLocalPort () на обернутом объекте запроса.
java.lang.String	getParameter(java.lang.String name) Поведение значения по умолчанию этого метода должно возвратить getParameter (Имя строки) на обернутом объекте запроса.
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap() Поведение значения по умолчанию этого метода должно возвратить getParameterMap () на обернутом объекте запроса.
java.util.Enumeration<java.lang.String>	getParameterNames() Поведение значения по умолчанию этого метода должно возвратить getParameterNames () на обернутом объекте запроса.
java.lang.String[]	getParameterValues(java.lang.String name) Поведение значения по умолчанию этого метода должно возвратить getParameterValues (Имя строки) на обернутом объекте запроса.
java.lang.String	getProtocol() Поведение значения по умолчанию этого метода должно возвратить getProtocol () на обернутом объекте запроса.
java.io.BufferedReader	getReader() Поведение значения по умолчанию этого метода должно возвратить getReader () на обернутом объекте запроса.
java.lang.String	getRealPath(java.lang.String path) Осуждаемый. С Версии 2.1 API Сервлета Java использовать ServletContext#getRealPath вместо этого
java.lang.String	getRemoteAddr() Поведение значения по умолчанию этого метода должно возвратить getRemoteAddr () на обернутом объекте запроса.
java.lang.String	getRemoteHost() Поведение значения по умолчанию этого метода должно возвратить getRemoteHost () на обернутом объекте запроса.
int	getRemotePort() Поведение значения по умолчанию этого метода должно возвратить getRemotePort () на обернутом объекте запроса.
ServletRequest	getRequest() Возвратите обернутый объект запроса.
RequestDispatcher	getRequestDispatcher(java.lang.String path) Поведение значения по умолчанию этого метода должно возвратить getRequestDispatcher (Строковый путь) на обернутом объекте запроса.
java.lang.String	getScheme() Поведение значения по умолчанию этого метода должно возвратить getScheme () на обернутом объекте запроса.
java.lang.String	getServerName() Поведение значения по умолчанию этого метода должно возвратить getServerName () на обернутом объекте запроса.
int	getServerPort() Поведение значения по умолчанию этого метода должно возвратить getServerPort () на обернутом объекте запроса.
ServletContext	getServletContext() Получает контекст сервлета, к которому обернутый запрос сервлета был последний диспетчеризированный.
boolean	isAsyncStarted() Проверки, если обернутый запрос был помещен в асинхронный режим.
boolean	isAsyncSupported() Проверки, если обернутый запрос поддерживает асинхронную работу.
boolean	isSecure() Поведение значения по умолчанию этого метода должно возвратить isSecure () на обернутом объекте запроса.
boolean	isWrapperFor(java.lang.Class wrappedType) Проверки (рекурсивно), если этот ServletRequestWrapper обертывает a ServletRequest из данного типа class.
boolean	isWrapperFor(ServletRequest wrapped) Проверки (рекурсивно), если этот ServletRequestWrapper обертывает данный ServletRequest экземпляр.
void	removeAttribute(java.lang.String name) Поведение значения по умолчанию этого метода должно вызвать removeAttribute (Имя строки) на обернутом объекте запроса.
void	setAttribute(java.lang.String name, java.lang.Object o) Поведение значения по умолчанию этого метода должно возвратить setAttribute (Имя строки, Объект o) на обернутом объекте запроса.
void	setCharacterEncoding(java.lang.String enc) Поведение значения по умолчанию этого метода должно установить кодировку символов на обернутом объекте запроса.
void	setRequest(ServletRequest request) Устанавливает обертываемый объект запроса.
AsyncContext	startAsync() Поведение значения по умолчанию этого метода должно вызвать ServletRequest#startAsync на обернутом объекте запроса.
AsyncContext	startAsync(ServletRequest servletRequest, ServletResponse servletResponse) Поведение значения по умолчанию этого метода должно вызвать ServletRequest#startAsync(ServletRequest, ServletResponse) на обернутом объекте запроса.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

ServletRequestWrapper

public ServletRequestWrapper(ServletRequest request)

Создает адаптер ServletRequest, обертывающий данный объект запроса.

Броски:

java.lang.IllegalArgumentException - если запрос является нулем

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

getRequest

public ServletRequest getRequest()

Возвратите обернутый объект запроса.

setRequest

public void setRequest(ServletRequest request)

Устанавливает обертываемый объект запроса.

Броски:

java.lang.IllegalArgumentException - если запрос является нулем.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Поведение значения по умолчанию этого метода должно вызвать getAttribute (Имя строки) на обернутом объекте запроса.

Определенный:

getAttribute в интерфейсе ServletRequest

Параметры:

name - a String определение имени атрибута

Возвраты:

Object содержа значение атрибута, или null если атрибут не существует

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Поведение значения по умолчанию этого метода должно возвратить getAttributeNames () на обернутом объекте запроса.

Определенный:

getAttributeNames в интерфейсе ServletRequest

Возвраты:

Enumeration из строк, содержащих имена атрибутов запроса

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Поведение значения по умолчанию этого метода должно возвратить getCharacterEncoding () на обернутом объекте запроса.

Определенный:

getCharacterEncoding в интерфейсе ServletRequest

Возвраты:

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

setCharacterEncoding

public void setCharacterEncoding(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException

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

Определенный:

setCharacterEncoding в интерфейсе ServletRequest

Параметры:

enc - String содержа имя кодировки символов.

Броски:

java.io.UnsupportedEncodingException - если этот ServletRequest находится все еще в состоянии, где кодировка символов может быть установлена, но указанное кодирование недопустимо

getContentLength

public int getContentLength()

Поведение значения по умолчанию этого метода должно возвратить getContentLength () на обернутом объекте запроса.

Определенный:

getContentLength в интерфейсе ServletRequest

Возвраты:

целое число, содержащее длину тела запроса или-1, если длина не известна

getContentType

public java.lang.String getContentType()

Поведение значения по умолчанию этого метода должно возвратить getContentType () на обернутом объекте запроса.

Определенный:

getContentType в интерфейсе ServletRequest

Возвраты:

a String содержа имя типа MIME запроса, или нуль, если тип не известен

getInputStream

public ServletInputStream getInputStream()
                                  throws java.io.IOException

Поведение значения по умолчанию этого метода должно возвратить getInputStream () на обернутом объекте запроса.

Определенный:

getInputStream в интерфейсе ServletRequest

Возвраты:

a ServletInputStream объект, содержащий тело запроса

Броски:

java.io.IOException - если исключение ввода или вывода произошло

getParameter

public java.lang.String getParameter(java.lang.String name)

Поведение значения по умолчанию этого метода должно возвратить getParameter (Имя строки) на обернутом объекте запроса.

Определенный:

getParameter в интерфейсе ServletRequest

Параметры:

name - a String определение имени параметра

Возвраты:

a String представление единственного значения параметра

См. Также:

ServletRequest.getParameterValues(java.lang.String)

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Поведение значения по умолчанию этого метода должно возвратить getParameterMap () на обернутом объекте запроса.

Определенный:

getParameterMap в интерфейсе ServletRequest

Возвраты:

неизменный java.util. Карта, содержащая названия параметра как ключи и параметр, оценивает как значения карты. Ключи в карте параметра имеют Строку типа. Значения в карте параметра имеют Строковый массив типа.

getParameterNames

public java.util.Enumeration<java.lang.String> getParameterNames()

Поведение значения по умолчанию этого метода должно возвратить getParameterNames () на обернутом объекте запроса.

Определенный:

getParameterNames в интерфейсе ServletRequest

Возвраты:

Enumeration из String объекты, каждый String содержа имя параметра запроса; или пустое Enumeration если у запроса нет никаких параметров

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Поведение значения по умолчанию этого метода должно возвратить getParameterValues (Имя строки) на обернутом объекте запроса.

Определенный:

getParameterValues в интерфейсе ServletRequest

Параметры:

name - a String содержа имя параметра, значение которого требуют

Возвраты:

массив String объекты, содержащие значения параметра

См. Также:

ServletRequest.getParameter(java.lang.String)

getProtocol

public java.lang.String getProtocol()

Поведение значения по умолчанию этого метода должно возвратить getProtocol () на обернутом объекте запроса.

Определенный:

getProtocol в интерфейсе ServletRequest

Возвраты:

a String содержа имя протокола и номер версии

getScheme

public java.lang.String getScheme()

Поведение значения по умолчанию этого метода должно возвратить getScheme () на обернутом объекте запроса.

Определенный:

getScheme в интерфейсе ServletRequest

Возвраты:

a String содержа имя схемы, используемой, чтобы обратиться с этой просьбой

getServerName

public java.lang.String getServerName()

Поведение значения по умолчанию этого метода должно возвратить getServerName () на обернутом объекте запроса.

Определенный:

getServerName в интерфейсе ServletRequest

Возвраты:

a String содержа имя сервера

getServerPort

public int getServerPort()

Поведение значения по умолчанию этого метода должно возвратить getServerPort () на обернутом объекте запроса.

Определенный:

getServerPort в интерфейсе ServletRequest

Возвраты:

целое число, определяющее номер порта

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Поведение значения по умолчанию этого метода должно возвратить getReader () на обернутом объекте запроса.

Определенный:

getReader в интерфейсе ServletRequest

Возвраты:

a BufferedReader содержа тело запроса

Броски:

java.io.UnsupportedEncodingException - если используемое кодирование набора символов не поддерживается, и текст не может декодироваться

java.io.IOException - если исключение ввода или вывода произошло

См. Также:

ServletRequest.getInputStream()

getRemoteAddr

public java.lang.String getRemoteAddr()

Поведение значения по умолчанию этого метода должно возвратить getRemoteAddr () на обернутом объекте запроса.

Определенный:

getRemoteAddr в интерфейсе ServletRequest

Возвраты:

a String содержа IP-адрес клиента, который отправил запрос

getRemoteHost

public java.lang.String getRemoteHost()

Поведение значения по умолчанию этого метода должно возвратить getRemoteHost () на обернутом объекте запроса.

Определенный:

getRemoteHost в интерфейсе ServletRequest

Возвраты:

a String содержа полностью определенное имя клиента

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object o)

Поведение значения по умолчанию этого метода должно возвратить setAttribute (Имя строки, Объект o) на обернутом объекте запроса.

Определенный:

setAttribute в интерфейсе ServletRequest

Параметры:

name - a String определение имени атрибута

o - Object быть сохраненным

removeAttribute

public void removeAttribute(java.lang.String name)

Поведение значения по умолчанию этого метода должно вызвать removeAttribute (Имя строки) на обернутом объекте запроса.

Определенный:

removeAttribute в интерфейсе ServletRequest

Параметры:

name - a String определение имени атрибута, чтобы удалить

getLocale

public java.util.Locale getLocale()

Поведение значения по умолчанию этого метода должно возвратить getLocale () на обернутом объекте запроса.

Определенный:

getLocale в интерфейсе ServletRequest

Возвраты:

привилегированное Locale для клиента

getLocales

public java.util.Enumeration<java.util.Locale> getLocales()

Поведение значения по умолчанию этого метода должно возвратить getLocales () на обернутом объекте запроса.

Определенный:

getLocales в интерфейсе ServletRequest

Возвраты:

Enumeration из привилегированных Locale объекты для клиента

isSecure

public boolean isSecure()

Поведение значения по умолчанию этого метода должно возвратить isSecure () на обернутом объекте запроса.

Определенный:

isSecure в интерфейсе ServletRequest

Возвраты:

булево указание, если с просьбой обратились, используя безопасный канал

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String path)

Поведение значения по умолчанию этого метода должно возвратить getRequestDispatcher (Строковый путь) на обернутом объекте запроса.

Определенный:

getRequestDispatcher в интерфейсе ServletRequest

Параметры:

path - a String определение пути к ресурсу. Если это относительно, это должно быть относительно против текущего сервлета.

Возвраты:

a RequestDispatcher возразите что действия как обертка для ресурса в указанном пути, или null если контейнер сервлета не может возвратить a RequestDispatcher

См. Также:

RequestDispatcher, ServletContext#getRequestDispatcher

getRealPath

public java.lang.String getRealPath(java.lang.String path)

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

Поведение значения по умолчанию этого метода должно возвратить getRealPath (Строковый путь) на обернутом объекте запроса.

Определенный:

getRealPath в интерфейсе ServletRequest

getRemotePort

public int getRemotePort()

Поведение значения по умолчанию этого метода должно возвратить getRemotePort () на обернутом объекте запроса.

Определенный:

getRemotePort в интерфейсе ServletRequest

Возвраты:

целое число, определяющее номер порта

С тех пор:

Сервлет 2.4

getLocalName

public java.lang.String getLocalName()

Поведение значения по умолчанию этого метода должно возвратить getLocalName () на обернутом объекте запроса.

Определенный:

getLocalName в интерфейсе ServletRequest

Возвраты:

a String содержа имя хоста IP, на котором был получен запрос.

С тех пор:

Сервлет 2.4

getLocalAddr

public java.lang.String getLocalAddr()

Поведение значения по умолчанию этого метода должно возвратить getLocalAddr () на обернутом объекте запроса.

Определенный:

getLocalAddr в интерфейсе ServletRequest

Возвраты:

a String содержа IP-адрес, на котором был получен запрос.

С тех пор:

Сервлет 2.4

getLocalPort

public int getLocalPort()

Поведение значения по умолчанию этого метода должно возвратить getLocalPort () на обернутом объекте запроса.

Определенный:

getLocalPort в интерфейсе ServletRequest

Возвраты:

целое число, определяющее номер порта

С тех пор:

Сервлет 2.4

getServletContext

public ServletContext getServletContext()

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

Определенный:

getServletContext в интерфейсе ServletRequest

Возвраты:

контекст сервлета, к которому обернутый запрос сервлета был последний диспетчеризированный

С тех пор:

Сервлет 3.0

startAsync

public AsyncContext startAsync()
                        throws java.lang.IllegalStateException

Поведение значения по умолчанию этого метода должно вызвать ServletRequest#startAsync на обернутом объекте запроса.

Определенный:

startAsync в интерфейсе ServletRequest

Возвраты:

(ре) инициализированный AsyncContext

Броски:

IllegalStateException - если запрос в рамках фильтра или сервлета, который не поддерживает асинхронные операции (то есть, isAsyncSupported() возвращает false), или если этот метод вызывают снова ни с кем асинхронным, диспетчеризируют (следующий из одного из AsyncContext#dispatch методы), вызывается вне контекста любого такого диспетчеризировать, или вызывается снова в рамках того же самого, диспетчеризируют, или если ответ был уже закрыт

С тех пор:

Сервлет 3.0

См. Также:

ServletRequest#startAsync

startAsync

public AsyncContext startAsync(ServletRequest servletRequest,
                               ServletResponse servletResponse)
                        throws java.lang.IllegalStateException

Поведение значения по умолчанию этого метода должно вызвать ServletRequest#startAsync(ServletRequest, ServletResponse) на обернутом объекте запроса.

Определенный:

startAsync в интерфейсе ServletRequest

Параметры:

servletRequest - ServletRequest имел обыкновение инициализировать AsyncContext

servletResponse - ServletResponse имел обыкновение инициализировать AsyncContext

Возвраты:

(ре) инициализированный AsyncContext

Броски:

IllegalStateException - если запрос в рамках фильтра или сервлета, который не поддерживает асинхронные операции (то есть, isAsyncSupported() возвращает false), или если этот метод вызывают снова ни с кем асинхронным, диспетчеризируют (следующий из одного из AsyncContext#dispatch методы), вызывается вне контекста любого такого диспетчеризировать, или вызывается снова в рамках того же самого, диспетчеризируют, или если ответ был уже закрыт

С тех пор:

Сервлет 3.0

См. Также:

ServletRequest#startAsync(ServletRequest, ServletResponse)

isAsyncStarted

public boolean isAsyncStarted()

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

Определенный:

isAsyncStarted в интерфейсе ServletRequest

Возвраты:

истина, если этот запрос был помещен в асинхронный режим, ложь иначе

С тех пор:

Сервлет 3.0

См. Также:

ServletRequest#isAsyncStarted

isAsyncSupported

public boolean isAsyncSupported()

Проверки, если обернутый запрос поддерживает асинхронную работу.

Определенный:

isAsyncSupported в интерфейсе ServletRequest

Возвраты:

истина, если этот запрос поддерживает асинхронную работу, ложь иначе

С тех пор:

Сервлет 3.0

См. Также:

ServletRequest#isAsyncSupported

getAsyncContext

public AsyncContext getAsyncContext()

Получает AsyncContext, который был создан или повторно инициализирован новым вызовом startAsync() или startAsync(ServletRequest,ServletResponse) по обернутому запросу.

Определенный:

getAsyncContext в интерфейсе ServletRequest

Возвраты:

AsyncContext, который был создан или повторно инициализирован новым вызовом startAsync() или startAsync(ServletRequest,ServletResponse) по обернутому запросу

Броски:

IllegalStateException - если этот запрос не был помещен в асинхронный режим, то есть, если ни один startAsync() ни startAsync(ServletRequest,ServletResponse) был вызван

С тех пор:

Сервлет 3.0

См. Также:

ServletRequest#getAsyncContext

isWrapperFor

public boolean isWrapperFor(ServletRequest wrapped)

Проверки (рекурсивно), если этот ServletRequestWrapper обертывает данный ServletRequest экземпляр.

Параметры:

wrapped - экземпляр ServletRequest, чтобы искать

Возвраты:

истина, если этот ServletRequestWrapper обертывает приведенный пример ServletRequest, ложь иначе

С тех пор:

Сервлет 3.0

isWrapperFor

public boolean isWrapperFor(java.lang.Class wrappedType)

Проверки (рекурсивно), если этот ServletRequestWrapper обертывает a ServletRequest из данного типа class.

Параметры:

wrappedType - ServletRequest тип class, чтобы искать

Возвраты:

истина, если этот ServletRequestWrapper обертывает ServletRequest данного типа class, ложь иначе

Броски:

IllegalArgumentException - если данный class не реализует ServletRequest

С тех пор:

Сервлет 3.0

getDispatcherType

public DispatcherType getDispatcherType()

Получает тип диспетчера обернутого запроса.

Определенный:

getDispatcherType в интерфейсе ServletRequest

Возвраты:

тип диспетчера обернутого запроса

С тех пор:

Сервлет 3.0

См. Также:

ServletRequest#getDispatcherType