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

javax.servlet.http
Класс HttpServletRequestWrapper

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper

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

HttpServletRequest, ServletRequest

public class HttpServletRequestWrapper
расширяет ServletRequestWrapper
реализации HttpServletRequest

Обеспечивает удобную реализацию интерфейса HttpServletRequest, который может быть разделен на подклассы разработчиками, желающими адаптировать запрос к Сервлету.

Этот class реализует Обертку или Шаблон "декоратор". Значение по умолчанию методов к вызову через к обернутому объекту запроса.

С тех пор:

Сервлет 2.3

См. Также:

HttpServletRequest

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

Поля, наследованные от интерфейса javax.servlet.http. HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

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

HttpServletRequestWrapper(HttpServletRequest request)
Создает объект запроса обертывание данного запроса.

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

boolean	authenticate(HttpServletResponse response) Поведение значения по умолчанию этого метода должно вызвать, аутентифицируют на обернутом объекте запроса.
java.lang.String	getAuthType() Поведение значения по умолчанию этого метода должно возвратить getAuthType () на обернутом объекте запроса.
java.lang.String	getContextPath() Поведение значения по умолчанию этого метода должно возвратить getContextPath () на обернутом объекте запроса.
Cookie[]	getCookies() Поведение значения по умолчанию этого метода должно возвратить getCookies () на обернутом объекте запроса.
long	getDateHeader(java.lang.String name) Поведение значения по умолчанию этого метода должно возвратить getDateHeader (Имя строки) на обернутом объекте запроса.
java.lang.String	getHeader(java.lang.String name) Поведение значения по умолчанию этого метода должно возвратить getHeader (Имя строки) на обернутом объекте запроса.
java.util.Enumeration<java.lang.String>	getHeaderNames() Поведение значения по умолчанию этого метода должно возвратить getHeaderNames () на обернутом объекте запроса.
java.util.Enumeration<java.lang.String>	getHeaders(java.lang.String name) Поведение значения по умолчанию этого метода должно возвратить getHeaders (Имя строки) на обернутом объекте запроса.
int	getIntHeader(java.lang.String name) Поведение значения по умолчанию этого метода должно возвратить getIntHeader (Имя строки) на обернутом объекте запроса.
java.lang.String	getMethod() Поведение значения по умолчанию этого метода должно возвратить getMethod () на обернутом объекте запроса.
Часть	getPart(java.lang.String name) Поведение значения по умолчанию этого метода должно вызвать getPart на обернутом объекте запроса.
java.util.Collection<Part>	getParts() Поведение значения по умолчанию этого метода должно вызвать getParts на обернутом объекте запроса.
java.lang.String	getPathInfo() Поведение значения по умолчанию этого метода должно возвратить getPathInfo () на обернутом объекте запроса.
java.lang.String	getPathTranslated() Поведение значения по умолчанию этого метода должно возвратить getPathTranslated () на обернутом объекте запроса.
java.lang.String	getQueryString() Поведение значения по умолчанию этого метода должно возвратить getQueryString () на обернутом объекте запроса.
java.lang.String	getRemoteUser() Поведение значения по умолчанию этого метода должно возвратить getRemoteUser () на обернутом объекте запроса.
java.lang.String	getRequestedSessionId() Поведение значения по умолчанию этого метода должно возвратить getRequestedSessionId () на обернутом объекте запроса.
java.lang.String	getRequestURI() Поведение значения по умолчанию этого метода должно возвратить getRequestURI () на обернутом объекте запроса.
java.lang.StringBuffer	getRequestURL() Поведение значения по умолчанию этого метода должно возвратить getRequestURL () на обернутом объекте запроса.
java.lang.String	getServletPath() Поведение значения по умолчанию этого метода должно возвратить getServletPath () на обернутом объекте запроса.
HttpSession	getSession() Поведение значения по умолчанию этого метода должно возвратить getSession () на обернутом объекте запроса.
HttpSession	getSession(boolean create) Поведение значения по умолчанию этого метода должно возвратиться, getSession (булев создают) на обернутом объекте запроса.
java.security.Principal	getUserPrincipal() Поведение значения по умолчанию этого метода должно возвратить getUserPrincipal () на обернутом объекте запроса.
boolean	isRequestedSessionIdFromCookie() Поведение значения по умолчанию этого метода должно возвратить isRequestedSessionIdFromCookie () на обернутом объекте запроса.
boolean	isRequestedSessionIdFromUrl() Поведение значения по умолчанию этого метода должно возвратить isRequestedSessionIdFromUrl () на обернутом объекте запроса.
boolean	isRequestedSessionIdFromURL() Поведение значения по умолчанию этого метода должно возвратить isRequestedSessionIdFromURL () на обернутом объекте запроса.
boolean	isRequestedSessionIdValid() Поведение значения по умолчанию этого метода должно возвратить isRequestedSessionIdValid () на обернутом объекте запроса.
boolean	isUserInRole(java.lang.String role) Поведение значения по умолчанию этого метода должно возвратить isUserInRole (Строковая роль) на обернутом объекте запроса.
void	login(java.lang.String username, java.lang.String password) Поведение значения по умолчанию этого метода должно вызвать вход в систему на обернутом объекте запроса.
void	logout() Поведение значения по умолчанию этого метода должно вызвать вход в систему на обернутом объекте запроса.

