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

javax.faces.context
Класс FacesContext

java.lang.Object
  javax.faces.context.FacesContext

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

FacesContextWrapper

public abstract class FacesContext
расширяет java.lang. Объект

FacesContext содержит всю информацию о состоянии запроса, связанную с обработкой единственного запроса Поверхностей JavaServer, и рендерингом соответствующего ответа. К этому передают, и потенциально изменяется, каждая фаза жизненного цикла обработки запросов.

A FacesContext экземпляр связывается с определенным запросом в начале обработки запросов звонком getFacesContext() метод FacesContextFactory экземпляр связался с текущим веб-приложением. Экземпляр остается активным до release() метод вызывают, после которого не позволяются никакие дальнейшие ссылки на этот экземпляр. В то время как a FacesContext экземпляр является активным, на него нельзя сослаться ни от какого потока кроме того, на который контейнер сервлета, выполняющий это веб-приложение, использует для обработки этого запроса.

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

FacesContext()

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

abstract void	addMessage(java.lang.String clientId, FacesMessage message) Добавьте a FacesMessage к набору сообщений, связанных с указанным клиентским идентификатором, если clientId не null.
abstract Application	getApplication() Возвратитесь Application экземпляр связался с этим веб-приложением.
java.util.Map<java.lang.Object,java.lang.Object>	getAttributes() Возвратите изменчивое Map представление атрибутов связанный wth это FacesContext экземпляр.
abstract java.util.Iterator<java.lang.String>	getClientIdsWithMessages() Возвратитесь Iterator по тому клиентским, идентификаторам, для который по крайней мере один FacesMessage был поставлен в очередь.
static FacesContext	getCurrentInstance() Возвратитесь FacesContext экземпляр для запроса, который обрабатывается текущим потоком.
PhaseId	getCurrentPhaseId() Возвратите значение последний набор на этом FacesContext экземпляр, когда setCurrentPhaseId(javax.faces.event.PhaseId) был вызван.
ELContext	getELContext() Возвратитесь ELContext экземпляр для этого FacesContext экземпляр.
ExceptionHandler	getExceptionHandler() Возвратитесь ExceptionHandler для этого запроса.
abstract ExternalContext	getExternalContext() Возвратитесь ExternalContext экземпляр для этого FacesContext экземпляр.
abstract FacesMessage.Severity	getMaximumSeverity() Возвратите максимальный уровень серьезности, записанный на любом FacesMessages, который был поставлен в очередь, связываются ли они с кем-либо определенным UIComponent.
java.util.List<FacesMessage>	getMessageList() Как getMessages(), но возвраты a List<FacesMessage>, включение использованию от ЭЛЬ выражений.
java.util.List<FacesMessage>	getMessageList(java.lang.String clientId) Как getMessages(java.lang.String), но возвраты a List<FacesMessage> из сообщений для компонента с клиентским параметром соответствия идентификатора clientId.
abstract java.util.Iterator<FacesMessage>	getMessages() Возвратитесь Iterator по FacesMessages, которые были поставлены в очередь, связываются ли они с каким-либо определенным клиентским идентификатором.
abstract java.util.Iterator<FacesMessage>	getMessages(java.lang.String clientId) Возвратитесь Iterator по FacesMessages, которые были поставлены в очередь, которые связываются с указанным клиентским идентификатором (если clientId не null), или по FacesMessages, которые были поставлены в очередь, которые не связываются ни с каким определенным клиентским идентификатором (если clientId null).
PartialViewContext	getPartialViewContext() Возвратитесь PartialViewContext для этого запроса.
abstract RenderKit	getRenderKit() Возвратитесь RenderKit экземпляр для представлять идентификатора набора, определенного на нашем UIViewRoot, если есть тот.
abstract boolean	getRenderResponse() Возвратиться true если renderResponse() метод вызвали для текущего запроса.
abstract boolean	getResponseComplete() Возвратиться true если responseComplete() метод вызвали для текущего запроса.
abstract ResponseStream	getResponseStream() Возвратитесь ResponseStream к которому компоненты должны направить свой двоичный выход.
abstract ResponseWriter	getResponseWriter() Возвратитесь ResponseWriter к которому компоненты должны направить свой символьно-ориентированный вывод.
abstract UIViewRoot	getViewRoot() Возвратите корневой компонент, который связывается с этим запросом.
boolean	isPostback() Этот служебный метод просто возвращает результат ResponseStateManager.isPostback(FacesContext).
boolean	isProcessingEvents() Возвращает флаг, указывающий, должно ли время выполнения опубликовать события когда спрошено сделать так.
boolean	isProjectStage(ProjectStage stage) Возвратиться true если ток ProjectStage как возвращено Application экземпляр равен stage, иначе возвратитесь false
boolean	isReleased() Возвратите флаг, указывающий если ресурсы, связанные с этим FacesContext экземпляр был выпущен.
boolean	isValidationFailed() Возвратиться true если validationFailed() метод вызвали для текущего запроса.
abstract void	release() Высвободите любые средства, связанные с этим FacesContext экземпляр.
abstract void	renderResponse() Сигнализируйте реализацию поверхностей JavaServer, что, как только текущая фаза жизненного цикла обработки запросов была завершена, управление должно быть передано к Представлять фазе Ответа, обходя любые фазы, которые еще не были выполнены.
abstract void	responseComplete() Сигнализируйте реализацию Поверхностей JavaServer, что ответ HTTP для этого запроса был уже сгенерирован (такие как перенаправление HTTP), и что жизненный цикл обработки запросов должен быть завершен, как только текущая фаза завершается.
protected static void	setCurrentInstance(FacesContext context) Установите FacesContext экземпляр для запроса, который обрабатывается текущим потоком.
void	setCurrentPhaseId(PhaseId currentPhaseId) Реализация должна вызвать этот метод в самом раннем possble моменте времени после ввода в новую фазу в жизненном цикле обработки запросов.
void	setExceptionHandler(ExceptionHandler exceptionHandler) Установите ExceptionHandler для этого запроса.
void	setProcessingEvents(boolean processingEvents) Позволяет управление wheter или нет, время выполнения опубликует события когда Application#publishEvent(FacesContext, Class, Object) или Application#publishEvent(FacesContext, Class, Class, Object) вызывается.
abstract void	setResponseStream(ResponseStream responseStream) Установите ResponseStream к которому компоненты должны направить свой двоичный выход.
abstract void	setResponseWriter(ResponseWriter responseWriter) Установите ResponseWriter к которому компоненты должны направить свой символьно-ориентированный вывод.
abstract void	setViewRoot(UIViewRoot root) Установите корневой компонент, который связывается с этим запросом.
void	validationFailed() Устанавливает флаг, который указывает, что преобразование или ошибка проверки допустимости произошли, обрабатывая вводы.

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

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

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

