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

javax.servlet.jsp
Класс PageContext

java.lang.Object
  javax.servlet.jsp.JspContext
      javax.servlet.jsp.PageContext

public abstract class PageContext
расширяет JspContext

PageContext расширяет JspContext, чтобы обеспечить полезную контекстную информацию для того, когда технология JSP используется в среде Сервлета.

Экземпляр PageContext обеспечивает доступ ко всем пространствам имен, связанным со страницей JSP, обеспечивает доступ к атрибутам на несколько страниц, так же как уровень выше деталей реализации. Неявные объекты добавляются к pageContext автоматически.

PageContext class является абстрактный class, разработанный, чтобы быть расширенным, чтобы обеспечить зависящие от реализации реализации этого, совместимыми средами выполнения механизма JSP. Экземпляр PageContext получается реализацией JSP class, вызывая JspFactory.getPageContext () метод, и выпускается, вызывая JspFactory.releasePageContext ().

Пример того, как PageContext, JspFactory, и другие классы могут использоваться в пределах объекта Реализации Страницы JSP, дается в другом месте.

PageContext предоставляет много услуг автору страницы/компонента и конструктору страницы, включая:

• единственный API, чтобы управлять различными определяющими контекст пространствами имен
• много API удобства, чтобы получить доступ к различным общедоступным объектам
• механизм, чтобы получить JspWriter для вывода
• механизм, чтобы управлять использованием сеанса страницей
• механизм, чтобы представить страницу направляющие атрибуты среде сценариев
• механизмы, чтобы передать или включать текущий запрос в другие активные компоненты в приложении
• механизм, чтобы обработать errorpage обработку исключения

Методы, Предназначенные для Контейнерного Сгенерированного Кода

Некоторые методы предназначаются, чтобы использоваться кодом, сгенерированным контейнером, не кодом, записанным авторами страницы JSP, или авторами библиотеки тега JSP.

Методы, поддерживающие жизненный цикл, initialize() и release()

Следующие методы позволяют управлению вложенными потоками JspWriter реализовать Расширения Тега: pushBody()

Методы, Предназначенные для авторов JSP

Следующие методы обеспечивают удобный доступ к неявным объектам: getException(), getPage() getRequest(), getResponse(), getSession(), getServletConfig() и getServletContext().

Следующие методы оказывают поддержку для передачи, включения и обработки ошибок: forward(), include(), и handlePageException().

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

static java.lang.String	ПРИЛОЖЕНИЕ Имя, используемое, чтобы сохранить ServletContext в PageContext, называет таблицу.
static int	APPLICATION_SCOPE Область действия приложения: названный ссылкой остается доступным в ServletContext, пока это не исправляется.
static java.lang.String	КОНФИГУРАЦИЯ Имя, используемое, чтобы сохранить ServletConfig в PageContext, называет таблицу.
static java.lang.String	ИСКЛЮЧЕНИЕ Имя, используемое, чтобы сохранить непойманное исключение в списке атрибутов ServletRequest и PageContext, называет таблицу.
static java.lang.String	Имя, используемое, чтобы сохранить текущий JspWriter в PageContext, называет таблицу.
static java.lang.String	СТРАНИЦА Имя, используемое, чтобы сохранить Сервлет в nametables этого PageContext.
static int	PAGE_SCOPE Контекст страницы: (это - значение по умолчанию), именованная ссылка остается доступной в этом PageContext до возврата из текущего Servlet.service () вызов.
static java.lang.String	PAGECONTEXT Имя, используемое, чтобы сохранить этот PageContext в своей собственной таблице имени.
static java.lang.String	ЗАПРОС Имя, используемое, чтобы сохранить ServletRequest в PageContext, называет таблицу.
static int	REQUEST_SCOPE Контекст запроса: именованная ссылка остается доступной от ServletRequest, связанного с Сервлетом, пока текущий запрос не завершается.
static java.lang.String	ОТВЕТ Имя, используемое, чтобы сохранить ServletResponse в PageContext, называет таблицу.
static java.lang.String	СЕАНС Имя, используемое, чтобы сохранить HttpSession в PageContext, называет таблицу.
static int	SESSION_SCOPE Контекст сеанса (только допустимый, если эта страница участвует в сеансе): именованная ссылка остается доступной от HttpSession (если любой) связанный с Сервлетом, пока HttpSession не лишается законной силы.

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

