Spec-Zone .ru
спецификации, руководства, описания, API
|
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС |
ФРЕЙМЫ |
||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
public interface HttpServletResponse
Расширяется ServletResponse
интерфейс, чтобы обеспечить специфичную для HTTP функциональность в отправке ответа. Например, у этого есть методы, чтобы получить доступ к HTTP-заголовкам и cookie.
Контейнер сервлета создает HttpServletResponse
объект и передачи это как параметр методам службы сервлета (doGet
, doPost
, и т.д.).
ServletResponse
Полевая Сводка | |
---|---|
static int |
SC_ACCEPTED
Код состояния (202), указывающий, что запрос был принят для того, чтобы обработать, но не был завершен. |
static int |
SC_BAD_GATEWAY
Код состояния (502), указывающий, что сервер HTTP, полученный недопустимый ответ от сервера, это консультировалось, действуя как прокси или шлюз. |
static int |
SC_BAD_REQUEST
Код состояния (400), указывающий на запрос, отправленный клиентом, был синтаксически неправильным. |
static int |
SC_CONFLICT
Код состояния (409), указывающий, что запрос не мог быть завершен из-за конфликта с текущим состоянием ресурса. |
static int |
SC_CONTINUE
Код состояния (100), указывающий на клиент, может продолжаться. |
static int |
SC_CREATED
Код состояния (201), указывающий на запрос, следовал и создал новый ресурс на сервере. |
static int |
SC_EXPECTATION_FAILED
Код состояния (417), указывающий, что сервер не мог оправдать надежду, поданную Ожидать заголовок запроса. |
static int |
SC_FORBIDDEN
Код состояния (403), указывающий на сервер, понятый запрос, но, отказался выполнить это. |
static int |
SC_FOUND
Код состояния (302), указывающий, что ресурс находится временно под различным URI. |
static int |
SC_GATEWAY_TIMEOUT
Код состояния (504), указывающий, что сервер не получал своевременный ответ от вышестоящего сервера, действуя как шлюз или прокси. |
static int |
SC_GONE
Код состояния (410), указывающий, что ресурс больше не доступен в сервере и никаком адресе для пересылки, известен. |
static int |
SC_HTTP_VERSION_NOT_SUPPORTED
Код состояния (505), указывающий, что сервер не поддерживает или отказывается поддерживать версию протокола HTTP, которая использовалась в сообщении запроса. |
static int |
SC_INTERNAL_SERVER_ERROR
Код состояния (500), указывающий на ошибку в сервере HTTP, который препятствовал тому, чтобы это выполнило запрос. |
static int |
SC_LENGTH_REQUIRED
Код состояния (411), указывающий, что запрос не может быть обработан без определенного Content-Length . |
static int |
SC_METHOD_NOT_ALLOWED
Код состояния (405), указывающий, что метод, определенный в Request-Line не позволяется для ресурса, идентифицированного Request-URI . |
static int |
SC_MOVED_PERMANENTLY
Код состояния (301), указывающий, что ресурс постоянно переместился в новое расположение, и что будущие ссылки должны использовать новый URI со своими запросами. |
static int |
SC_MOVED_TEMPORARILY
Код состояния (302), указывающий, что ресурс временно переместился в другое расположение, но что будущие ссылки должны все еще использовать исходный URI, чтобы получить доступ к ресурсу. |
static int |
SC_MULTIPLE_CHOICES
Код состояния (300), указывающий, что требуемый ресурс соответствует любому из ряда представлений, каждого с его собственным определенным расположением. |
static int |
SC_NO_CONTENT
Код состояния (204), указывающий, что запрос успешно выполнялся, но что не было никакой новой информации, чтобы возвратиться. |
static int |
SC_NON_AUTHORITATIVE_INFORMATION
Код состояния (203), указывающий, что метаинформация, представленная клиентом, не происходила из сервера. |
static int |
SC_NOT_ACCEPTABLE
Код состояния (406), указывающий, что ресурс, идентифицированный запросом, только способен к генерированию объектов ответа, у которых есть характеристики контента, не приемлемые согласно принять заголовкам, отправленным в запросе. |
static int |
SC_NOT_FOUND
Код состояния (404), указывающий, что требуемый ресурс не доступен. |
static int |
SC_NOT_IMPLEMENTED
Код состояния (501), указывающий на сервер HTTP, не поддерживает функциональность, должен был выполнить запрос. |
static int |
SC_NOT_MODIFIED
Код состояния (304), указывающий, что условное выражение НАШЛО работу, что ресурс был доступен и не измененный. |
static int |
SC_OK
Код состояния (200), указывающий на запрос обычно, успешно выполнялся. |
static int |
SC_PARTIAL_CONTENT
Код состояния (206), указывающий, что сервер выполнил частичное, ПОЛУЧАЕТ запрос на ресурс. |
static int |
SC_PAYMENT_REQUIRED
Код состояния (402) зарезервирован для будущего использования. |
static int |
SC_PRECONDITION_FAILED
Код состояния (412), указывающий, что предварительное условие, данное в один или больше полей заголовка запроса, оцененных ко лжи, когда это было протестировано на сервере. |
static int |
SC_PROXY_AUTHENTICATION_REQUIRED
Код состояния (407), указывающий, что клиент ДОЛЖЕН сначала аутентифицировать себя с прокси. |
static int |
SC_REQUEST_ENTITY_TOO_LARGE
Код состояния (413), указывающий, что сервер отказывается обработать запрос, потому что объект запроса больше чем сервер, желает или в состоянии обработать. |
static int |
SC_REQUEST_TIMEOUT
Код состояния (408), указывающий, что клиент не производил запрос в пределах времени, когда сервер был подготовлен ожидать. |
static int |
SC_REQUEST_URI_TOO_LONG
Код состояния (414), указывающий, что сервер отказывается обслужить запрос потому что Request-URI более длинно, чем сервер готов интерпретировать. |
static int |
SC_REQUESTED_RANGE_NOT_SATISFIABLE
Код состояния (416), указывающий, что сервер не может служить требуемому диапазону байта. |
static int |
SC_RESET_CONTENT
Код состояния (205), указывающий, что агент ДОЛЖЕН сбросить представление документа, которое заставило запрос быть отправленным. |
static int |
SC_SEE_OTHER
Код состояния (303), указывающий, что ответ на запрос может быть найден под различным URI. |
static int |
SC_SERVICE_UNAVAILABLE
Код состояния (503), указывающий, что сервер HTTP временно перегружается, и неспособный обработать запрос. |
static int |
SC_SWITCHING_PROTOCOLS
Код состояния (101), указывающий на сервер, переключает протоколы согласно заголовку Обновления. |
static int |
SC_TEMPORARY_REDIRECT
Код состояния (307), указывающий, что требуемый ресурс находится временно под различным URI. |
static int |
SC_UNAUTHORIZED
Код состояния (401), указывающий, что запрос требует аутентификации HTTP. |
static int |
SC_UNSUPPORTED_MEDIA_TYPE
Код состояния (415), указывающий, что сервер отказывается обслужить запрос, потому что объект запроса находится в формате, не поддерживаемом требуемым ресурсом для требуемого метода. |
static int |
SC_USE_PROXY
Код состояния (305), указывающий, что к требуемому ресурсу НУЖНО получить доступ через прокси, данный Location поле. |
Сводка метода | |
---|---|
void |
addCookie(Cookie cookie)
Добавляет указанный cookie к ответу. |
void |
addDateHeader(java.lang.String name, long date)
Добавляет заголовок ответа с именем и значением даты. |
void |
addHeader(java.lang.String name, java.lang.String value)
Добавляет заголовок ответа с именем и значением. |
void |
addIntHeader(java.lang.String name, int value)
Добавляет заголовок ответа с именем и целочисленным значением. |
boolean |
containsHeader(java.lang.String name)
Возвращает булево указание, был ли именованный заголовок ответа уже установлен. |
java.lang.String |
encodeRedirectUrl(java.lang.String url)
Осуждаемый. С версии 2.1 используйте encodeRedirectURL (Строковый url) вместо этого |
java.lang.String |
encodeRedirectURL(java.lang.String url)
Кодирует указанный URL для использования в sendRedirect метод или, если кодирование не необходимо, возвращает неизменный URL. |
java.lang.String |
encodeUrl(java.lang.String url)
Осуждаемый. С версии 2.1 используйте encodeURL (Строковый url) вместо этого |
java.lang.String |
encodeURL(java.lang.String url)
Кодирует указанный URL включением ID сеанса в этом, или, если кодирование не необходимо, возвращает неизменный URL. |
java.lang.String |
getHeader(java.lang.String name)
Получает значение заголовка ответа с именем. |
java.util.Collection<java.lang.String> |
getHeaderNames()
Получает имена заголовков этого ответа. |
java.util.Collection<java.lang.String> |
getHeaders(java.lang.String name)
Получает значения заголовка ответа с именем. |
int |
getStatus()
Получает код текущего статуса этого ответа. |
void |
sendError(int sc)
Отправляет ошибочный ответ клиенту, использующему указанный код состояния, и очищает буфер. |
void |
sendError(int sc, java.lang.String msg)
Отправляет ошибочный ответ клиенту, использующему указанное состояние, и очищает буфер. |
void |
sendRedirect(java.lang.String location)
Отправляет временный ответ перенаправления клиенту, использующему указанное расположение перенаправления URL, и очищает буфер. |
void |
setDateHeader(java.lang.String name, long date)
Устанавливает заголовок ответа с именем и значением даты. |
void |
setHeader(java.lang.String name, java.lang.String value)
Устанавливает заголовок ответа с именем и значением. |
void |
setIntHeader(java.lang.String name, int value)
Устанавливает заголовок ответа с именем и целочисленным значением. |
void |
setStatus(int sc)
Устанавливает код состояния для этого ответа. |
void |
setStatus(int sc, java.lang.String sm)
Осуждаемый. С версии 2.1, из-за неоднозначного значения параметра сообщения. Установить использование кода состояния setStatus(int) , отправить ошибку с использованием описания sendError(int, String) . Устанавливает код состояния и сообщение для этого ответа. |
Методы, наследованные от интерфейса javax.servlet. ServletResponse |
---|
flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale |
Полевая Деталь |
---|
static final int SC_CONTINUE
static final int SC_SWITCHING_PROTOCOLS
static final int SC_OK
static final int SC_CREATED
static final int SC_ACCEPTED
static final int SC_NON_AUTHORITATIVE_INFORMATION
static final int SC_NO_CONTENT
static final int SC_RESET_CONTENT
static final int SC_PARTIAL_CONTENT
static final int SC_MULTIPLE_CHOICES
static final int SC_MOVED_PERMANENTLY
static final int SC_MOVED_TEMPORARILY
static final int SC_FOUND
static final int SC_SEE_OTHER
static final int SC_NOT_MODIFIED
static final int SC_USE_PROXY
Location
поле.
static final int SC_TEMPORARY_REDIRECT
Location
поле в ответе.
static final int SC_BAD_REQUEST
static final int SC_UNAUTHORIZED
static final int SC_PAYMENT_REQUIRED
static final int SC_FORBIDDEN
static final int SC_NOT_FOUND
static final int SC_METHOD_NOT_ALLOWED
Request-Line
не позволяется для ресурса, идентифицированного Request-URI
.
static final int SC_NOT_ACCEPTABLE
static final int SC_PROXY_AUTHENTICATION_REQUIRED
static final int SC_REQUEST_TIMEOUT
static final int SC_CONFLICT
static final int SC_GONE
static final int SC_LENGTH_REQUIRED
Content-Length
.
static final int SC_PRECONDITION_FAILED
static final int SC_REQUEST_ENTITY_TOO_LARGE
static final int SC_REQUEST_URI_TOO_LONG
Request-URI
более длинно, чем сервер готов интерпретировать.
static final int SC_UNSUPPORTED_MEDIA_TYPE
static final int SC_REQUESTED_RANGE_NOT_SATISFIABLE
static final int SC_EXPECTATION_FAILED
static final int SC_INTERNAL_SERVER_ERROR
static final int SC_NOT_IMPLEMENTED
static final int SC_BAD_GATEWAY
static final int SC_SERVICE_UNAVAILABLE
static final int SC_GATEWAY_TIMEOUT
static final int SC_HTTP_VERSION_NOT_SUPPORTED
Деталь метода |
---|
void addCookie(Cookie cookie)
cookie
- Cookie, чтобы возвратиться к клиентуboolean containsHeader(java.lang.String name)
name
- имя заголовка true
если именованный заголовок ответа был уже установлен; false
иначеjava.lang.String encodeURL(java.lang.String url)
Для устойчивого отслеживания сеанса все URL, испускаемые сервлетом, должны быть выполнены через этот метод. Иначе, перезапись URL не может использоваться с браузерами, которые не поддерживают cookie.
url
- url, который будет закодирован. java.lang.String encodeRedirectURL(java.lang.String url)
sendRedirect
метод или, если кодирование не необходимо, возвращает неизменный URL. Реализация этого метода включает логику, чтобы определить, должен ли ID сеанса быть закодирован в URL. Поскольку правила для того, чтобы сделать это определение могут отличаться от используемых, чтобы решить, закодировать ли нормальную ссылку, этот метод разделяется от encodeURL
метод. Все URL, отправленные HttpServletResponse.sendRedirect
метод должен быть выполнен через этот метод. Иначе, перезапись URL не может использоваться с браузерами, которые не поддерживают cookie.
url
- url, который будет закодирован. sendRedirect(java.lang.String)
, encodeUrl(java.lang.String)
java.lang.String encodeUrl(java.lang.String url)
url
- url, который будет закодирован. java.lang.String encodeRedirectUrl(java.lang.String url)
url
- url, который будет закодирован. void sendError(int sc, java.lang.String msg) throws java.io.IOException
Если ответ уже фиксировался, этот метод бросает IllegalStateException. После использования этого метода ответ, как должны полагать, фиксируется и не должен быть записан.
sc
- код ошибкиmsg
- дескриптивное сообщение java.io.IOException
- Если исключение ввода или вывода происходит IllegalStateException
- Если ответ фиксировалсяvoid sendError(int sc) throws java.io.IOException
Если ответ уже фиксировался, этот метод бросает IllegalStateException. После использования этого метода ответ, как должны полагать, фиксируется и не должен быть записан.
sc
- код ошибки java.io.IOException
- Если исключение ввода или вывода происходит IllegalStateException
- Если ответ фиксировался перед этим вызовом методаvoid sendRedirect(java.lang.String location) throws java.io.IOException
SC_FOUND
302 (Найденный). Этот метод может принять относительные URL; контейнер сервлета должен преобразовать относительный URL в абсолютный URL прежде, чем отправить ответ клиенту. Если расположение относительно без продвижения '/', контейнер интерпретирует его как относительно текущего URI запроса. Если расположение относительно с продвижением '/', контейнер интерпретирует его как относительно корня контейнера сервлета. Если ответ уже фиксировался, этот метод бросает IllegalStateException. После использования этого метода ответ, как должны полагать, фиксируется и не должен быть записан.
location
- расположение перенаправления URL java.io.IOException
- Если исключение ввода или вывода происходит IllegalStateException
- Если ответ фиксировался или если частичный URL дается и не может быть преобразован в допустимый URLvoid setDateHeader(java.lang.String name, long date)
containsHeader
метод может использоваться, чтобы протестировать на присутствие заголовка прежде, чем установить его значение.
name
- имя заголовка, чтобы установитьdate
- присвоенное значение датыcontainsHeader(java.lang.String)
, addDateHeader(java.lang.String, long)
void addDateHeader(java.lang.String name, long date)
name
- имя заголовка, чтобы установитьdate
- дополнительное значение датыsetDateHeader(java.lang.String, long)
void setHeader(java.lang.String name, java.lang.String value)
containsHeader
метод может использоваться, чтобы протестировать на присутствие заголовка прежде, чем установить его значение.
name
- имя заголовкаvalue
- значение заголовка, Если это содержит строку октета, это должно быть закодировано согласно RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)containsHeader(java.lang.String)
, addHeader(java.lang.String, java.lang.String)
void addHeader(java.lang.String name, java.lang.String value)
name
- имя заголовкаvalue
- дополнительный заголовок оценивает, Если он содержит строку октета, он должен быть закодирован согласно RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt)setHeader(java.lang.String, java.lang.String)
void setIntHeader(java.lang.String name, int value)
containsHeader
метод может использоваться, чтобы протестировать на присутствие заголовка прежде, чем установить его значение.
name
- имя заголовкаvalue
- присвоенное целочисленное значениеcontainsHeader(java.lang.String)
, addIntHeader(java.lang.String, int)
void addIntHeader(java.lang.String name, int value)
name
- имя заголовкаvalue
- присвоенное целочисленное значениеsetIntHeader(java.lang.String, int)
void setStatus(int sc)
Этот метод используется, чтобы установить код статуса возврата, когда нет никакой ошибки (например для SC_OK или кодов состояния SC_MOVED_TEMPORARILY).
Если этот метод будет использоваться, чтобы установить код ошибки, то ошибочный механизм страницы контейнера не будет инициирован. Если есть ошибка, и вызывающая сторона хочет вызвать ошибочную страницу, определенную в веб-приложении, то sendError(int, java.lang.String)
должен использоваться вместо этого.
Этот метод сохраняет любые cookie и другие заголовки ответа.
Допустимые коды состояния - те в 2XX, 3XX, 4XX, и 5XX диапазоны. Другие коды состояния обрабатываются как определенный контейнер.
sc
- код состоянияsendError(int, java.lang.String)
void setStatus(int sc, java.lang.String sm)
setStatus(int)
, отправить ошибку с использованием описания sendError(int, String)
. Устанавливает код состояния и сообщение для этого ответа.
sc
- код состоянияsm
- сообщение о состоянииint getStatus()
java.lang.String getHeader(java.lang.String name)
Если заголовок ответа с именем будет существовать и будет содержать многократные значения, то значение, которое было добавлено сначала, будет возвращено.
Этот метод рассматривает только набор заголовков ответа или добавил через setHeader(java.lang.String, java.lang.String)
, addHeader(java.lang.String, java.lang.String)
, setDateHeader(java.lang.String, long)
, addDateHeader(java.lang.String, long)
, setIntHeader(java.lang.String, int)
, или addIntHeader(java.lang.String, int)
, соответственно.
name
- имя заголовка ответа, чье значение, чтобы возвратиться java.util.Collection<java.lang.String> getHeaders(java.lang.String name)
Этот метод рассматривает только набор заголовков ответа или добавил через setHeader(java.lang.String, java.lang.String)
, addHeader(java.lang.String, java.lang.String)
, setDateHeader(java.lang.String, long)
, addDateHeader(java.lang.String, long)
, setIntHeader(java.lang.String, int)
, или addIntHeader(java.lang.String, int)
, соответственно.
Любые изменения к возвращенному Collection
не должен влиять на это HttpServletResponse
.
name
- имя заголовка ответа, чьи значения, чтобы возвратиться Collection
из значений заголовка ответа с именемjava.util.Collection<java.lang.String> getHeaderNames()
Этот метод рассматривает только набор заголовков ответа или добавил через setHeader(java.lang.String, java.lang.String)
, addHeader(java.lang.String, java.lang.String)
, setDateHeader(java.lang.String, long)
, addDateHeader(java.lang.String, long)
, setIntHeader(java.lang.String, int)
, или addIntHeader(java.lang.String, int)
, соответственно.
Любые изменения к возвращенному Collection
не должен влиять на это HttpServletResponse
.
Collection
из имен заголовков этого ответа
|
|||||||||
ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС |
ФРЕЙМЫ |
||||||||
СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД | ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД |
Авторское право © 2009-2011, Oracle Corporation и/или его филиалы. Все права защищены. Использование подвергается
Сгенерированный на 10-February-2011 12:41