FacesContext

public FacesContext()

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

getApplication

public abstract Application getApplication()

Возвратитесь Application экземпляр связался с этим веб-приложением.

Это допустимо, чтобы вызвать этот метод во время запуска приложения или завершения работы. Если вызвано во время запуска приложения или завершения работы, возвращает корректный ток Application экземпляр.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getAttributes

public java.util.Map<java.lang.Object,java.lang.Object> getAttributes()

Возвратите изменчивое Map представление атрибутов связанный wth это FacesContext экземпляр. Это Map полезно, чтобы сохранить атрибуты, что Вы хотите выйти из контекста, когда жизненный цикл Поверхностей для текущих концов запроса, который является не всегда тем же самым как окончанием запроса, особенно в случае фильтров Сервлета, которые вызываются после жизненного цикла Поверхностей для этого запроса, завершается. Доступ к этому Map не заставляет событий стрелять, как имеет место с другими картами: для запроса, сеанса, и области действия приложения. Когда release() вызывается, атрибуты должны быть очищены.

Map возвращенный этим методом не связывается с запросом. Если требуется получить или установить атрибуты запроса, см. ExternalContext#getRequestMap.

Броски реализации по умолчанию UnsupportedOperationException и обеспечивается в единственной цели не повреждения существующих приложений, которые расширяют этот class.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