PageContext()
Единственный конструктор.

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

abstract void	forward(java.lang.String relativeUrlPath) Этот метод используется, чтобы перенаправить, или "передать" текущий ServletRequest и ServletResponse к другому активному компоненту в приложении.
ErrorData	getErrorData() Обеспечивает удобный доступ к информации об ошибке.
abstract java.lang.Exception	getException() Текущая стоимость объекта исключения (Исключение).
abstract java.lang.Object	getPage() Текущая стоимость объекта страницы (В среде Сервлета, это - экземпляр javax.servlet. Сервлет).
abstract ServletRequest	getRequest() Текущая стоимость объекта запроса (ServletRequest).
abstract ServletResponse	getResponse() Текущая стоимость объекта ответа (ServletResponse).
abstract ServletConfig	getServletConfig() Экземпляр ServletConfig.
abstract ServletContext	getServletContext() Экземпляр ServletContext.
abstract HttpSession	getSession() Текущая стоимость объекта сеанса (HttpSession).
abstract void	handlePageException(java.lang.Exception e) Этот метод предназначается, чтобы обработать необработанное исключение уровня 'страницы', передавая исключение указанной ошибочной странице для этого JSP.
abstract void	handlePageException(java.lang.Throwable t) Этот метод предназначается, чтобы обработать необработанное исключение уровня 'страницы', передавая исключение указанной ошибочной странице для этого JSP.
abstract void	include(java.lang.String relativeUrlPath) Вызывает ресурс, определенный, чтобы быть обработанным как часть текущего ServletRequest и ServletResponse, обрабатываемого вызывающим потоком.
abstract void	include(java.lang.String relativeUrlPath, boolean flush) Вызывает ресурс, определенный, чтобы быть обработанным как часть текущего ServletRequest и ServletResponse, обрабатываемого вызывающим потоком.
abstract void	initialize(Servlet servlet, ServletRequest request, ServletResponse response, java.lang.String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) Инициализировать метод вызывают, чтобы инициализировать неинициализированный PageContext так, чтобы он мог использоваться Реализацией JSP class, чтобы обслужить входящий запрос и ответ в пределах, это - _jspService () метод.
BodyContent	pushBody() Возвратите новый объект BodyContent, сохраните ток JspWriter, и обновите значение, атрибут в контексте страницы приписывает пространство имен PageContext.
abstract void	release() Этот метод должен "сбросить" внутреннее состояние PageContext, выпуская все внутренние ссылки, и готовя PageContext к потенциальному повторному использованию более поздним вызовом инициализирует ().

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

findAttribute, getAttribute, getAttribute, getAttributeNamesInScope, getAttributesScope, getELContext, getExpressionEvaluator, getOut, getVariableResolver, popBody, pushBody, removeAttribute, removeAttribute, setAttribute, setAttribute

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

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

Полевая Деталь

PAGE_SCOPE

public static final int PAGE_SCOPE

Контекст страницы: (это - значение по умолчанию), именованная ссылка остается доступной в этом PageContext до возврата из текущего Servlet.service () вызов.

См. Также:

Постоянные Значения полей

REQUEST_SCOPE

public static final int REQUEST_SCOPE

Контекст запроса: именованная ссылка остается доступной от ServletRequest, связанного с Сервлетом, пока текущий запрос не завершается.

См. Также:

Постоянные Значения полей

SESSION_SCOPE

public static final int SESSION_SCOPE

Контекст сеанса (только допустимый, если эта страница участвует в сеансе): именованная ссылка остается доступной от HttpSession (если любой) связанный с Сервлетом, пока HttpSession не лишается законной силы.

См. Также:

Постоянные Значения полей

APPLICATION_SCOPE