Методы, наследованные от class javax.servlet. ServletRequestWrapper

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

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

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

Методы, наследованные от интерфейса 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

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

HttpServletRequestWrapper

public HttpServletRequestWrapper(HttpServletRequest request)

Создает объект запроса обертывание данного запроса.

Броски:

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

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

getAuthType

public java.lang.String getAuthType()

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

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

getAuthType в интерфейсе HttpServletRequest

Возвраты:

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

getCookies

public Cookie[] getCookies()

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

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

getCookies в интерфейсе HttpServletRequest

Возвраты:

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

getDateHeader

public long getDateHeader(java.lang.String name)

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

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

getDateHeader в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

getHeader

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

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

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

getHeader в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

getHeaders

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

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

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

getHeaders в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

getHeaderNames

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

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

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

getHeaderNames в интерфейсе HttpServletRequest

Возвраты:

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

getIntHeader

public int getIntHeader(java.lang.String name)

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

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

getIntHeader в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

getMethod

public java.lang.String getMethod()

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

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

getMethod в интерфейсе HttpServletRequest

Возвраты:

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

getPathInfo

public java.lang.String getPathInfo()

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

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

getPathInfo в интерфейсе HttpServletRequest

Возвраты:

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

getPathTranslated

public java.lang.String getPathTranslated()

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

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

getPathTranslated в интерфейсе HttpServletRequest

Возвраты:

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

getContextPath

public java.lang.String getContextPath()

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

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

getContextPath в интерфейсе HttpServletRequest

Возвраты:

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

См. Также:

ServletContext.getContextPath()

getQueryString

public java.lang.String getQueryString()

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

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

getQueryString в интерфейсе HttpServletRequest

Возвраты:

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

getRemoteUser

public java.lang.String getRemoteUser()

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

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

getRemoteUser в интерфейсе HttpServletRequest

Возвраты:

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

isUserInRole

public boolean isUserInRole(java.lang.String role)

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

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

isUserInRole в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

getUserPrincipal

public java.security.Principal getUserPrincipal()

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

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

getUserPrincipal в интерфейсе HttpServletRequest

Возвраты:

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

getRequestedSessionId

public java.lang.String getRequestedSessionId()

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

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

getRequestedSessionId в интерфейсе HttpServletRequest

Возвраты:

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

См. Также:

HttpServletRequest.isRequestedSessionIdValid()

getRequestURI

public java.lang.String getRequestURI()

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

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

getRequestURI в интерфейсе HttpServletRequest

Возвраты:

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

См. Также:

HttpUtils#getRequestURL

getRequestURL

public java.lang.StringBuffer getRequestURL()

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

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

getRequestURL в интерфейсе HttpServletRequest

Возвраты:

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

getServletPath

public java.lang.String getServletPath()

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

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

getServletPath в интерфейсе HttpServletRequest

Возвраты:

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

getSession

public HttpSession getSession(boolean create)

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

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

getSession в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

См. Также:

HttpServletRequest.getSession()

getSession

public HttpSession getSession()

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

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

getSession в интерфейсе HttpServletRequest

Возвраты:

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

См. Также:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

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

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

isRequestedSessionIdValid в интерфейсе HttpServletRequest

Возвраты:

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

См. Также:

HttpServletRequest.getRequestedSessionId(), HttpServletRequest.getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

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

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

isRequestedSessionIdFromCookie в интерфейсе HttpServletRequest

Возвраты:

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

См. Также:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

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

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

isRequestedSessionIdFromURL в интерфейсе HttpServletRequest

Возвраты:

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

См. Также:

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

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

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

isRequestedSessionIdFromUrl в интерфейсе HttpServletRequest

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

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

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

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

authenticate в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

Броски:

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

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

С тех пор:

Сервлет 3.0

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

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

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

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

login в интерфейсе HttpServletRequest

Параметры:

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

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

Броски:

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

С тех пор:

Сервлет 3.0

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

public void logout()
            throws ServletException

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

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

logout в интерфейсе HttpServletRequest

Броски:

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

С тех пор:

Сервлет 3.0

getParts

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

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

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

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

getParts в интерфейсе HttpServletRequest

Возвраты:

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

Броски:

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

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

С тех пор:

Сервлет 3.0

См. Также:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()

getPart

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

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

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

getPart в интерфейсе HttpServletRequest

Параметры:

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

Возвраты:

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

Броски:

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

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

С тех пор:

Сервлет 3.0

См. Также:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()