2.0

getPartialViewContext

public PartialViewContext getPartialViewContext()

Возвратитесь PartialViewContext для этого запроса. PartialViewContext используется, чтобы управлять обработкой указанных компонентов во время выполнить части жизненного цикла обработки запросов (известный как частичная обработка) и рендеринг указанных компонентов (известный как частичный рендеринг). Этот метод должен возвратить новое PartialViewContext если Вы уже не существуете.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

2.0

getClientIdsWithMessages

public abstract java.util.Iterator<java.lang.String> getClientIdsWithMessages()

Возвратитесь Iterator по тому клиентским, идентификаторам, для который по крайней мере один FacesMessage был поставлен в очередь. Если нет таких клиентских идентификаторов, пустого Iterator возвращается. Если какие-либо сообщения были поставлены в очередь, которые не были связаны ни с каким определенным клиентским идентификатором, a null значение будет включено в выполненные с помощью итераций значения. Элементы в Iterator должен быть возвращен в порядке, в котором они были добавлены с addMessage(java.lang.String, javax.faces.application.FacesMessage).

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getELContext

public ELContext getELContext()

Возвратитесь ELContext экземпляр для этого FacesContext экземпляр. Это ELContext у экземпляра есть то же самое время жизни и контекст как FacesContext экземпляр, с которым это связывается, и может быть создано лениво в первый раз этот метод, вызывают для данного FacesContext экземпляр. После создания экземпляра ELContext реализация должна предпринять следующие меры:

• Вызовите ELContext#putContext метод на экземпляре, передающем в FacesContext.class и this ссылка для FacesContext экземпляр непосредственно.

• Если Collection возвращенный Application.getELContextListeners() непусто, создайте экземпляр ELContextEvent и передайте это каждому ELContextListener экземпляр в Collection вызывая ELContextListener.contextCreated(javax.el.ELContextEvent) метод.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

1.2

getExceptionHandler

public ExceptionHandler getExceptionHandler()

Возвратитесь ExceptionHandler для этого запроса.

setExceptionHandler

public void setExceptionHandler(ExceptionHandler exceptionHandler)

Установите ExceptionHandler для этого запроса.

Параметры:

exceptionHandler - ExceptionHandler для этого запроса.

getExternalContext

public abstract ExternalContext getExternalContext()

Возвратитесь ExternalContext экземпляр для этого FacesContext экземпляр.

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

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getMaximumSeverity

public abstract FacesMessage.Severity getMaximumSeverity()

Возвратите максимальный уровень серьезности, записанный на любом FacesMessages, который был поставлен в очередь, связываются ли они с кем-либо определенным UIComponent. Если никакие такие сообщения не были поставлены в очередь, возвратиться null.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getMessages

public abstract java.util.Iterator<FacesMessage> getMessages()

Возвратитесь Iterator по FacesMessages, которые были поставлены в очередь, связываются ли они с каким-либо определенным клиентским идентификатором. Если никакие такие сообщения не были поставлены в очередь, возвратите пустое Iterator. Элементы Iterator должен быть возвращен в порядке, в котором они были добавлены со звонками addMessage(java.lang.String, javax.faces.application.FacesMessage).

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getMessageList

public java.util.List<FacesMessage> getMessageList()

Как getMessages(), но возвраты a List<FacesMessage>, включение использованию от ЭЛЬ выражений.

Броски реализации по умолчанию UnsupportedOperationException и обеспечивается в единственной цели не повреждения существующих приложений, которые расширяют этот class.

Возвраты:

неизменное List который является эффективно снимком подарка сообщений во время вызова.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

2.0

getMessageList

public java.util.List<FacesMessage> getMessageList(java.lang.String clientId)

Как getMessages(java.lang.String), но возвраты a List<FacesMessage> из сообщений для компонента с клиентским параметром соответствия идентификатора clientId.