public static final int APPLICATION_SCOPE

Область действия приложения: названный ссылкой остается доступным в ServletContext, пока это не исправляется.

См. Также:

Постоянные Значения полей

СТРАНИЦА

public static final java.lang.String PAGE

Имя, используемое, чтобы сохранить Сервлет в nametables этого PageContext.

См. Также:

Постоянные Значения полей

PAGECONTEXT

public static final java.lang.String PAGECONTEXT

Имя, используемое, чтобы сохранить этот PageContext в своей собственной таблице имени.

См. Также:

Постоянные Значения полей

ЗАПРОС

public static final java.lang.String REQUEST

Имя, используемое, чтобы сохранить ServletRequest в PageContext, называет таблицу.

См. Также:

Постоянные Значения полей

ОТВЕТ

public static final java.lang.String RESPONSE

Имя, используемое, чтобы сохранить ServletResponse в PageContext, называет таблицу.

См. Также:

Постоянные Значения полей

КОНФИГУРАЦИЯ

public static final java.lang.String CONFIG

Имя, используемое, чтобы сохранить ServletConfig в PageContext, называет таблицу.

См. Также:

Постоянные Значения полей

СЕАНС

public static final java.lang.String SESSION

Имя, используемое, чтобы сохранить HttpSession в PageContext, называет таблицу.

См. Также:

Постоянные Значения полей

public static final java.lang.String OUT

Имя, используемое, чтобы сохранить текущий JspWriter в PageContext, называет таблицу.

См. Также:

Постоянные Значения полей

ПРИЛОЖЕНИЕ

public static final java.lang.String APPLICATION

Имя, используемое, чтобы сохранить ServletContext в PageContext, называет таблицу.

См. Также:

Постоянные Значения полей

ИСКЛЮЧЕНИЕ

public static final java.lang.String EXCEPTION

Имя, используемое, чтобы сохранить непойманное исключение в списке атрибутов ServletRequest и PageContext, называет таблицу.

См. Также:

Постоянные Значения полей

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

PageContext

public PageContext()

Единственный конструктор. (Для вызова конструкторами подкласса, обычно неявными.)

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

инициализировать

public abstract void initialize(Servlet servlet,
                                ServletRequest request,
                                ServletResponse response,
                                java.lang.String errorPageURL,
                                boolean needsSession,
                                int bufferSize,
                                boolean autoFlush)
                         throws java.io.IOException,
                                java.lang.IllegalStateException,
                                java.lang.IllegalArgumentException

Инициализировать метод вызывают, чтобы инициализировать неинициализированный PageContext так, чтобы он мог использоваться Реализацией JSP class, чтобы обслужить входящий запрос и ответ в пределах, это - _jspService () метод.

Этот метод обычно вызывают от JspFactory.getPageContext (), чтобы инициализировать состояние.

Этот метод обязан создавать начальный JspWriter, и связываться имя в контексте страницы с этим недавно создаваемым объектом.

Этот метод не должен использоваться страницей или авторами библиотеки тега.

Параметры:

servlet - Сервлет, который связывается с этим PageContext

request - Запрос в настоящий момент на ожидании на этот Сервлет

response - Ответ в настоящий момент на ожидании для этого Сервлета

errorPageURL - Значение errorpage приписывает от страницы, направляющей или нулевой

needsSession - Значение сеанса приписывает от направляющей страницы

bufferSize - Значение буферного атрибута от направляющей страницы

autoFlush - Значение автосброса приписывает от направляющей страницы

Броски:

java.io.IOException - во время создания JspWriter

IllegalStateException - если не правильно инициализированный

IllegalArgumentException - Если один из данных параметров недопустим

выпуск

public abstract void release()

Этот метод должен "сбросить" внутреннее состояние PageContext, выпуская все внутренние ссылки, и готовя PageContext к потенциальному повторному использованию более поздним вызовом инициализирует (). Этот метод обычно вызывают от JspFactory.releasePageContext ().

Подклассы должны быть конверт этот метод.

Этот метод не должен использоваться страницей или авторами библиотеки тега.

