ServletResponse (EE Java 6)

Spec-Zone .ru

спецификации, руководства, описания, API

Краткий обзор

Пакет

Класс

Дерево

Устаревшие

Индексировать

Справка

ПРЕДЫДУЩИЙ КЛАСС СЛЕДУЮЩИЙ КЛАСС

ФРЕЙМЫ НИКАКИЕ ФРЕЙМЫ

СВОДКА: ВЛОЖЕННЫЙ | ПОЛЕ | CONSTR | МЕТОД

ДЕТАЛЬ: ПОЛЕ | CONSTR | МЕТОД

javax.servlet
Интерфейс ServletResponse

Все Известные Подынтерфейсы:: HttpServletResponse

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

public interface ServletResponse

Определяет объект помочь сервлету в отправке ответа клиенту. Контейнер сервлета создает a ServletResponse объект и передачи это как параметр сервлету service метод.

Чтобы отправить двоичных данных в ответе тела MIME, используйте ServletOutputStream возвращенный getOutputStream(). Чтобы отправить символьные данные, используйте PrintWriter объект, возвращенный getWriter(). Смешать двоичный файл и текстовые данные, например, создать многослойный ответ, a использования ServletOutputStream и управляйте символьными разделами вручную.

Набор символов для ответа тела MIME может быть определен, явно используя setCharacterEncoding(java.lang.String) и setContentType(java.lang.String) методы, или неявно использование setLocale(java.util.Locale) метод. Явные спецификации имеют приоритет по неявным спецификациям. Если никакой набор символов не будет определен, то ISO-8859-1 будет использоваться. setCharacterEncoding, setContentType, или setLocale метод нужно вызвать прежде getWriter и прежде, чем фиксировать ответ для кодировки символов, которая будет использоваться.

См. Интернет RFCs, такой как RFC 2045 для получения дополнительной информации о MIME. Протоколы, такие как SMTP и HTTP определяют профили MIME, и те стандарты все еще развиваются.

Автор:: Различный
См. Также:: ServletOutputStream

Сводка метода
`void`	`flushBuffer()` Силы любой контент в буфере, который будет записан клиенту.
`int`	`getBufferSize()` Возвращает фактический размер буфера, используемый для ответа.
`java.lang.String`	`getCharacterEncoding()` Возвращает имя кодировки символов (набор символов MIME) используемый для тела, отправленного в этом ответе.
`java.lang.String`	`getContentType()` Возвращает тип контента, используемый для тела MIME, отправленного в этом ответе.
`java.util.Locale`	`getLocale()` Возвращает локаль, определенную для этого ответа, используя `setLocale(java.util.Locale)` метод.
`ServletOutputStream`	`getOutputStream()` Возвраты a `ServletOutputStream` подходящий для того, чтобы записать двоичных данных в ответе.
`java.io.PrintWriter`	`getWriter()` Возвраты a `PrintWriter` объект, который может отправить символьный текст клиенту.
`boolean`	`isCommitted()` Возвращает булево указание, если ответ фиксировался.
`void`	`reset()` Очищает любые данные, которые существуют в буфере так же как коде состояния и заголовках.
`void`	`resetBuffer()` Очищает контент базового буфера в ответе, не очищая заголовки или код состояния.
`void`	`setBufferSize(int size)` Устанавливает привилегированный размер буфера для тела ответа.
`void`	`setCharacterEncoding(java.lang.String charset)` Устанавливает кодировку символов (набор символов MIME) ответа, отправляемого клиенту, например, UTF-8.
`void`	`setContentLength(int len)` Устанавливает длину тела контента в ответе В сервлетах HTTP, этот метод устанавливает HTTP заголовок Длиной до контента.
`void`	`setContentType(java.lang.String type)` Устанавливает тип контента ответа, отправляемого клиенту, если ответ еще не фиксировался.
`void`	`setLocale(java.util.Locale loc)` Устанавливает локаль ответа, если ответ еще не фиксировался.

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

getCharacterEncoding

java.lang.String getCharacterEncoding()

Возвращает имя кодировки символов (набор символов MIME) используемый для тела, отправленного в этом ответе. Кодировка символов, возможно, была определена, явно используя setCharacterEncoding(java.lang.String) или setContentType(java.lang.String) методы, или неявно использование setLocale(java.util.Locale) метод. Явные спецификации имеют приоритет по неявным спецификациям. Вызовы, выполненные к этим методам после getWriter был вызван или после того, как ответ фиксировался, не имеют никакого эффекта на кодировку символов. Если никакая кодировка символов не была определена, ISO-8859-1 возвращается.

См. RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) для получения дополнительной информации о кодировке символов и MIME.

Возвраты:: a String определение имени кодировки символов, например, UTF-8

getContentType

java.lang.String getContentType()

Возвращает тип контента, используемый для тела MIME, отправленного в этом ответе. Надлежащий тип контента, должно быть, был определен, используя setContentType(java.lang.String) прежде, чем ответ фиксируется. Если никакой тип контента не был определен, этот нуль возвратов метода. Если тип контента был определен, и кодировка символов была явно или неявно определена как описано в getCharacterEncoding() или getWriter() был вызван, параметр набора символов включается в возвращенную строку. Если никакая кодировка символов не была определена, параметр набора символов опускается.

Возвраты:: a String определение типа контента, например, text/html; charset=UTF-8, или нуль
С тех пор:: Сервлет 2.4

getOutputStream

ServletOutputStream getOutputStream()
                                    throws java.io.IOException

Возвраты a ServletOutputStream подходящий для того, чтобы записать двоичных данных в ответе. Контейнер сервлета не кодирует двоичных данных.

Вызов сброса () на ServletOutputStream фиксирует ответ. Или этот метод или getWriter() может быть вызван, чтобы записать тело, не обоих.

Возвраты:: a ServletOutputStream для того, чтобы записать двоичных данных
Броски:: IllegalStateException - если getWriter метод вызвали на этом ответе; java.io.IOException - если исключение ввода или вывода произошло
См. Также:: getWriter()

getWriter

java.io.PrintWriter getWriter()
                              throws java.io.IOException

Возвраты a PrintWriter объект, который может отправить символьный текст клиенту. PrintWriter использует кодировку символов, возвращенную getCharacterEncoding(). Если кодировка символов ответа не была определена как описано в getCharacterEncoding (то есть, метод только возвращает значение по умолчанию ISO-8859-1), getWriter обновления это к ISO-8859-1.

Вызов сброса () на PrintWriter фиксирует ответ.

Или этот метод или getOutputStream() может быть вызван, чтобы записать тело, не обоих.

Возвраты:: a PrintWriter объект, который может возвратить символьные данные клиенту
Броски:: UnsupportedEncodingException - если кодировка символов, возвращенная getCharacterEncoding не может использоваться; IllegalStateException - если getOutputStream метод уже вызвали для этого объекта ответа; java.io.IOException - если исключение ввода или вывода произошло
См. Также:: getOutputStream(), setCharacterEncoding(java.lang.String)

setCharacterEncoding

void setCharacterEncoding(java.lang.String charset)

Устанавливает кодировку символов (набор символов MIME) ответа, отправляемого клиенту, например, UTF-8. Если кодировка символов была уже установлена setContentType(java.lang.String) или setLocale(java.util.Locale), этот метод переопределяет это. Вызов setContentType(java.lang.String) с String из text/html и вызов этого метода с String из UTF-8 эквивалентно с вызовом setContentType с String из text/html; charset=UTF-8.

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

Контейнеры должны передать кодировку символов, привыкшую для писателя ответа сервлета к клиенту, если протокол обеспечивает путь к выполнению так. В случае HTTP кодировка символов передается как часть Content-Type заголовок для текстовых типов носителей. Отметьте, что кодировка символов не может быть передана через HTTP-заголовки, если сервлет не определяет тип контента; однако, это все еще используется, чтобы закодировать текст, записанный через писателя ответа сервлета.