Броски реализации по умолчанию UnsupportedOperationException и обеспечивается в единственной цели не повреждения существующих приложений, которые расширяют этот class.

Возвраты:

неизменное List который является эффективно снимком подарка сообщений во время вызова.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

2.0

getMessages

public abstract java.util.Iterator<FacesMessage> getMessages(java.lang.String clientId)

Возвратитесь Iterator по FacesMessages, которые были поставлены в очередь, которые связываются с указанным клиентским идентификатором (если clientId не null), или по FacesMessages, которые были поставлены в очередь, которые не связываются ни с каким определенным клиентским идентификатором (если clientId null). Если никакие такие сообщения не были поставлены в очередь, возвратите пустое Iterator. Элементы Iterator должен быть возвращен в порядке, в котором они были добавлены со звонками addMessage(java.lang.String, javax.faces.application.FacesMessage).

Параметры:

clientId - Клиентский идентификатор, на который сообщения требуют, или null для сообщений, не связанных с любым клиентским идентификатором

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getRenderKit

public abstract RenderKit getRenderKit()

Возвратитесь RenderKit экземпляр для представлять идентификатора набора, определенного на нашем UIViewRoot, если есть тот. Если нет никакого тока UIViewRoot, если UIViewRoot не имеет указанного renderKitId, или если есть нет RenderKit для указанного идентификатора возвратиться null вместо этого.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getRenderResponse

public abstract boolean getRenderResponse()

Возвратиться true если renderResponse() метод вызвали для текущего запроса.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getResponseComplete

public abstract boolean getResponseComplete()

Возвратиться true если responseComplete() метод вызвали для текущего запроса.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

isValidationFailed

public boolean isValidationFailed()

Возвратиться true если validationFailed() метод вызвали для текущего запроса.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getResponseStream

public abstract ResponseStream getResponseStream()

Возвратитесь ResponseStream к которому компоненты должны направить свой двоичный выход. В пределах данного ответа компоненты могут использовать или ResponseStream или ResponseWriter, но не обоих.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

setResponseStream

public abstract void setResponseStream(ResponseStream responseStream)

Установите ResponseStream к которому компоненты должны направить свой двоичный выход.

Параметры:

responseStream - Новый ResponseStream для этого ответа

Броски:

java.lang.NullPointerException - если responseStream null

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getResponseWriter

public abstract ResponseWriter getResponseWriter()

Возвратитесь ResponseWriter к которому компоненты должны направить свой символьно-ориентированный вывод. В пределах данного ответа компоненты могут использовать или ResponseStream или ResponseWriter, но не обоих.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

setResponseWriter

public abstract void setResponseWriter(ResponseWriter responseWriter)

Установите ResponseWriter к которому компоненты должны направить свой символьно-ориентированный вывод.

Параметры:

responseWriter - Новый ResponseWriter для этого ответа

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

java.lang.NullPointerException - если responseWriter null

getViewRoot

public abstract UIViewRoot getViewRoot()

Возвратите корневой компонент, который связывается с этим запросом.

Это допустимо, чтобы вызвать этот метод во время запуска приложения или завершения работы. Если вызвано во время запуска приложения или завершения работы, этот метод возвращает новое UIViewRoot с его набором локали к Locale.getDefault().

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

setViewRoot

public abstract void setViewRoot(UIViewRoot root)

Установите корневой компонент, который связывается с этим запросом.

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

Если ток UIViewRoot не -null, и вызов equals() на параметре root, передача тока UIViewRoot возвраты false, clear к методу нужно обратиться Map возвращенный из UIViewRoot#getViewMap.

Параметры:

root - Новый компонент UIViewRoot компонент

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

java.lang.NullPointerException - если root null

addMessage

public abstract void addMessage(java.lang.String clientId,
                                FacesMessage message)

Добавьте a FacesMessage к набору сообщений, связанных с указанным клиентским идентификатором, если clientId не null. Если clientId null, это FacesMessage как предполагается, не связывается с любым определенным компонентным экземпляром.

Параметры:

clientId - Клиентский идентификатор, с которым это сообщение связывается (если любой)