getSession

public abstract HttpSession getSession()

Текущая стоимость объекта сеанса (HttpSession).

Возвраты:

HttpSession для этого PageContext или нуля

getPage

public abstract java.lang.Object getPage()

Текущая стоимость объекта страницы (В среде Сервлета, это - экземпляр javax.servlet. Сервлет).

Возвраты:

реализация Пейджа экземпляр class связалась с этим PageContext

getRequest

public abstract ServletRequest getRequest()

Текущая стоимость объекта запроса (ServletRequest).

Возвраты:

ServletRequest для этого PageContext

getResponse

public abstract ServletResponse getResponse()

Текущая стоимость объекта ответа (ServletResponse).

Возвраты:

ServletResponse для этого PageContext

getException

public abstract java.lang.Exception getException()

Текущая стоимость объекта исключения (Исключение).

Возвраты:

любое исключение, которое передают к этому как errorpage

getServletConfig

public abstract ServletConfig getServletConfig()

Экземпляр ServletConfig.

Возвраты:

ServletConfig для этого PageContext

getServletContext

public abstract ServletContext getServletContext()

Экземпляр ServletContext.

Возвраты:

ServletContext для этого PageContext

передать

public abstract void forward(java.lang.String relativeUrlPath)
                      throws ServletException,
                             java.io.IOException

Этот метод используется, чтобы перенаправить, или "передать" текущий ServletRequest и ServletResponse к другому активному компоненту в приложении.

Если relativeUrlPath начинается "/" тогда, определенный URL вычисляется относительно DOCROOT ServletContext для этого JSP. Если путь не начинается "/" тогда, определенный URL вычисляется относительно URL запроса, который был отображен на вызов JSP.

Это только допустимо, чтобы вызвать этот метод от a Thread выполнение в пределах a _jspService(...) метод JSP.

Как только этот метод вызвали успешно, это недопустимо для вызова Thread попытаться изменить ServletResponse объект. Любая такая попытка сделать так, приведу к неопределенному поведению. Как правило, вызывающие стороны сразу возвращаются из _jspService(...) после вызова этого метода.

Параметры:

relativeUrlPath - определяет относительный путь URL к целевому ресурсу как описано выше

Броски:

IllegalStateException - если ServletResponse не находится в состоянии, где прямое может быть выполнено

ServletException - если страница, которая была передана броскам ServletException

java.io.IOException - если ошибка ввода-вывода произошла, передавая

включать

public abstract void include(java.lang.String relativeUrlPath)
                      throws ServletException,
                             java.io.IOException

Вызывает ресурс, определенный, чтобы быть обработанным как часть текущего ServletRequest и ServletResponse, обрабатываемого вызывающим потоком. Вывод целевой обработки ресурсов запроса пишется непосредственно потоку вывода ServletResponse.

Текущий JspWriter для этого JSP сбрасывается как побочный эффект этого вызова до обработки включения.

Если relativeUrlPath начинается "/" тогда, определенный URL вычисляется относительно DOCROOT ServletContext для этого JSP. Если путь не начинается "/" тогда, определенный URL вычисляется относительно URL запроса, который был отображен на вызов JSP.

Это только допустимо, чтобы вызвать этот метод от a Thread выполнение в пределах a _jspService(...) метод JSP.

Параметры:

relativeUrlPath - определяет относительный путь URL к целевому ресурсу, который будет включен

Броски:

ServletException - если страница, которая была передана броскам ServletException

java.io.IOException - если ошибка ввода-вывода произошла, передавая

включать

public abstract void include(java.lang.String relativeUrlPath,
                             boolean flush)
                      throws ServletException,
                             java.io.IOException

Вызывает ресурс, определенный, чтобы быть обработанным как часть текущего ServletRequest и ServletResponse, обрабатываемого вызывающим потоком. Вывод целевой обработки ресурсов запроса пишется непосредственно текущему JspWriter, возвращенному звонком getOut ().

Если сброс является истиной, текущий JspWriter для этого JSP сбрасывается как побочный эффект этого вызова до обработки включения. Иначе, JspWriter не сбрасывается.