Параметры:: charset - Строка, определяющая только набор символов, определенный Наборами символов IANA (http://www.iana.org/assignments/character-sets)
С тех пор:: Сервлет 2.4
См. Также:: #setLocale

setContentLength

void setContentLength(int len)

Устанавливает длину тела контента в ответе В сервлетах HTTP, этот метод устанавливает HTTP заголовок Длиной до контента.

Параметры:: len - целое число, определяющее длину контента, возвращаемого клиенту; устанавливает заголовок Длиной до контента

setContentType

void setContentType(java.lang.String type)

Устанавливает тип контента ответа, отправляемого клиенту, если ответ еще не фиксировался. Данный тип контента может включать спецификацию кодировки символов, например, text/html;charset=UTF-8. Кодировка символов ответа только устанавливается от данного типа контента, если этот метод вызывают прежде getWriter вызывается.

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

Контейнеры должны передать тип контента и кодировку символов, привыкшую для писателя ответа сервлета к клиенту, если протокол обеспечивает путь к выполнению так. В случае HTTP, Content-Type заголовок используется.

Параметры:: type - a String определение типа MIME контента
См. Также:: setLocale(java.util.Locale), setCharacterEncoding(java.lang.String), getOutputStream(), getWriter()

setBufferSize

void setBufferSize(int size)

Устанавливает привилегированный размер буфера для тела ответа. Контейнер сервлета будет использовать буфер, по крайней мере, столь же большой как размер, который требуют. Фактический используемый размер буфера может быть найден, используя getBufferSize.

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

Этот метод нужно вызвать прежде, чем любой контент тела ответа пишется; если контент был записан, или объект ответа фиксировался, этот метод бросает IllegalStateException.

Параметры:: size - привилегированный размер буфера
Броски:: IllegalStateException - если этот метод вызывают после того, как контент был записан
См. Также:: getBufferSize(), flushBuffer(), isCommitted(), reset()

getBufferSize

int getBufferSize()

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

Возвраты:: фактический размер буфера используется
См. Также:: setBufferSize(int), flushBuffer(), isCommitted(), reset()

flushBuffer

void flushBuffer()
                 throws java.io.IOException

Силы любой контент в буфере, который будет записан клиенту. Звонок в этот метод автоматически фиксирует ответ, означая код состояния, и заголовки будут записаны.

Броски:: java.io.IOException
См. Также:: setBufferSize(int), getBufferSize(), isCommitted(), reset()

resetBuffer

void resetBuffer()

Очищает контент базового буфера в ответе, не очищая заголовки или код состояния. Если ответ фиксировался, этот метод бросает IllegalStateException.

С тех пор:: Сервлет 2.3
См. Также:: setBufferSize(int), getBufferSize(), isCommitted(), reset()

isCommitted

boolean isCommitted()

Возвращает булево указание, если ответ фиксировался. У фиксировавшего ответа уже были свой код состояния и записанные заголовки.

Возвраты:: булево указание, если ответ фиксировался
См. Также:: setBufferSize(int), getBufferSize(), flushBuffer(), reset()

сброс

void reset()

Очищает любые данные, которые существуют в буфере так же как коде состояния и заголовках. Если ответ фиксировался, этот метод бросает IllegalStateException.

Броски:: IllegalStateException - если ответ уже фиксировался
См. Также:: setBufferSize(int), getBufferSize(), flushBuffer(), isCommitted()

setLocale

void setLocale(java.util.Locale loc)

Устанавливает локаль ответа, если ответ еще не фиксировался. Это также устанавливает кодировку символов ответа соответственно для локали, если кодировка символов не была явно установлена, используя setContentType(java.lang.String) или setCharacterEncoding(java.lang.String), getWriter еще не был вызван, и ответ еще не фиксировался. Если дескриптор развертывания содержит a locale-encoding-mapping-list элемент, и тот элемент обеспечивают отображение для данной локали, то отображение используется. Иначе, отображение от локали до кодировки символов является зависимым контейнером.

Этот метод можно вызвать неоднократно, чтобы изменить локаль и кодировку символов. Метод не имеет никакого эффекта если вызвано после того, как ответ фиксировался. Это не устанавливает кодировку символов ответа, если это вызывают после setContentType(java.lang.String) был вызван со спецификацией набора символов, после setCharacterEncoding(java.lang.String) был вызван, после getWriter был вызван, или после того, как ответ фиксировался.

Контейнеры должны передать локаль и кодировку символов, привыкшую для писателя ответа сервлета к клиенту, если протокол обеспечивает путь к выполнению так. В случае HTTP локаль передается через Content-Language заголовок, кодировка символов как часть Content-Type заголовок для текстовых типов носителей. Отметьте, что кодировка символов не может быть передана через HTTP-заголовки, если сервлет не определяет тип контента; однако, это все еще используется, чтобы закодировать текст, записанный через писателя ответа сервлета.

Параметры:: loc - локаль ответа
См. Также:: getLocale(), setContentType(java.lang.String), setCharacterEncoding(java.lang.String)

getLocale

java.util.Locale getLocale()

Возвращает локаль, определенную для этого ответа, используя setLocale(java.util.Locale) метод. Вызовы, выполненные к setLocale после того, как ответ фиксируется, не имеют никакого эффекта. Если никакая локаль не была определена, локаль значения по умолчанию контейнера возвращается.