message - Сообщение, которое будет добавлено

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

java.lang.NullPointerException - если message null

isReleased

public boolean isReleased()

Возвратите флаг, указывающий если ресурсы, связанные с этим FacesContext экземпляр был выпущен.

Возвраты:

true если средства были высвобождены.

С тех пор:

2.1

выпуск

public abstract void release()

Высвободите любые средства, связанные с этим FacesContext экземпляр. Реализации поверхностей могут хотеть объединять экземпляры в пул в связанном FacesContextFactory избегать повторенного объектного создания и сборки "мусора". После release() обращается a FacesContext экземпляр (пока FacesContext экземпляр был переработан реализацией для повторного использования), вызывая любые другие методы вызовет IllegalStateException быть брошенным.

Если вызов был выполнен к getAttributes() во время обработки для этого запроса реализация должна вызвать clear() на Map возвращенный из getAttributes(), и затем освободите структуру данных позади этого Map.

Реализация должна вызвать setCurrentInstance(javax.faces.context.FacesContext) передача null удалить ассоциацию между этим потоком и этим мертвым FacesContext экземпляр.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

renderResponse

public abstract void renderResponse()

Сигнализируйте реализацию поверхностей JavaServer, что, как только текущая фаза жизненного цикла обработки запросов была завершена, управление должно быть передано к Представлять фазе Ответа, обходя любые фазы, которые еще не были выполнены.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

isPostback

public boolean isPostback()

Этот служебный метод просто возвращает результат ResponseStateManager.isPostback(FacesContext).

Броски реализации по умолчанию UnsupportedOperationException и обеспечивается в единственной цели не повреждения существующих приложений, которые расширяют этот class.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

2.0

responseComplete

public abstract void responseComplete()

Сигнализируйте реализацию Поверхностей JavaServer, что ответ HTTP для этого запроса был уже сгенерирован (такие как перенаправление HTTP), и что жизненный цикл обработки запросов должен быть завершен, как только текущая фаза завершается.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

validationFailed

public void validationFailed()

Устанавливает флаг, который указывает, что преобразование или ошибка проверки допустимости произошли, обрабатывая вводы. Вводы состоят или из параметров страницы или из привязки формы. Этот флаг может быть считан, используя isValidationFailed().

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

getCurrentPhaseId

public PhaseId getCurrentPhaseId()

Возвратите значение последний набор на этом FacesContext экземпляр, когда setCurrentPhaseId(javax.faces.event.PhaseId) был вызван.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

2.0

setCurrentPhaseId

public void setCurrentPhaseId(PhaseId currentPhaseId)

Реализация должна вызвать этот метод в самом раннем possble моменте времени после ввода в новую фазу в жизненном цикле обработки запросов.

Параметры:

currentPhaseId - PhaseId для текущей фазы.

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

С тех пор:

2.0

setProcessingEvents

public void setProcessingEvents(boolean processingEvents)

Позволяет управление wheter или нет, время выполнения опубликует события когда Application#publishEvent(FacesContext, Class, Object) или Application#publishEvent(FacesContext, Class, Class, Object) вызывается.

Параметры:

processingEvents - события указания флага должны быть обработаны или нет

isProcessingEvents

public boolean isProcessingEvents()

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

Возвраты:

true если события должны быть опубликованы, иначе false

isProjectStage

public boolean isProjectStage(ProjectStage stage)

Возвратиться true если ток ProjectStage как возвращено Application экземпляр равен stage, иначе возвратитесь false

Параметры:

stage - ProjectStage проверять

Броски:

IllegalStateException - если этот метод вызывают после того, как этот экземпляр был выпущен

java.lang.NullPointerException - если stage null

getCurrentInstance

public static FacesContext getCurrentInstance()

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

setCurrentInstance

protected static void setCurrentInstance(FacesContext context)

Установите FacesContext экземпляр для запроса, который обрабатывается текущим потоком.

Параметры:

context - FacesContext экземпляр для текущего потока, или null если у этого потока больше нет a FacesContext экземпляр.