Если relativeUrlPath начинается "/" тогда, определенный URL вычисляется относительно DOCROOT ServletContext для этого JSP. Если путь не начинается "/" тогда, определенный URL вычисляется относительно URL запроса, который был отображен на вызов JSP.

Это только допустимо, чтобы вызвать этот метод от a Thread выполнение в пределах a _jspService(...) метод JSP.

Параметры:

relativeUrlPath - определяет относительный путь URL к целевому ресурсу, который будет включен

flush - Истина, если JspWriter должен быть сброшен перед включением, или ложью если нет.

Броски:

ServletException - если страница, которая была передана броскам ServletException

java.io.IOException - если ошибка ввода-вывода произошла, передавая

С тех пор:

JSP 2.0

handlePageException

public abstract void handlePageException(java.lang.Exception e)
                                  throws ServletException,
                                         java.io.IOException

Этот метод предназначается, чтобы обработать необработанное исключение уровня 'страницы', передавая исключение указанной ошибочной странице для этого JSP. Если передача не возможна (например, потому что ответ уже фиксировался), зависящий от реализации механизм должен использоваться, чтобы вызвать ошибочную страницу (например, "включая" ошибочную страницу вместо этого).

Если никакая ошибочная страница не определяется в странице, исключение должно быть повторно брошено так, чтобы стандартная обработка ошибок сервлета вступила во владение.

Реализация JSP class должен обычно очищать любое локальное состояние до вызова этого и возвратится сразу после того. Это недопустимо, чтобы генерировать любой вывод клиенту, или изменить любое состояние ServletResponse после вызова этого вызова.

Этот метод сохраняется для назад compatiblity причины. Недавно сгенерированный код должен использовать PageContext.handlePageException (Throwable).

Параметры:

e - исключение, которое будет обработано

Броски:

ServletException - если ошибка происходит, вызывая ошибочную страницу

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

java.lang.NullPointerException - если исключение является нулем

См. Также:

handlePageException(Throwable)

handlePageException

public abstract void handlePageException(java.lang.Throwable t)
                                  throws ServletException,
                                         java.io.IOException

Этот метод предназначается, чтобы обработать необработанное исключение уровня 'страницы', передавая исключение указанной ошибочной странице для этого JSP. Если передача не возможна (например, потому что ответ уже фиксировался), зависящий от реализации механизм должен использоваться, чтобы вызвать ошибочную страницу (например, "включая" ошибочную страницу вместо этого).

Если никакая ошибочная страница не определяется в странице, исключение должно быть повторно брошено так, чтобы стандартная обработка ошибок сервлета вступила во владение.

Этот метод предназначается, чтобы обработать необработанное исключение уровня "страницы", перенаправляя исключение или к указанной ошибочной странице для этого JSP, или к если ни один не был определен, чтобы выполнить некоторое зависящее от реализации действие.

Реализация JSP class должен обычно очищать любое локальное состояние до вызова этого и возвратится сразу после того. Это недопустимо, чтобы генерировать любой вывод клиенту, или изменить любое состояние ServletResponse после вызова этого вызова.

Параметры:

t - throwable, который будет обработан

Броски:

ServletException - если ошибка происходит, вызывая ошибочную страницу

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

java.lang.NullPointerException - если исключение является нулем

См. Также:

handlePageException(Exception)

pushBody

public BodyContent pushBody()

Возвратите новый объект BodyContent, сохраните ток JspWriter, и обновите значение, атрибут в контексте страницы приписывает пространство имен PageContext.

Возвраты:

новый BodyContent

getErrorData

public ErrorData getErrorData()

Обеспечивает удобный доступ к информации об ошибке.

Возвраты:

экземпляр ErrorData, содержащий информацию об ошибке, как получено из атрибутов запроса, согласно спецификации Сервлета. Если это не ошибочная страница (то есть, если isErrorPage атрибут направляющей страницы не устанавливается в "истину"), информация бессмысленна.

С тех пор:

JSP 2.0