AbstractClearableCredential
contains behavior common to
Credential
implementations that can be meaningfully
cleared.MultivaluedMap
that is backed by a [key, multi-value] store represented
as a Map<K, List<V>>
.AbstractQuery
interface defines functionality that is common
to both top-level queries and subqueries.Access
annotation to specify an access
type to be applied to an entity class, mapped superclass, or
embeddable class, or to a specific attribute of such a class.
An ActionEvent
represents the activation of a user interface component (such as a UICommand
).
Construct a new event object from the specified source component and action command.
Construct a new event object from the Faces context, specified source component and action command.
ActionEvent
s.
Provides a simple implementation of ActionListener
that can be subclassed by developers wishing to provide
specialized behavior to an existing ActionListener
instance.
UIComponent
that wishes
to be a source of ActionEvent
s, including the ability to invoke application actions via the default
ActionListener
mechanism.ActionSource
and provides a JavaBeans property analogous to the
"action
" property on ActionSource
.
A VDL handler that exposes ActionListener
to a page author.
A marker interface for VDL tags that represent <composite:actionSource/>
for use by the
composite component page author.
Store the specified value
in a List
that is internal to the StateHelper
.
Add another Metadata
to this ruleset, returning this
.
JsonString
.JsonNumber
.JsonNumber
.JsonNumber
.JsonNumber
.JsonNumber
.JsonValue.TRUE
or JsonValue.FALSE
value to the
array.JsonObject
from an object builder to the array.JsonArray
from an array builder to the array.JsonString
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonValue.TRUE
or JsonValue.FALSE
value to the
array at the specified position.JsonObject
from an object builder to the array at the specified position.JsonArray
from an array builder to the array at the specified position.JsonValue
pair to the JSON object associated with
this object builder.JsonString
pair to the JSON object associated with
this object builder.JsonNumber
pair to the JSON object associated with
this object builder.JsonNumber
pair to the JSON object associated with
this object builder.JsonNumber
pair to the JSON object associated with
this object builder.JsonNumber
pair to the JSON object associated with
this object builder.JsonNumber
pair to the JSON object associated with
this object builder.JsonValue#TRUE
or name/JsonValue#FALSE
pair
to the JSON object associated with this object builder.JsonObject
pair to the JSON object associated
with this object builder.JsonArray
pair to the JSON object associated with
this object builder.target
with the specified value
.ActionListener
to the set of listeners interested in being notified when ActionEvent
s
occur.ActionListener
to the set of listeners interested in being notified when ActionEvent
s
occur.
Add the specified AjaxBehaviorListener
to the set of listeners registered to receive event notifications from
this AjaxBehavior
.
AnnotatedType
to the set of types which will be scanned during bean
discovery.AnnotatedTypeConfigurator
to configure a new AnnotatedType
and
add it to the set of types which will be scanned during bean discovery at the end of the observer invocation.AnnotatedType
to the set of types which will be scanned during bean
discovery.AnnotatedType
to the set of types which will be scanned during bean
discovery.AnnotatedTypeConfigurator
to configure a new AnnotatedType
and
add it to the set of types which will be scanned during bean discovery at the end of the observer invocationProcessBean
containing the given
Bean
and then registers the Bean
with the
container, thereby making a bean which is not an interceptor nor a decorator available for injection into other beans.BeanConfigurator
to configure a new Bean
and add it at the end of the observer invocation.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.Behavior
class.
The default behavior of this method is to call Application.addBehavior(String, String)
on the wrapped
Application
object.
Add the specified BehaviorListener
to the set of listeners registered to receive event notifications from
this Behavior
.
UIComponent
to the list of component identifiers created or
located by nested UIComponentTag
s processing this request.
Attaches a ClientBehavior
to the component implementing this interface for the specified event.
This is a default implementation of ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior)
.
ClientBehaviorRenderer
instance, associated with the specified component
type
, to the set of ClientBehaviorRenderer
s registered with this RenderKit
, replacing
any previously registered ClientBehaviorRenderer
for this type.RenderKit.addClientBehaviorRenderer(String, ClientBehaviorRenderer)
on the wrapped RenderKit
object.UIComponent
class.
The default behavior of this method is to call Application.addComponent(String, String)
on the wrapped
Application
object.
Add argument component
, which is assumed to represent a resource instance, as a resource to this view.
Add argument component
, which is assumed to represent a resource instance, as a resource to this view.
ConstraintViolation
to be generated if the
constraint validator marks the value as invalid.ConstraintViolation
to be generated if the
constraint validator mark the value as invalid.ConstraintViolation
to be generated if the
constraint validator marks the value as invalid.ConstraintViolation
to be generated if the
constraint validator mark the value as invalid.ConstraintViolation
to be generated if the
constraint validator mark the value as invalid.ConstraintViolation
to be generated if the
constraint validator marks the value as invalid.ConstraintViolation
to be generated if the
constraint validator mark the value as invalid.ConstraintViolation
to be generated if the
constraint validator mark the value as invalid.ConstraintViolation
to be generated if the
constraint validator marks the value as invalid.ConstraintViolation
to be generated if the
constraint validator mark the value as invalid.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.Context
object with the container.Converter
class.
The default behavior of this method is to call Application.addConverter(String, String)
on the wrapped
Application
object.
The default behavior of this method is to call Application.addConverter(Class, String)
on the wrapped
Application
object.
DataModelListener
to the set interested in notifications from this DataModel
.
Register a validator by its id that is applied to all UIInput
components in a view.
The default behavior of this method is to call Application.addDefaultValidatorId(String)
on the wrapped
Application
object.
ELContextListener
that will be notified on creation
of ELContext
instances.
The default behavior of this method is to call Application.addELContextListener(jakarta.el.ELContextListener)
on the wrapped Application
object.
ELContextListener
s so that context objects can be added whenever a new
ELContext
is created.resolver
to be added to the
resolver chain as specified in section 5.5.1 of the Jakarta Server Faces Specification.
The default behavior of this method is to call
Application.addELResolver(jakarta.el.ELResolver)
on the wrapped Application
object.
ELResolver
to affect the way EL variables and properties are resolved for EL expressions
appearing in JSP pages and tag files.FacesListener
to the set of listeners registered to receive event notifications from this
UIComponent
.FacesListener
to the set of listeners registered to receive event notifications from this
UIComponent
.UIComponentTag
s processing this request.null
values to the first position in the value list.
Add the argument Flow
to the collection of Flow
s known to the current application.
Lifecycle
instance, associated with the specified lifecycleId
, to be supported by
this LifecycleFactory
.AsyncListener
with the most recent asynchronous cycle that was started by a call to one
of the ServletRequest.startAsync()
methods.AsyncListener
with the most recent asynchronous cycle that was started by a call to one
of the ServletRequest.startAsync()
methods.FacesMessage
to the set of messages associated with the specified client
identifier, if clientId
is not null
.FacesContext.addMessage(String, FacesMessage)
on the wrapped
FacesContext
object.createNamedQuery
or
createNamedStoredProcedureQuery
method.JsonValue.NULL
value to the array.JsonValue.NULL
value to the array at the specified position.JsonValue#NULL
pair to the JSON object associated
with this object builder where the value is null
.null
values to the value list.ProcessObserverMethod
containing the given
ObserverMethod
and then registers the
ObserverMethod
with the container, thereby making it available for event
notifications.ObserverMethodConfigurator
to configure a new ObserverMethod
and add it at the end of the observer invocation.ConstraintViolation
will be associated to.PhaseListener
instance that is interested in being notified before and after the processing
for standard phases of the request processing lifecycle.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.ConstraintViolation
will be associated to.
Add the argument urlPattern
to the thread safe Set
of protected views for this application.
ViewHandler.addProtectedView(java.lang.String)
on the wrapped
ViewHandler
object.RenderKit.addRenderer(String, String, Renderer)
on the wrapped
RenderKit
object.RenderKit
instance, associated with the specified renderKitId
, to be
supported by this RenderKitFactory
, replacing any previously registered RenderKit
for this
identifier.Adds the cookie represented by the arguments to the response.
ExternalContext.addResponseCookie(String, String, Map)
on the
wrapped ExternalContext
object.Add the given name and value to the response header.
ExternalContext.addResponseHeader(String,String)
on the
wrapped ExternalContext
object.
Add another MetaRule
to this ruleset, returning this
.
Cause the argument resolver
to be added to the head of the resolver chain.
PersistenceUnitInfo.getClassLoader()
method.Validator
class.
The default behavior of this method is to call Application.addValidator(String, String)
on the wrapped
Application
object.
Validator
instance to the set associated with this component.ValueChangeListener
to the set of listeners interested in being notified when
ValueChangeEvent
s occur.ValueChangeListener
to the set of listeners interested in being notified when
ValueChangeEvent
s occur.Validator
.Bean
and ObserverMethod
objects for the discovered beans, but before detecting deployment
problems.afterBegin
method notifies a stateful session bean instance that a new transaction has started, and
that the subsequent business methods on the instance will be invoked in the context of the transaction.afterCompletion
method notifies a stateful session bean instance that a transaction commit protocol
has completed, and tells the instance whether the transaction has been committed or rolled back.
An instance of this class is added as a
ClientBehavior
to a component using the
ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior)
contract that components implement.
Ajax
).Construct a new event object from the specified source component and Ajax behavior.
Construct a new event object from the Faces context, specified source component and Ajax behavior.
By implementing this class, an object indicates that it is a listener for one or more kinds of
BehaviorEvent
s.
Customize this MetaRuleset
by removing the attribute named by argument attribute
and
re-adding it under the name given by the argument property
, returning this
.
This unmodifiable Collection is returned by getIdsToVisit()
and getSubtreeIdsToVisit()
in
cases where all ids should be visited.
The value that when used with PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME
or PartialViewContext.PARTIAL_RENDER_PARAM_NAME
indicates
these phases must be skipped.
Alternative
annotation.If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, validation must be performed, even when there is no corresponding value for this component in the incoming request.
AnnotatedTypeConfigurator
SPI and helps defining an AnnotatedConstructor
AnnotatedTypeConfigurator
SPI and helps defining an AnnotatedField
AnnotatedTypeConfigurator
SPI and helps defining an AnnotatedMethod
AnnotatedTypeConfigurator
SPI and helps defining an AnnotatedParameter
AnnotatedType
instance.Any
qualifier.String
constant representing "application/atom+xml" media type.MediaType
constant representing "application/atom+xml" media type.ApplicationFactory
class name.String
constant representing "application/x-www-form-urlencoded" media type.MediaType
constant representing "application/x-www-form-urlencoded" media type.String
constant representing "application/json" media type.String
representation of "application/json-patch+json" media type..MediaType
constant representing "application/json-patch+json" media type.MediaType
constant representing "application/json" media type.String
constant representing "application/octet-stream" media type.MediaType
constant representing "application/octet-stream" media type.String
constant representing "application/svg+xml" media type.MediaType
constant representing "application/svg+xml" media type.String
constant representing "application/xhtml+xml" media type.MediaType
constant representing "application/xhtml+xml" media type.String
constant representing "application/xml" media type.MediaType
constant representing "application/xml" media type.
This class defines a java.util.ServiceLoader
service which enables programmatic configuration of the Jakarta
Server Faces runtime using the existing Application Configuration Resources schema.
Application
instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
Object>
causes the map returned from ExternalContext.getApplicationMap()
to be
injected as the value of that field.
Path
.jakarta.enterprise.context.ApplicationScoped
, which is a CDI build-in
scope with similar semantics.ApplicationScoped
annotation.
Provides a simple implementation of Application
that can be
subclassed by developers wishing to provide specialized behavior to an existing Application
instance.
If this application has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Calls apply on any child handlers.
The default implementation simply calls through to TagHandlerDelegate.apply(jakarta.faces.view.facelets.FaceletContext, jakarta.faces.component.UIComponent)
.
Process changes on a particular UIComponent
Called by classes that implement
FaceletHandler
in their implementation of apply()
.
target
.target
.
Take the argument parent
and apply this attached object to it.
Take the necessary actions to apply the attached object represented by the tag for the concrete subclass of this
class to the argument parent
.
Take the action prescribed in the Jakarta Server Faces specification for this particular VDL element attribute.
Invoke the apply()
method on this instance's TagHandler.nextHandler
.
Return an abstraction that takes appropriate action given the kind of rule represented by the argument
name
, in the context of this particular concrete subclass of MetaRule
.
Nonbinding
.Nonbinding
.DataModel
that wraps an array of Java
objects.ArrayDataModel
with no specified wrapped data.ArrayDataModel
wrapping the specified array.ArrayELResolver
.ArrayELResolver
whose read-only status is determined by the given parameter.AssertFalse
annotations on the same element.AssertTrue
annotations on the same element.AsyncContext.dispatch(String)
or AsyncContext.dispatch(ServletContext,String)
HttpServletMapping
is made
available to the target of a AsyncContext.dispatch(String)
or AsyncContext.dispatch(ServletContext,String)
AsyncContext.dispatch(String)
or AsyncContext.dispatch(ServletContext,String)
AsyncContext.dispatch(String)
or AsyncContext.dispatch(ServletContext,String)
AsyncContext.dispatch(String)
or AsyncContext.dispatch(ServletContext,String)
AsyncContext.dispatch(String)
or AsyncContext.dispatch(ServletContext,String)
ServletRequest.startAsync()
or ServletRequest.startAsync(ServletRequest, ServletResponse)
) has
completed, timed out, or produced an error.Future
object, preserving compatability with the
business interface signature.AsyncResult
instance to wrap the result of an asynchronous method callList
or array.List
or arrayList
or array.Map
.Map
.Map
.
The key in the value set of the composite component BeanDescriptor
, the value for which is a
List<AttachedObjectTarget>
.
The abstract base interface for a handler representing an attached object in a VDL page.
Within the declaration of a composite component, an AttachedObjectTarget
allows the
composite component author to expose the semantics of an inner component to the page author without
exposing the rendering or implementation details of the inner component.
Create or restore the ClientWindow
to be used to display the UIViewRoot
for
this run through the lifecycle.
An interface that allows other code to identify FaceletHandlers that correspond to component attributes.
Basic
(whether
explicit or default) property or field or Id
property or
field.This constant enables one to quickly discover the names of the declared composite component attributes that have been given default values by the composite component author.
AuthConfigProvider
objects that can be used to obtain authentication
context configuration objects, that is, ClientAuthConfig
and ServerAuthConfig
objects.ClientAuthConfig
or ServerAuthConfig
objects.ServletContext
to authenticate the user making this
request.AuthenticationException
exception with null
as its detail message.AuthenticationException
exception with the specified detail message.AuthenticationException
exception with the specified detail message and cause.AuthenticationException
exception with the specified cause.HttpAuthenticationMechanism
to indicate the result (status)
of the authentication process.jakarta.servlet.http.registerSession
and auto applies this for every request.bad client request
.BasicAuthenticationCredential
extends UsernamePasswordCredential
to represent credentials used by HTTP Basic Authentication.BasicType
represent basic types (including
temporal and enumerated types).BeanAttributes
instance.Bean
instance.BeanELResolver
.BeanELResolver
whose read-only status is determined by the given parameter.
The value of this constant is used as the key in the component attribute map, the value for which is a
java.beans.BeanInfo
implementation describing the composite component.
ELResolver
for resolving user or container managed beans.A Validator that delegates validation of the bean property to the Bean Validation API.
beforeCompletion
method notifies a stateful session bean instance that a transaction is about to be
committed.BeforeDestroyed
qualifier.The Behavior interface is the root API of the component behavior model.
The request parameter name whose request parameter value identifies the type of behavior event.
The standard id for this behavior.
The request parameter name whose request parameter value identifies the source component of behavior event.
BehaviorBase is a convenience base class that provides a default implementation of the
Behavior
contract.
Convey the id of a behavior declared in a view.
Behavior
.
Construct a new event object from the specified source component and behavior
.
Construct a new event object from the Faces context, specified source component and behavior.
The FaceletHandler
that corresponds to attached objects that represent an instance of
ClientBehavior
that must be added to the parent component, which must
implement ClientBehaviorHolder
, with a call to
ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior)
.
Represent an attached object that is a BehaviorHolder
in a VDL page.
Represent a BehaviorHolder
attached object target in a VDL page.
A generic base interface for event listeners for various types of BehaviorEvent
s.
Converter
implementation for java.math.BigDecimal
values.BigDecimal
object.FacesMessage
to be created if the conversion to
BigInteger
fails.Converter
implementation for java.math.BigInteger
values.BigInteger
object.BigInteger
object.Bindable
represent object or attribute types
that can be bound into a Path
.bodyContent
for this tag handler.FacesMessage
to be created if the conversion to
Boolean
fails.Converter
implementation for java.lang.Boolean
(and boolean primitive) values.META-INF/validation.xml
.Configuration
.
Broadcast the specified BehaviorEvent
to all registered event listeners who have expressed an interest in
events of this type.
Default implementation of Behavior.broadcast(jakarta.faces.event.BehaviorEvent)
.
UIComponent.broadcast(jakarta.faces.event.FacesEvent)
processing, pass the ActionEvent
being broadcast
to the method referenced by actionListener
(if any), and to the default ActionListener
registered on the Application
.FacesEvent
to all registered event listeners who have expressed an interest in events
of this type.UIComponentBase.broadcast(jakarta.faces.event.FacesEvent)
processing to unwrap any wrapped FacesEvent
and reset
the current row index, before the event is actually broadcast.
Enable the method invocation specified by this component instance to return a value that performs navigation, similar
in spirit to UICommand.broadcast(jakarta.faces.event.FacesEvent)
.
SseEventSink
instances.Broadcast any events that have been queued.
Jsonb
based on the
parameters and configuration specified previously in this builder.OutboundSseEvent
.web target
.ValidatorFactory
instance based on the
default Jakarta Bean Validation provider and following the XML configuration.ValidatorFactory
implementation.ValidatorFactory
using the current provider implementation.
Take any actions specific to this VDL implementation to cause the argument
UIViewRoot
which must have been created via a call to ViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String)
, to be populated with
children.
Configuration
.Configuration
for a particular provider implementation.FacesMessage
to be created if the conversion to
Byte
fails.Converter
implementation for java.lang.Byte
(and byte primitive) values.persistence.xml
caching element
is ENABLE_SELECTIVE
or DISABLE_SELECTIVE
.jakarta.persistence.cache.retrieveMode
property to
specify the behavior when data is retrieved by the
find
methods and by queries.jakarta.persistence.cache.storeMode
property to specify
the behavior when data is read from the database and when data is
committed into the database.ViewHandler.calculateCharacterEncoding(jakarta.faces.context.FacesContext)
on the wrapped ViewHandler
object.Locale
to use for this and subsequent requests for the current client.ViewHandler.calculateLocale(jakarta.faces.context.FacesContext)
on the wrapped ViewHandler
object.renderKitId
for this and subsequent requests from the current client.ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext)
on the wrapped ViewHandler
object.
Return the list of resource library contracts that will be made available for use in the view specified by the
argument viewId
.
CallerOnlyCredential
represents a credential that only
contains a caller name and no secret of any kind.FacesMessage
to be created if the conversion to
Character
fails.Converter
implementation for java.lang.Character
(and char primitive) values.charset
parameter name.PersistenceUnitInfo.addTransformer
method.
The default behavior of this method is to call Map.clear()
on the wrapped Flash
object.
Clears the initial state flag, causing the behavior to revert from partial to full state saving.
Reset the PartialStateHolder to a non-delta tracking state.
An implementation of PartialStateHolder.clearInitialState()
, this method is called by the runtime to tell the
instance to stop tracking state changes.
For each of the attached objects on this instance that implement PartialStateHolder
, call
PartialStateHolder.clearInitialState()
on the attached object.
ClientWindowFactory
class name.
The context-param that controls the operation of the ClientWindow
feature.
The name of the hidden field that refers to the encoded ClientWindow.
The name of the URL query parameter for transmitting the client window id.
ClientBehavior is the base contract for Behavior
s that attach script content to client-side
events exposed by ClientBehaviorHolder
components.
ClientBehaviorBase is a convenience base class that implements the default concrete behavior of all
methods defined by ClientBehavior
.
ClientBehaviorContext provides context information that may be useful
to ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext)
implementations.
Parameter instances represent name/value pairs that "submitting" ClientBehavior implementations should include when posting back into the Faces lifecycle.
An enum that specifies hints that describes the behavior of ClientBehavior implementations.
The ClientBehaviorHolder interface may be implemented by any concrete
UIComponent
that wishes to support client behaviors as defined by
ClientBehavior
.
ClientBehavior
's client-side logic.Client
instances.ClientBuilder
class.ClientEndpointConfig
objects for the
purposes of deploying a client endpoint.4xx
status codes).
This class represents a client window, which may be a browser tab, browser window, browser pop-up, portlet, or
anything else that can display a UIComponent
hierarchy rooted at a
UIViewRoot
.
Create ClientWindow
instances based on the incoming request.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Allow for flow transitions in the case of components rendered by the renderers from component-family
jakarta.faces.OutcomeTarget
.
Wrapper for ClientWindow
If this client window has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Clock
used as the reference for now
when
validating the @Future
and @Past
constraints.ClockProvider
implementation used by the Validator
.java.lang.Object.clone
method to return a copy of this Cookie.ResponseWriter
, using the specified Writer
as the
output destination.ResponseWriter.cloneWithWriter(java.io.Writer)
on the wrapped
ResponseWriter
object.Writer.close()
on the wrapped ResponseWriter
object.ValidatorFactory
instance.SseEventSink
instances.SseEventSink
instance and release all associated resources.CollectionAttribute
represent persistent
java.util.Collection
-valued attributes.
CollectionDataModel is a convenience implementation of DataModel
that wraps an
Collection
of Java objects.
CollectionDataModel
with no specified wrapped data.CollectionDataModel
wrapping the specified list.CollectionJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.Collection
.SqlResultSetMapping
annotation or
ConstructorResult
annotation to map a column of the SELECT
list of a SQL query.CommonAbstractCriteria
interface defines functionality
that is common to both top-level criteria queries and subqueries as
well as to update and delete criteria operations.FacesMessage.Severity
instance to the specified one.PhaseId
instance to the specified one.true
if the new value is different from the previous value.true
if the new value is different from the previous value.CompletionStage
.
This constant is used as the key in the component attribute map of a composite component to associate the component
with its Resource
instance.
Passed to the constructor of ComponentHandler
.
Public base class for markup element instances that map to
UIComponent
instances in the view.
Leverage the TagHandlerDelegateFactory
provided by the implementation to create an instance of
TagHandlerDelegate
designed for use with ComponentHandler
.
Typed FacesException
for the SearchExpressionHandler
, if a component can't be resolved.
Construct a new exception with no detail message or root cause.
Construct a new exception with the specified detail message and no root cause.
Construct a new exception with the specified root cause.
Construct a new exception with the specified detail message and root cause.
SystemEvent
s that are specific to a UIComponent
instance.
Pass the argument component
to the superclass constructor.
Pass the argument component
to the superclass constructor.
Implementors of this class do not need an isListenerForSource()
method because they are only installed
on specific component instances, therefore the isListenerForSource()
method is implicit.
The value of this constant is used as the key in the composite component BeanDescriptor for a
ValueExpression
that evaluates to the component-type
of the composite component
root UIComponent
for this composite component, if one was declared by the composite component
author.
The value of this constant is used as the key in the Map
returned as described in UIComponent.FACETS_KEY
for the PropertyDescriptor
describing the composite component facet.
Map
returned by the composite component
ELResolver
, described in section 5.6.2.2 of the specification, when evaluating
#{cc.attrs}
expressions.ELResolver
s.A FaceletHandler that is derived of 1 or more, inner FaceletHandlers.
CompoundSelection
interface defines a compound selection item
(tuple, array, or result of constructor).ConcurrencyManagement
annotation for a singleton session bean.Set the if of the current navigation case.
Set the if of the current navigation case.
Set the if in the previously created switch case.
Set the if in the previously created switch case.
/WEB-INF/faces-config.xml
which is loaded automatically if it exists) containing Jakarta Server Faces
configuration information.
ConfigurableNavigationHandler extends the contract of
NavigationHandler
to allow runtime inspection of the NavigationCase
s that make up the rule-base for
navigation.
Provides a simple implementation of ConfigurableNavigationHandler
that can be subclassed by developers wishing to provide specialized behavior to an existing
ConfigurableNavigationHandler
instance.
If this configurable navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ValidatorFactory
.configurable
JAX-RS context.AnnotatedTypeConfigurator
to to configure the AnnotatedType
used to create the InjectionTarget
.AnnotatedTypeConfigurator
initialized with the AnnotatedType
created either for the class
passed to BeanManager.createInterceptionFactory(CreationalContext, Class)
or derived from the
InterceptionFactory
parameter injection point.Configuration
implementation.T
and delegates
the creation of this specific Configuration
subclass to the provider.runtime configuration
scope of a particular
resource or sub-resource method
; i.e.AnnotatedTypeConfigurator
initialized with the AnnotatedType
processed by this event
to configure a new AnnotatedType that will replace the original one at the end of the observer invocation.BeanAttributesConfigurator
initialized with the BeanAttributes
processed by this event
to configure a new BeanAttributes that will replace the original one at the end of the observer invocation.InjectionPointConfigurator
initialized with the InjectionPoint
processed by this event
to configure a new InjectionPoint that will replace the original one at the end of the observer invocation.AnnotatedTypeConfigurator
to configure a new AnnotatedType
and declares it as an interceptor binding type.ObserverMethodConfigurator
initialized with the ObserverMethod
processed by this event,
to configure a new ObserverMethod that will replace the original one at the end of the observer invocation.ProducerConfigurator
initialized with the Producer
processed by this event, to configure a new
Producer
that will replace the original one at the end of the observer invocation.AnnotatedTypeConfigurator
to configure a new AnnotatedType
and declares it as a Qualifier qualifier type.asynchronous
response
lifecycle events.A
for a given object type T
.ConstraintViolation
builder allowing to optionally associate
the violation report to a sub path.ConstraintValidator
instance based off its class.Validator
.SqlResultSetMapping
annotation to map the SELECT
clause of a SQL query to a constructor.MessageBodyReader
can accept.
The default behavior of this method is to call Map.containsKey(Object)
on the wrapped Flash
object.
The default behavior of this method is to call Map.containsValue(Object)
on the wrapped Flash
object.
true
if there is a value at the referenced location in the specified target
.ELContext
has been created.ConversationScoped
annotation.FacesMessage
to be created if a conversion error
occurs, and neither the page author nor the ConverterException
provides a message.
A Facelet version of the Jakarta Server Pages ConverterTag
.
Converter
instance on the ValueHolder
associated with our most immediate surrounding instance
of a tag whose implementation class is a subclass of UIComponentClassicTagBase
.getAsObject()
or
getAsText()
method of a Converter
, to indicate that the requested conversion cannot be
performed.
Handles setting a Converter
instance on a ValueHolder
parent.
ConverterELTag
. The remainder of the functionality, namely,
the binding facility and the implementation of the ConverterTag.createConverter()
method, is now an implementation detail.from
to group to
during cascading.ConvertGroup
annotations
on the same element.Convert
annotations.Jsonb
instance using the default
JsonbBuilder
implementation provided as returned from
JsonbProvider.provider()
method.Jsonb
instance using the default
JsonbBuilder
implementation provided as returned from
JsonbProvider.provider()
method, configured
with provided configuration.JsonbBuilder
class.null
configurator.AnnotatedType
that may be used to read the annotations of the given class or interface.collection
.JsonArrayBuilder
instance that is used to build
JsonArray
JsonArrayBuilder
instance, initialized with an array.JsonArrayBuilder
instance,
initialized with the content of specified collection.collection
.BeanAttributes
for the given AnnotatedType
.BeanAttributes
for the given AnnotatedType
.Behavior
instance of the class specified
by a previous call to addBehavior()
for the specified behavior id.
The default behavior of this method is to call Application.createBehavior(String)
on the wrapped
Application
object.
Create and return a TagHandlerDelegate
instance designed for use with BehaviorHandler
.
JsonArrayBuilder
and JsonObjectBuilder
objects.JsonArrayBuilder
and JsonObjectBuilder
objects.Creates a ClientBehaviorContext instance.
UIComponent
instance of the class
specified by a previous call to addComponent()
for the specified component type.Application.createComponent(jakarta.el.ValueExpression,jakarta.faces.context.FacesContext,java.lang.String)
.
Like Application.createComponent(ValueExpression, FacesContext, String)
except the Renderer
for the
component to be returned must be inspected for the annotations mentioned in
Application.createComponent(ValueExpression, FacesContext, String)
as specified in the documentation for that method.
Like Application.createComponent(String)
except the Renderer
for the component to be returned must be
inspected for the annotations mentioned in Application.createComponent(ValueExpression, FacesContext, String)
as
specified in the documentation for that method.
Instantiate and return a new UIComponent
instance from the
argument Resource
.
The default behavior of this method is to call Application.createComponent(String)
on the wrapped
Application
object.
The default behavior of this method is to call
Application.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String)
on the
wrapped Application
object.
The default behavior of this method is to call
Application.createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String, String)
on the wrapped Application
object.
The default behavior of this method is to call
Application.createComponent(jakarta.faces.context.FacesContext, String, String)
on the wrapped
Application
object.
The default behavior of this method is to call
Application.createComponent(jakarta.faces.context.FacesContext, Resource)
on the wrapped Application
object.
Subclasses that wish to take over the task of instantiating the UIComponent
instance corresponding to
this tag handler my override this method to do so.
Create a component given a ViewDeclarationLanguage
specific tag library URI and tag name.
getComponentType()
.getComponentType()
.createComponent
using Faces 1.1 EL API.
Create and return a TagHandlerDelegate
instance designed for use with ComponentHandler
.
EntityManagerFactory
is to be created.Converter
instance of the class
specified by a previous call to addConverter()
for the specified converter id.Converter
instance of the class that
has registered itself as capable of performing conversions for objects of the specified type.
The default behavior of this method is to call Application.createConverter(String)
on the wrapped
Application
object.
The default behavior of this method is to call Application.createConverter(Class)
on the wrapped
Application
object.
Converter
to be registered on our surrounding UIComponent
.Converter
to be registered on our surrounding UIComponent
.
Create and return a TagHandlerDelegate
instance designed for use with ConverterHandler
.
CreationalContext
for the given
contextual type, or for a non-contextual object.CriteriaDelete
query object to perform a bulk delete operation.CriteriaUpdate
query object to perform a bulk update operation.JsonStructure
.JsonStructure
.EntityManager
.EntityManager
with the
specified Map of properties.EntityManager
with the
specified synchronization type.EntityManager
with the
specified synchronization type and map of properties.Persistence
class when an
EntityManagerFactory
is to be created.
Create the singleton instance of FlowHandler
.
JsonGenerator
objects.JsonGenerator
instances.Configuration
instance.RuntimeDelegate.HeaderDelegate
for the supplied class.InjectionPoint
for the given AnnotatedField
.InjectionPoint
for the given AnnotatedParameter
.InjectionTarget
for the given AnnotatedType
.Instance
object to access to beans instances.InterceptionFactory
for the given CreationalContext
and type.Link.Builder
.AsyncListener
class.JsonValue
s
which when applied to the source
, yields the target
.JsonValue
s
which when applied to the source
, yields the target
.JsonValue
.JsonValue
.
Creates a new UIViewRoot
containing only view parameter metadata.
The default implementation simply calls through to TagHandlerDelegate.createMetaRuleset(java.lang.Class)
and returns the
result.
Return a MetaRuleset
particular to this kind of tag handler.
Application.getExpressionFactory()
then
ExpressionFactory.createMethodExpression(jakarta.el.ELContext, java.lang.String, java.lang.Class<?>, java.lang.Class<?>[])
.MethodExpression
for later evaluation.Query
for executing a named query
(in the Jakarta Persistence query language or in native SQL).TypedQuery
for executing a
Jakarta Persistence query language named query.StoredProcedureQuery
for executing a
stored procedure in the database.Query
for executing
a native SQL statement, e.g., for update or delete.Query
for executing
a native SQL query.Query
for executing
a native SQL query.map
.JsonObjectBuilder
instance that is used to build
JsonObject
.JsonObjectBuilder
instance, initialized with an object.JsonObjectBuilder
instance, initialized with the specified object.map
.JsonParser
objects.JsonParser
instances.jsonPointer
string.jsonPointer
string.CriteriaQuery
object.CriteriaQuery
object with the specified result
type.Query
for executing a
Jakarta Persistence query language statement.TypedQuery
for executing a
criteria query.Query
for executing a criteria
update query.Query
for executing a criteria
delete query.TypedQuery
for executing a
Jakarta Persistence query language statement.JsonReader
objects.JsonReader
objects.
Create an instance of ViewResource
given the argument
resourceName
.
Create an instance of Resource
with a resourceName given by
the value of the argument resourceName
that is a member of the library named by the argument
libraryName
.
Create an instance of Resource
with a resourceName
given by the value of the argument resourceName
that is a member of the library named by the argument
libraryName
that claims to have the content-type given by the argument content-type
.
The default behavior of this method is to call ResourceHandler.createResource(String)
on the wrapped
ResourceHandler
object.
The default behavior of this method is to call ResourceHandler.createResource(String, String)
on the wrapped
ResourceHandler
object.
The default behavior of this method is to call ResourceHandler.createResource(String, String, String)
on the
wrapped ResourceHandler
object.
Create an instance of Resource
given the argument resourceId
.
The default behavior of this method is to call ResourceHandler.createResourceFromId(String)
on the wrapped
ResourceHandler
object.
Response.ResponseBuilder
.OutputStream
to create a new ResponseStream
instance.RenderKit.createResponseStream(java.io.OutputStream)
on the
wrapped RenderKit
object.Writer
to create a new ResponseWriter
instance for the specified (optional)
content type, and character encoding.RenderKit.createResponseWriter(java.io.Writer, String, String)
on the wrapped RenderKit
object.
Creates a SearchExpressionContext
instance for use with the SearchExpressionHandler
.
Creates a SearchExpressionContext
instance for use with the SearchExpressionHandler
.
StoredProcedureQuery
for executing a
stored procedure in the database.StoredProcedureQuery
for executing a
stored procedure in the database.StoredProcedureQuery
for executing a
stored procedure in the database.CriteriaQuery
object that returns a tuple of
objects as its result.Generate an identifier for a component.
UriBuilder
.Validator
instance of the class
specified by a previous call to addValidator()
for the specified validator id.
The default behavior of this method is to call Application.createValidator(String)
on the wrapped
Application
object.
Validator
to be registered on our surrounding UIComponent
.Validator
to be registered on our surrounding UIComponent
.
Create and return a TagHandlerDelegate
instance designed for use with ValidatorHandler
.
Application.getExpressionFactory()
then
ExpressionFactory.createValueExpression(jakarta.el.ELContext, java.lang.String, java.lang.Class<?>)
.
The default behavior of this method is to call Application.createValueBinding(String)
on the wrapped
Application
object.
ValueExpression
for later evaluation.Variant.VariantListBuilder
.Application
instance to create a new component with the following characteristics.UIViewRoot
instance initialized with
information from the argument FacesContext
and viewId
.ViewHandler.createView(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.
Create a UIViewRoot
from the VDL contained in the artifact
referenced by the argument viewId
.
Create an instance of Resource
given the argument resourceName
, which may contain "/"
characters.
The default behavior of this method is to call ResourceHandler.createViewResource(jakarta.faces.context.FacesContext, java.lang.String)
on the wrapped
ResourceHandler
object.
UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)
.UIComponent.visitTree()
.JsonWriter
objects.JsonWriter
objects.Contextual
implementation during instance
creation and destruction.Credential
represents the credential the caller will use to authenticate.CredentialValidationResult
is the result from an attempt to
validate an instance of Credential
.CriteriaDelete
interface defines functionality for performing
bulk delete operations using the Criteria APICriteriaQuery
interface defines functionality that is specific
to top-level queries.CriteriaUpdate
interface defines functionality for performing
bulk update operations using the Criteria API.FacesMessage
to be created if the conversion to
Number
fails.jakarta.enterprise.context.spi.Context
. See 2.4.2
and 6.2 of the CDI specification for further details.IdentityStore
that
stores caller credentials and identity attributes in a relational database,
and make that implementation available as an enabled CDI bean.UIData
.DataModel
.DataModelEvent
s
occurring on a particular DataModel
instance.DataSource
to
be registered with JNDI.DataSourceDefinition
annotations.FacesMessage
to be created if the conversion to
Date
fails.FacesMessage
to be created if the conversion to
DateTime
fails.Converter
implementation for
java.util.Date
values.If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, Application.createConverter() must guarantee that the default for the timezone of all jakarta.faces.convert.DateTimeConverter instances must be equal to TimeZone.getDefault() instead of "GMT".
FacesMessage
to be created if the conversion to
BigDecimal
fails.DecimalMax
annotations on the same element.DecimalMin
annotations on the same element.types
for a given element.isUserInRole
.
Decode any new state of this ClientBehavior
from the request contained in the specified FacesContext
.
Default implementation of of ClientBehavior.decode(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
.
UIComponent
from the request contained in the specified FacesContext
,
and store this state as needed.
Override behavior from the superclass to queue an ActionEvent
that may result in the invocation of the
action
or any actionListener
s that may be associated with this instance.
Override behavior from superclass to pull a value from the incoming request parameter map under the name given by
UIViewParameter.getName()
and store it with a call to UIInput.setSubmittedValue(java.lang.Object)
.
The implementation is responsible for examining the incoming request and extracting the value that must be returned
from the ClientWindow.getId()
method.
Decode any new state of this ClientBehavior
from the request contained in the specified FacesContext
.
UIComponent
from the request contained in the specified
FacesContext
, and store that state on the UIComponent
.Default
qualifier.The value to use for the default extension for Facelet based XHTML pages if the webapp is using url extension mapping.
Lifecycle
instance for this Jakarta Server Faces implementation.Locale
.Locale
.The value to use for the default extension if the webapp is using url extension mapping.
If the method is a void method, or the method returns null
, this can be used to specify what value should be
passed to runtime when the method returns.
If the method is a void method, or the method returns null
, this can be used to specify what value should be
passed to runtime when the method returns.
Set the default outcome of the current switch.
Set the default outcome of the current switch.
PathParam
, QueryParam
, MatrixParam
,
CookieParam
, FormParam
, or HeaderParam
.
Enable the Jakarta Server Faces implementation to provide the
appropriate behavior for the kind of MetaTagHandler
subclass for each kind of element in the view, while
providing a base-class from which those wanting to make a Java language custom tag handler can inherit.
Write a delete operation.
Dependent
annotation.Derive and return the viewId from the current request, or the argument input by following the algorithm defined in specification section 7.6.2.
The default behavior of this method is to call
ViewHandler.deriveLogicalViewId(jakarta.faces.context.FacesContext, String)
on the wrapped
ViewHandler
object.
Derive and return the viewId from the current request, or the argument input by following the algorithm defined in specification section 7.6.2.
ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.JsonParser
.JsonParser
.Destroyed
qualifier.Digits
annotations on the same element.
If this param is defined, and calling toLowerCase().equals(“true”)
on a String
representation of its value returns true
, the runtime must not automatically add the validator with
validator-id equal to the value of the symbolic constant BeanValidator.VALIDATOR_ID
to the list of default validators.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, the default ViewHandler must behave as specified in the latest 1.2 version of this specification.
The ServletContext
init parameter consulted by the runtime to tell if the automatic mapping of the
FacesServlet
to the extension *.xhtml
should be disabled.
Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first before rendering those URLs.
ConstraintViolation
object generation (which
is using the message template declared on the constraint).ExternalContext.dispatch(String)
on the wrapped
ExternalContext
object.service
method) to allow a servlet to handle a DELETE request.doFilter
method of the Filter is called by the container each time a request/response pair is passed
through the chain due to a client request for a resource at the end of the chain.doFilter
method of the Filter is called by the container each time a request/response pair is passed
through the chain due to a client request for a resource at the end of the chain.doFilter
method of the Filter is called by the container each time a request/response pair is passed
through the chain due to a client request for a resource at the end of the chain.service
method) to allow a servlet to handle a GET request.service
method and handles the request.service
method) to allow a servlet to handle a OPTIONS request.service
method) to allow a servlet to handle a POST request.Called after the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.
The default behavior of this method is to call Flash.doPostPhaseActions(FacesContext)
on the wrapped
Flash
object.
Called before the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle.
The default behavior of this method is to call Flash.doPrePhaseActions(FacesContext)
on the wrapped
Flash
object.
service
method) to allow a servlet to handle a PUT request.UIComponent
instance associated with our most
immediately surrounding UIComponentTag
instance, if this UIComponent
does not already have a value
for the specified attribute name.Converter
class, and register it with the UIComponent
instance
associated with our most immediately surrounding UIComponentClassicTagBase
instance, if the
UIComponent
instance was created by this execution of the containing Jakarta Server Pages page.Converter
class, and register it with the UIComponent
instance
associated with our most immediately surrounding UIComponentTag
instance, if the UIComponent
instance
was created by this execution of the containing Jakarta Server Pages page.EVAL_BODY_INCLUDE
to cause nested body content to be evaluated.UIComponent
instance in the view corresponding to
this tag instance in the page and, if and only if a component was created, insert it into the tree at the proper
location as expected by the page author.Validator
class, and register it with the UIComponent
instance
associated with our most immediately surrounding UIComponentTagBase
instance, if the UIComponent
instance was created by this execution of the containing Jakarta Server Pages page.Validator
class, and register it with the UIComponent
instance
associated with our most immediately surrounding UIComponentTag
instance, if the UIComponent
instance
was created by this execution of the containing Jakarta Server Pages page.service
method) to allow a servlet to handle a TRACE request.FacesMessage
to be created if the conversion to
Double
fails.Converter
implementation for java.lang.Double
(and double primitive) values.Validator
that checks the value of the corresponding component against specified minimum and maximum values.Validator
with no preconfigured limits.Validator
with the specified preconfigured limit.Validator
with the specified preconfigured limits.double
.ValueChangeEvent
s
and Validator
s.
A VDL handler that exposes Validator
or
ValueChangeListener
to a page author.
A marker interface for VDL tags that represent <composite:editableValueHolder/>
for use by the
composite component page author.
EJB
annotations.ELContext
has been created.ELContext
has been created.ELContext
is created.ELException
with no detail message.ELException
with the provided detail message.ELException
with the given cause.ELException
ELException
@Email
constraints on the same element.EmbeddableType
represent embeddable types.The name of a context parameter that indicates how empty strings need to be interpreted.
The regular expression pattern that identifies an empty list of validation groups.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns
true
take the additional actions relating to <validateWholeBean />
specified in
BeanValidator.validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)
.
Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first after rendering those URLs.
ExternalContext.encodeActionURL(String)
on the wrapped
ExternalContext
object.true
from UIComponent.isRendered()
, take the following action.
Called specially by UIViewRoot.encodeEnd(jakarta.faces.context.FacesContext)
, this method simply sets the submitted value to be the return from
UIViewParameter.getStringValue(jakarta.faces.context.FacesContext)
.
rendered
property is true
, render the
beginning of the current state of this UIComponent
to the response contained in the specified
FacesContext
.UIComponentBase.encodeBegin(jakarta.faces.context.FacesContext)
behavior.UIComponent
to the output stream or writer associated with the response we are
creating.The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl.
ExternalContext.encodeBookmarkableURL(String, java.util.Map)
on the wrapped
ExternalContext
object.
If PartialViewContext.isAjaxRequest()
returns true
, perform partial
rendering by calling PartialViewContext.processPartial(jakarta.faces.event.PhaseId)
with
PhaseId.RENDER_RESPONSE
.
UIComponent
, following the rules described for encodeBegin()
to acquire the appropriate value to be rendered.QueryParam
, PathParam
, FormParam
or MatrixParam
.
If UIViewRoot.getAfterPhaseListener()
returns non-null
, invoke it,
passing a PhaseEvent
for the PhaseId.RENDER_RESPONSE
phase.
UIComponent
, following the rules described for
encodeBegin()
to acquire the appropriate value to be rendered.ExternalContext.encodeNamespace(String)
on the wrapped
ExternalContext
object.Return the input URL, after performing any rewriting needed to ensure that it can be used in a partial page submission (ajax request) to correctly identify an addressable action in the current application.
ExternalContext.encodePartialActionURL(String)
on the wrapped
ExternalContext
object.ExternalContext.encodeRedirectURL(String, java.util.Map)
on the wrapped
ExternalContext
object.sendRedirect
method or, if encoding is not needed, returns the
URL unchanged.HttpServletResponseWrapper.encodeRedirectURL(String url)
insteadExternalContext.encodeResourceURL(String)
on the wrapped
ExternalContext
object.HttpServletResponseWrapper.encodeURL(String url)
insteadExternalContext.encodeWebsocketURL(String)
on the wrapped
ExternalContext
object.toJson()
methods will default to this property
for encoding of output JSON data.Variant.VariantListBuilder
initialized with a set of supported encodings.
Close an XML CDATA
block.
The default behavior of this method is to call ResponseWriter.endCDATA()
on the wrapped ResponseWriter
object.
Write the end of a partial response.
ResponseWriter.endDocument()
on the wrapped
ResponseWriter
object.startElement()
.ResponseWriter.endElement(String)
on the wrapped
ResponseWriter
object.Write the end of an error.
Write the end of an eval operation.
Write the end of an extension operation.
Write the end of an insert operation.
Write the end of an update operation.
EntityManager.persist(Object)
is called and the entity already exists.EntityExistsException
exception with
null
as its detail message.EntityExistsException
exception with the
specified detail message.EntityExistsException
exception with the
specified detail message and cause.EntityExistsException
exception with the
specified cause.EntityManager.getReference
is accessed but the entity does not exist.EntityNotFoundException
exception with
null
as its detail message.EntityNotFoundException
exception with the
specified detail message.SqlResultSetMapping
annotation to map the SELECT
clause of a SQL query to an entity result.EntityTag
.EntityTag
.EntityType
represent entity types.
The default behavior of this method is to call Map.entrySet()
on the wrapped Flash
object.
FacesMessage
to be created if the conversion to
Enum
fails.FacesMessage
to be created if the conversion to
Enum
fails and no target class has been provided.Converter
implementation for
java.lang.Enum
(and enum primitive) values.Expression
.Overrides the default equals method to take the minimum and maximum into account when comparing DoubleRangeValidator instances.
JsonNumber
object for
equality.JsonString
for equality.obj
to this tag to see if they are the same considering weakness and value.obj
to this media type to see if they are the same by comparing type, subtype and parameters.Attempts to find a value associated with the specified key, using the value expression collection from the component if no such value is found.
Performs the same logic as StateHelper.eval(java.io.Serializable)
} but if no value is found, this will return the
specified defaultValue
ELException
.
The property name for the ExceptionHandlerFactory
class name.
ExceptionHandler is the central point for handling unexpected
Exception
s that are thrown during the Faces lifecycle.
ExceptionHandlerFactory is a factory object that creates (if needed)
and returns a new ExceptionHandler
instance.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ExceptionHandler
that can be
subclassed by developers wishing to provide specialized behavior to an existing ExceptionHandler
instance.If this exception handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Response
.
The system event facility will create an instance of this class whenever
Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
is called with ExceptionQueuedEvent.class
as
systemEventClass
argument.
Instantiate a new ExceptionQueuedEvent
that indicates the argument
ExceptionQueuedEventContext
occurred.
Instantiate a new ExceptionQueuedEvent
that indicates the argument
ExceptionQueuedEventContext
occurred.
This helper class provides context to the ExceptionQueuedEvent
regarding the state of the system at the point
in time when the ExceptionQueuedEvent
occurs and links the ExceptionQueuedEvent
to the
ExceptionHandler
by virtue of implementing SystemEventListener
.
Instantiate a new ExceptionQueuedEventContext
that indicates the argument Throwable
just
occurred.
Instantiate a new ExceptionQueuedEventContext
that indicates the argument Throwable
just
occurred, relevant to the argument component
.
Instantiate a new ExceptionQueuedEventContext
that indicates the argument Throwable
just
occurred, relevant to the argument component
, during the lifecycle phase phaseId
.
MethodDescriptor
and
ConstructorDescriptor
.ExecutorService
.ValueExpression
and MethodExpression
, implementing
characteristics common to both.Set the method expression of this method call node.
Set the method expression of this method call node.
Set the method expression of this method call node.
ValueExpression
The default characters used to separate expressions in a series of expressions.
ExpressionFactory
The property name for the ExternalContextFactory
class name.
ExternalContext
instances, initialized for the processing of the
specified request and response objects.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Provides a simple implementation of
ExternalContext
that can be subclassed by developers wishing to provide specialized behavior to an existing
ExternalContext
instance.
If this external context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ValueExtractor
is
tied or specifies the type of the wrapped element(s) of non-generic container types.
The property name for the FaceletCacheFactory
class name.
This API defines the facility by which the Facelets
ViewDeclarationLanguage
creates and caches instances of Facelets.
Factory interface for creating Facelet or View Metadata Facelet instances.
Allows customization of the implementation of FaceletCache
.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Context representative of a single request from a Facelet.
An Exception from the Facelet implementation
Create an empty FaceletException
.
Create a FaceletException
with argument message
as the message.
Wrap argument cause
within this FaceletException
instance.
Wrap argument cause
in a FaceletException
instance, with a message given by the argument
message
.
This is the root class for markup elements in Facelets VDL.
The buffer size to set on the response when the ResponseWriter is generated.
A semicolon (;) delimitted list of class names of type jakarta.faces.view.facelets.TagDecorator, with a no-argument constructor.
If this param is set, the runtime must interpret it as a semicolon (;) separated list of paths, starting with "/" (without the quotes).
When a page is requested, what interval in seconds should the compiler check for changes.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, the runtime must ensure that any XML comments in the Facelets source page are not delivered to the client.
Allow the web application to define an alternate suffix for Facelet based XHTML pages containing Jakarta Server Faces content.
Identifier for the Facelets view declaration language.
Allow the web application to define a semicolon (;) separated list of strings that is used to forcibly declare that certain pages in the application must be interpreted as using Facelets, regardless of their extension.
Root class for all tag handlers that represent attached objetcts in a Facelets page.
The presence of this annotation on a class automatically registers the class with the runtime as a
ResourceResolver
.
FacesContextFactory
class name.ResourceBundle
identifier for messages whose message identifiers are defined in the Jakarta Server Faces
specification.
The presence of this annotation on a class automatically registers the class with the runtime as a Behavior
.
The presence of this annotation on a class automatically registers the class with the runtime as a
ClientBehaviorRenderer
.
UIComponent
must cause the runtime to register this class as a component suitable for inclusion in a view.
The presence of this annotation on a managed bean deployed within an application causes version specific features to
be enabled as specified in the enum FacesConfig.Version
FacesContext
instances, initialized for the
processing of the specified request and response objects.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FacesContext
that can be subclassed by developers wishing to provide specialized behavior to an existing
FacesContext
instance.If this faces context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The presence of this annotation on a class automatically registers the
class with the runtime as a Converter
.
FacesEvent is the base class for user interface and application events that can be fired by
UIComponent
s.
Construct a new event object from the specified source component.
Construct a new event object from the Faces context and specified source component.
FacesEvent
s.FacesMessage
with no initial values.FacesMessage
with just a summary.FacesMessage
with the specified initial values.FacesMessage
with the specified initial values.
The presence of this annotation on a class automatically registers the class with the runtime as a Renderer
.
The presence of this annotation on a class automatically registers the
class with the runtime as a Validator
.
Any wrapper class in Jakarta Server Faces that must provide access to the object it wraps must implement this interface.
An interface that allows other code to identify FaceletHandlers that correspond to component facets.
The value of this constant is used as the key in the composite component BeanDescriptor for the
Map<PropertyDescriptor>
that contains meta-information for the declared facets for this composite
component.
UIComponent
is to be added as a facet
to the component associated with
its parent.Feature
and DynamicFeature
instances by JAX-RS
runtime during the phase of their configuration.EntityResult
annotation to map columns specified
in the SELECT list of a SQL query to the properties or fields of an entity class.request
filter
or when the HTTP invocation returns).request filter
or by a matched resource method.Filter
may be further configured.Filter
registered via one of the addFilter methods on
ServletContext
may be further configured.A MethodExpression that will be invoked when the flow is exited.
A MethodExpression that will be invoked when the flow is exited.
UIComponent
with an id
that
matches the specified search expression (if any), according to the algorithm described below.UIComponent
, from the component tree, that corresponds to this tag handler instance.Set
.Take actions to apply the rule.
The Flash concept is taken from Ruby on Rails and provides a way to pass temporary objects between the user views generated by the faces lifecycle.
The property name for the FlashFactory
class name.
Flash
instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
If this flash has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FacesMessage
to be created if the conversion to
Float
fails.Converter
implementation for java.lang.Float
(and float primitive) values.Flow is the runtime representation of a Faces Flow.
The property name for the FlowHandlerFactory
class name.
Components that are rendered by Renderers
of component-family jakarta.faces.OutcomeTarget
must use this constant as the parameter name for a parameter representing the flow id of the flow that this component
will cause to be entered.
A Java language API for building Flow
s.
The presence of this annotation on a CDI producer method for the FlowDefinition
annotation causes the
FlowBuilder
to be passed to that method.
Create a flow call node in the current Flow
.
Define a flow call node.
The presence of this annotation on a CDI producer method indicates that the method will produce a flow.
FlowHandler is the main entry point that enables the runtime to interact with the faces flows feature.
FlowHandlerFactory is used by the Application
to create the
singleton instance of FlowHandler
.
FlowHandlerFactoryWrapper provides a simple implementation of FlowHandlerFactory
that can be
subclassed by developers wishing to provide specialized behavior to an existing FlowHandlerFactory
instance.
If this flow handler factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The presence of this annotation (along with @Inject
) on a field of type Map<Object,
Object>
causes the map returned from FlowHandler.getCurrentFlowScope()
to be
injected as the value of that field.
FlowNode is the base class for all nodes in a faces flow graph.
Define the flow reference of the called flow.
FlowScoped is a CDI scope that causes the runtime to consider classes
with this annotation to be in the scope of the specified Flow
.
ResponseWriter.flush()
on the wrapped ResponseWriter
object.forbidden
by the server.generic type
from a Java instance
."application/x-www-form-urlencoded"
content type.forward
HttpServletMapping
is made
available to the target of a forward
forward
forward
forward
forward
Set the from-action of the current navigation case.
Path
-annotated method.Set the from-outcome of the current navigation case.
Set the outcome of the current return node.
Set the outcome of the current return node.
Set the outcome in the previously created switch case.
T
.T
.Set the from-view-id of the current navigation case.
The runtime must interpret the value of this parameter as a comma separated list of view IDs, each of which must have their state saved using the state saving mechanism specified in Jakarta Server Faces 1.2.
FunctionMapper
Future
annotations on the same element.FutureOrPresent
annotations on the same element.Generated
annotation is used to mark source code
that has been generated.Generate a unique ID for the passed String
Configuration
.T
.T
.Contextual.create(CreationalContext)
and return the new instance.
Return the value currently associated with the specified key
if any.
The default behavior of this method is to call Map.get(Object)
on the wrapped Flash
object.
T
.accept
property.acceptcharset
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.ActionSource2.getActionExpression()
.UICommand.getActionExpression()
.MethodExpression
pointing at the application action to be invoked, if this UIComponent
is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property.MethodExpression
pointing at the application action to be invoked, if this UIComponent
is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property.ActionListener
to be registered for all
ActionSource
components in this application.
The default behavior of this method is to call Application.getActionListener()
on the wrapped
Application
object.
ActionSource.getActionListeners()
instead.UICommand.getActionListeners()
instead.ActionListener
s for this ActionSource
instance.ActionListener
s for this ActionSource
instance.
Construct an absolute URL to this NavigationCase
instance using
ViewHandler.getActionURL(jakarta.faces.context.FacesContext, java.lang.String)
on the path portion of the url.
If the value returned from this method is used as the file
argument to the four-argument constructor for java.net.URL
(assuming appropriate values are used for the
first three arguments), then a client making a request to the toExternalForm()
of that URL
will select the argument viewId
for traversing the Jakarta Server Faces lifecycle.
ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.MethodExpression
that will be invoked after this view is rendered.alt
property.alt
property.alt
property.alt
property.alt
property.alt
property.AnnotatedField
or
AnnotatedParameter
, depending upon whether the injection point is an injected field
or a constructor/method parameter.AnnotatedType
representing the bean class, the
AnnotatedMethod
representing the producer method, or the
AnnotatedField
representing the producer field.AnnotatedType
representing the bean class.AnnotatedParameter
for any matching injection point of the same type as
the producer field return type found on a disposal method.AnnotatedParameter
for any matching injection point of the same type as
the producer method return type found on a disposal method.AnnotatedField
representing the producer field or the
AnnotatedMethod
representing the producer method.AnnotatedMethod
representing the observer method.AnnotatedField
representing the producer field.AnnotatedMethod
representing the producer method.AnnotatedType
that may be used to read the annotations of the given class or interface as defined
during container initialization.AnnotatedType
object that will be used by the container to read the
declared annotations.AnnotatedType
representing the managed bean class, session bean class or
other Java EE component class supporting injection.AnnotatedType
s that may be used to read the annotations of the given class or interface as defined
during container initialization.Application
instance for this web application.Application
instance associated with this web
application.FacesContext.getApplication()
on the wrapped
FacesContext
object.
The source Application
that sent this event.
The source Application
that sent this event.
Return the name of the container context for this application.
The default behavior of this method is to call ExternalContext.getApplicationContextPath()
on the wrapped
ExternalContext
object.
Map
representing the application scope
attributes for the current application.ExternalContext.getApplicationMap()
on the wrapped
ExternalContext
object.JsonArray
and advance the parser to the
the corresponding END_ARRAY
.JsonArray
elements.UIComponent
, into a model data object that is appropriate for being stored during the
Process Validations phase of the request processing lifecycle.value
argument to one of the enum constants of the class provided in our constructor.UIComponent
, into a String
that is suitable for being included in the response generated during the Render Response phase of the
request processing lifeycle.
Convert the enum constant given by the value
argument into a String.
ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest,ServletResponse)
on this request.ServletRequestWrapper.startAsync()
or
ServletRequestWrapper.startAsync(ServletRequest,ServletResponse)
on the wrapped request.Return the underlying handler for this tag handler instance.
Return an attribute set by a previous call to FaceletContext.setAttribute(java.lang.String, java.lang.Object)
.
null
if no object is bound under
the name.null
if there is no attribute by that
name.Object
, or null
if no attribute of the given
name exists.Returns the resolved literal String value of the attribute name after evaluating EL.
Enumeration
of String
objects containing the names of all the objects bound to
this session.Enumeration
containing the attribute names available within this ServletContext.Enumeration
containing the names of the attributes available to this request.Map
representing the attributes (and properties, see below) associated wth this
UIComponent
, keyed by attribute name (which must be a String).
Return a mutable Map
representing the attributes associated wth this FacesContext
instance.
FacesContext.getAttributes()
on the wrapped
FacesContext
object.
A Map
of attributes relevant to the context of this ExceptionQueuedEvent
.
Return an object encapsulating the TagAttributes
specified on this element in the view.
null
.ExternalContext.getAuthType()
on the wrapped
ExternalContext
object.autocomplete
property.autocomplete
property.autocomplete
property.Bean
object representing the bean that defines the injection point.Bean
object that is about to be registered.BeanManager
was injected or the Java EE component from whose JNDI
environment namespace the BeanManager
was obtained, according to the rules of typesafe resolution.BeanManager
was injected or the Java EE component from whose JNDI environment namespace
the BeanManager
was obtained, according to the rules of EL name resolution.MethodExpression
that will be invoked before this view is rendered.
Return the source Behavior
that sent this event.
Iterator
over the set of currently registered behavior ids for this Application
.
The default behavior of this method is to call Application.getBehaviorIds()
on the wrapped Application
object.
bgcolor
property.bgcolor
property.BigDecimal
.bodyrows
property.bodyrows
property.
Construct an absolute URL suitable for a bookmarkable link to this NavigationCase
instance using
ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean)
on the path portion of the url.
Return a Jakarta Server Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta Server Faces response.
ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)
on the
wrapped ViewHandler
object.
If literal,return Boolean.valueOf(java.lang.String)
passing our value,
otherwise call getObject(FaceletContext, Class)
.
META-INF/validation.xml
file.border
property.border
property.border
property.border
property.buffer
configuration, which specifies the default size of the response buffer for
any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.null
if this exception arose from a failure to decode a text message.
Returns the ContextCallback
for the current request.
CallerPrincipal
(and potentially other values) found in the validationResult
parameter.java.security.Principal
that identifies the caller.java.security.Principal
that represents
the name of authenticated caller, or null if the current caller is not authenticated.captionClass
property.captionClass
property.captionStyle
property.captionStyle
property.Return the cases in this switch.
null
if the cause is nonexistent or unknown.cellpadding
property.cellpadding
property.cellspacing
property.cellspacing
property.<f:websocket channel>
.ResponseWriter
.ResponseWriter.getCharacterEncoding()
on the wrapped
ResponseWriter
object.charset
property.charset
property.charset
property.UIComponent
s that are associated with this UIComponent
.feature
classes.feature
)
classes to be instantiated, injected and utilized in the scope of the configurable instance.ClientBehaviorRenderer
instance most recently registered for the specified type
, if
any; otherwise, return null
.RenderKit.getClientBehaviorRenderer(String)
on the wrapped
RenderKit
object.
Return an Iterator
over the ClientBehaviorRenderer
types.
RenderKit.getClientBehaviorRendererTypes()
on the wrapped RenderKit
object.
Returns a non-null, unmodifiable Map
that contains the the ClientBehavior
s that have been
attached to the component implementing this interface.
This is a default implementation of ClientBehaviorHolder.getClientBehaviors()
.
Enable Jakarta Expression Language to access the clientId
of a component.
rowIndex
property,
if it is not set to -1.Iterator
over the client identifiers for which at least one
FacesMessage
has been queued.FacesContext.getClientIdsWithMessages()
on the wrapped FacesContext
object.
Return the ClientWindow
set in a preceding call to ExternalContext.setClientWindow(jakarta.faces.lifecycle.ClientWindow)
, or null
if no such
call has been made.
The default behavior of this method is to call ExternalContext.getClientWindow()
on the wrapped
ExternalContext
object.
The implementation is responsible for creating the ClientWindow
instance for this request.
Get the ClientWindow
's id and append "_" and the return from Flow.getId()
.
now
.Clock
,
e.g.ClockProvider
instance configured at
initialization time for the ValidatorFactory
.ClockProvider
implementation or
null
if none is specified.cols
property.Return the estimated character column.
columnClasses
property.columnClasses
property.columns
property.null
if the cookie has no comment.property
argument.null
, returns the most general type that this resolver accepts for the
property
argument.String.class
, since a bean name is a String.property
argument, given a
base
object.property
argument, given a
base
object.property
argument.property
argument.property
argument.null
, returns String.class
.null
, returns String.class
.
Returns the UIComponent
that is requesting the ClientBehavior
script.
the source UIComponent
that sent this event.
Return the UIComponent
which was being processed when the exception was thrown.
UIComponent
that sent this event.
Return an Iterator
over the component-family entries supported by this RenderKit
instance.
RenderKit.getComponentFamilies()
on the
wrapped RenderKit
object.UIComponent
instance that is associated with this tag instance.UIComponent
instance that is associated with this tag instance.
Return a reference to the component metadata for the composite component represented by the argument
componentResource
, or null
if the metadata cannot be found.
Return an unmodifiable List
of
UIComponent
s for the provided target
agrument.
Return an unmodifiable ordered List
of all UIComponent
resources of all supported targets.
ResponseStateManager.getState(jakarta.faces.context.FacesContext, java.lang.String)
. The default implementation returns null
.null
.StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext)
on the wrapped StateManager
object.
ComponentType to pass to the Application
.
Iterator
over the set of currently defined component types for this Application
.
The default behavior of this method is to call Application.getComponentTypes()
on the wrapped
Application
object.
ConstraintDescriptor
s where each
descriptor describes a composing constraint.
Evaluates the <if>
for this <navigation-case>
, if any.
Return true
if this case should be taken, false
otherwise.
ServerEndpointConfig.Configurator
this configuration is using.Valid
).ElementDescriptor
.Set
if none are present.Set
.ConstraintValidatorFactory
instance
configured at initialization time for the
ValidatorFactory
.ConstraintValidatorFactory
implementation
or null
if none is specified.AroundConstruct
interceptor method was invoked.NamingContainer
to selectively disable prepending their clientId to their
descendent's clientIds by breaking the prepending logic into a separately callable method.UIComponent.getContainerClientId(jakarta.faces.context.FacesContext)
to allow users to disable this form from prepending its
clientId
to its descendent's clientIds
depending on the value of this form's
UIForm.isPrependId()
property.Return the MIME content-type for this resource.
The default behavior of this method is to call Resource.getContentType()
on the wrapped
ResourceHandler
object.
ResponseWriter
.ResponseWriter.getContentType()
on the wrapped
ResponseWriter
object.null
if the type is not known.ExternalContext.getContext()
on the wrapped
ExternalContext
object.
Return the ExceptionQueuedEventContext
for this event instance.
The FacesContext
for this request.
Return the ScopeContext
for this event.
Return the ScopeContext
for this event.
ServletContext
object that corresponds to a specified URL on the server.T
that is applicable to the supplied type.getContextData
method enables a business method, lifecycle callback method, or timeout method to
retrieve any interceptor/webservices context associated with its invocation.Return the name of the container context for this application.
ExternalContext.getContextName()
on the wrapped
ExternalContext
object.
Because this class has no Renderer
, leverage the one from the standard HTML_BASIC RenderKit
with
component-family: jakarta.faces.Input
and renderer-type: jakarta.faces.Text
and call its
Renderer.getConvertedValue(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)
method.
Converter
for this component, if there is one).Converter
(if any) that is registered for this UIComponent
.ParamConverter
that can provide from/to string conversion for an instance of a particular Java type.Return the converter id to be used in instantiating this converter
Iterator
over the set of currently registered converter ids for this Application
.
The default behavior of this method is to call Application.getConverterIds()
on the wrapped Application
object.
UIInput.setConverterMessage(java.lang.String)
on this instance, return the message.Iterator
over the set of Class
instances for which Converter
classes have
been explicitly registered.
The default behavior of this method is to call Application.getConverterTypes()
on the wrapped
Application
object.
Cookie
objects the client sent with this request.coords
property.coords
property.coords
property.From
object from which the correlated
From
object has been obtained through correlation (use
of a Subquery
correlate
method).true
if we dynamically created a new component instance during execution of this tag.true
if we dynamically created a new component instance during execution of this tag.List
of UIComponent
ids created or located by nested UIComponentTag
s while
processing the current request.CriteriaBuilder
for the creation of
CriteriaQuery
objects.CriteriaBuilder
for the creation of
CriteriaQuery
objects.Compliant implementations must return a cryptographically strong token for use to protect views in this application.
getAsString()
with a type
of
currency
.getAsString()
with a type
of currency
.
Return the UIComponent
instance that is currently processing.
Return the closest ancestor component, relative to the component returned from UIComponent.getCurrentComponent(jakarta.faces.context.FacesContext)
, that is
a composite component, or null
if no such component exists.
Return the currently active Flow
for the argument FacesContext
, or null
if no flow is active.
Convenience overload that calls FacesContext.getCurrentInstance()
and then calls through to
FlowHandler.getCurrentFlow(jakarta.faces.context.FacesContext)
.
Return the Map
that backs the #{flowScope}
Jakarta Expression Language implicit object or
null
if no flow is currently active.
Return the FacesContext
instance for the request that is being processed by the current thread.
Return the value last set on this FacesContext
instance when FacesContext.setCurrentPhaseId(jakarta.faces.event.PhaseId)
was called.
FacesContext.getCurrentPhaseId()
on the wrapped
FacesContext
object.DataModel
object representing the data objects that we will iterate over in this
component's rendering.DataModel
that fired this event.DataModelListener
s interested in notifications from this DataModel
.long
value that represents a Date
object.ClockProvider
interface following the default ClockProvider
defined in the specification:
returns a clock representing the current system time and default time
zone.
ConstraintValidatorFactory
interface
following the default ConstraintValidatorFactory
defined in the
specification:
uses the public no-arg constructor of the ConstraintValidator
default-content-type
configuration, which specifies the default response content
type for any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.
Returns the default event name for this ClientBehaviorHolder
implementation.
This is a default implementation of
ClientBehaviorHolder.getDefaultEventName()
.
Locale
for this application.
The default behavior of this method is to call Application.getDefaultLocale()
on the wrapped
Application
object.
MessageInterpolator
interface
following the default MessageInterpolator
defined in the
specification:
use the ValidationMessages
resource bundle to load keys
use Locale.getDefault()
Return the default outcome in this switch.
ParameterNameProvider
interface following the default ParameterNameProvider
defined in the specification:
returns the actual parameter names as provided in the validated
executable’s definition, if the class file of the executable contains
parameter name information
otherwise returns names in the form arg<PARAMETER_INDEX>
,
where PARAMETER_INDEX
starts at 0 for the first parameter,
e.g.ValidationProvider
implementation
or null
if none is specified.renderKitId
to be used for rendering this application.
The default behavior of this method is to call Application.getDefaultRenderKitId()
on the wrapped
Application
object.
TraversableResolver
interface
following the default TraversableResolver
defined in the
specification:
if Java Persistence is available in the runtime environment,
a property is considered reachable if Java Persistence considers
the property as loaded
if Java Persistence is not available in the runtime environment,
all properties are considered reachable
all properties are considered cascadable.
ValidateOnExecution
.ValidationProviderResolver
strategy instance.
Return an immutable Map
over the set of currently registered default validator IDs and their class name
for this Application
.
The default behavior of this method is to call Application.getDefaultValidatorInfo()
on the wrapped
Application
object.
deferred-syntax-allowed-as-literal
configuration, which specifies whether the
character sequence "#{"
, which is normally reserved for Expression Language (EL) expressions,
will cause a translation error if it appears as a String literal in any JSP pages mapped to the JSP property group
represented by this JspPropertyGroupDescriptor
.Return the immutable application unique identifier for the document in which the argument flow is defined.
Returns the delay value, or null
if no value was set.
EntityManager
,
if available.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.disabledClass
property.disabledClass
property.disabledClass
property.disabledClass
property.disabledClass
property.disabledClass
property.doAfterBody()
method when it is called.doEnd()
method when it is called.doStart()
method when it is called.ELContext
that was created.ELContext
instance for this FacesContext
instance.FacesContext.getELContext()
on the wrapped
FacesContext
object.ELContext
for the FacesContext
for this request.ELContext
for the FacesContext
for this request.ELContext
associated with this JspContext
.Application.addELContextListener(jakarta.el.ELContextListener)
, this method must return an empty array.
The default behavior of this method is to call Application.getELContextListeners()
on the wrapped
Application
object.
el-ignored
configuration, which specifies whether Expression Language (EL)
evaluation is enabled for any JSP pages mapped to the JSP property group represented by this
JspPropertyGroupDescriptor
.ELResolver
associated with this context.ELResolver
that resolves beans by EL name.ELResolver
instance to be used for all Jakarta Expression Language resolution.
The default behavior of this method is to call Application.getELResolver()
on the wrapped Application
object.
enabledClass
property.enabledClass
property.enabledClass
property.enabledClass
property.enabledClass
property.enabledClass
property.enctype
property.errorClass
property.errorClass
property.error-on-undeclared-namespace
configuration, which specifies whether an error will
be raised at translation time if tag with an undeclared namespace is used in any JSP pages mapped to the JSP property
group represented by this JspPropertyGroupDescriptor
.errorStyle
property.errorStyle
property.
Returns a mutable List
of scripts to be evaluated in client side on complete of ajax request.
The default behavior of this method is to call PartialViewContext.getRenderIds()
on the wrapped
PartialViewContext
object.
java.lang.Object
and specified qualifier @Default
It allows typesafe synchronous or asynchronous event firing without injection of Event
built-in bean requirement.Returns the name of the behavior event for which the ClientBehavior script is being requested.
Return the client event name to which this behavior applies.
Returns a non-null, unmodifiable Collection
containing the names of the logical events supported by the
component implementing this interface.
This is a default implementation of ClientBehaviorHolder.getEventNames()
.
Collection
which returns true
on any
Collection#contains()
invocation, indicating that all client behavior event names are acceptable.
Return the exception
property.
Create and return a A new ExceptionHandler
instance.
Return the ExceptionHandler
for this request.
FacesContext.getExceptionHandler()
on the wrapped
FacesContext
object.Object[]
representing the constructor or method invocation
arguments if the ConstraintViolation
is returned after validating the
method or constructor parameters.ConstraintViolation
is returned after validating the method
or constructor return value.
Return a non-empty Collection<String>
of component identifiers that will be used to identify
components that should be processed during the execute
phase of the request processing lifecycle.
execute
property.
Return a Collection
of client identifiers from the current request with the request parameter name
PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME
.
PartialViewContext.getExecuteIds()
on the wrapped
PartialViewContext
object.JspApplicationContext.getExpressionFactory()
ExpressionFactory
instance for this application.
The default behavior of this method is to call Application.getExpressionFactory()
on the wrapped
Application
object.
The ExpressionFactory to use within the Facelet this context is executing upon.
ValueExpression
s and MethodExpression
s so that EL
expressions can be parsed and evaluated.Returns hints that influence the behavior of resolving the expression.
Return the characters used to separate expressions in a series of expressions.
Expression
, unmodified.null
) expression String, with leading and trailing delimiters, from which this
MethodBinding
was built.null
) expression String, including the delimiters, from which this
ValueBinding
was built.META-INF/services
.ExternalContext
instance that is
initialized for the processing of the specified request and response objects, for this web application.FacesContext.getExternalContext()
on the wrapped
FacesContext
object.Returns a cached Facelet instance.
Returns the FacesContext
for the current request.
Returns the FacesContext for the current request.
FacesContext
instance for the current request.Returns the FacesContext for the current request.
FacesContext
instance that is initialized for the processing of the specified request and response objects, utilizing the
specified Lifecycle
instance, for this web application.Get the Faces context.
FacesContext
for the request being processed.Get the Faces context.
The current FacesContext bound to this "request".
FacesContext
instance for the current request.UIComponentClassicTagBase.release()
was called), return the
previously returned value.FacesListener
s that are instances of the specified class.
Return the FacesMessage
passed to the constructor.
Returns the FacesMessage
associated with the exception.
If this instance was created with a constructor that takes Collection<FacesMessage>
, this method
returns the passed collection, otherwise this method returns null
.
null
otherwise.UIComponent
s that are associated with this UIComponent
.Returns the resolved literal String value of the facet name after evaluating EL.
Map
representing the facet UIComponent
s associated with this
UIComponent
, keyed by facet name (which must be a String).AuthConfigFactory.GET_FACTORY_PERMISSION_NAME
, that is used to authorize access to the
getFactory method.Return the identifier of the component family to which this component belongs.
UIWebsocket.COMPONENT_FAMILY
.fatalClass
property.fatalClass
property.fatalStyle
property.fatalStyle
property.null
, since there is no reason to iterate through set set of all integers.null
, returns an Iterator
containing the set of JavaBeans
properties available on the given object.null
, since there is no reason to iterate through a list of one element: bean name.base
object.base
object.null
, since there is no reason to iterate through set set of all integers.Iterator
containing the set of keys available in the
Map
.Iterator
containing the set of keys available in the
ResourceBundle
.null
, and the property matches the name of a JSP implicit object, returns an
Iterator
containing FeatureDescriptor
objects with information about each JSP implicit
object resolved by this resolver.null
, returns an Iterator
containing
FeatureDescriptor
objects with information about each scoped attribute resolved by this resolver.ServletConfig
object.
Return the MethodExpression
that must be called by the runtime as the last thing that happens before exiting
this flow.
Return the threadsafe Flash
for this application.
ExternalContext.getFlash()
on the wrapped
ExternalContext
object.
Create (if needed) and return a Flash
instance for this web application.
Called as the last step in flow definition, this method must perform any implementation specific initialization and
return the built Flow
.
Return the Flow
whose id
is equivalent to the argument id
, within the scope of the argument definingDocument
.
Return the FlowCallNode
that represents calling the targetFlow
from this flow, or null
if
targetFlow
cannot be reached from this flow.
Return an immutable data structure containing all the flow call nodes declared for this flow.
Return the thread-safe singleton FlowHandler
for this application.
footerClass
property.footerClass
property.footerClass
property.for
property.Return the client identifier of the component for which this component represents associated message(s) (if any).
Return the value of the "for" attribute specified by the page author on the tag for this
AttachedObjectHandler
.
Return the value of the "for" attribute.
fragment
property.frame
property.frame
property.
Return the <from-action>
for this <navigation-case>
Return the <from-outcome>
for this <navigation-case>
Return the fromOutcome
to be used when control passes to this return node.
Return the outcome to be used if SwitchCase.getCondition(jakarta.faces.context.FacesContext)
return true
.
Return the <from-view-id>
of the <navigation-rule>
inside which this
<navigation-case>
is nested.
FunctionMapper
associated with this ELContext
.group
property.Returns the name of the radio button group.
Return the first ExceptionQueuedEvent
handled by this handler.
ExceptionHandler.getHandledExceptionQueuedEvent()
on the
wrapped ExceptionHandler
object.
The default implementation must return an Iterable
over all ExceptionQueuedEvent
s that have
been handled by the ExceptionHandler.handle()
method.
ExceptionHandler.getHandledExceptionQueuedEvents()
on the
wrapped ExceptionHandler
object.HttpMessageContext
, and which this context uses to communicate the authentication details to the runtime.Returns the array of child handlers contained by this handler.
String
.HttpServletResponse.getHeader(java.lang.String)
on the wrapped response object.String
.headerClass
property.headerClass
property.headerClass
property.HttpServletResponse.getHeaderNames()
on the wrapped response
object.Enumeration
of String
objects.HttpServletResponse.getHeaders(java.lang.String)
on the wrapped response
object.height
property.
This method returns an unmodifiable Set
containing the ClientBehaviorHint
SUBMITTING
.
Returns hints that describe the behavior of the ClientBehavior implementation.
Default implementation of ClientBehavior.getHints()
.
null
in case no hostname verifier has been configured.hreflang
property.hreflang
property.hreflang
property.Bean
or
Contextual
.UIComponent
.Return the immutable id for this Flow.
Return a String value that uniquely identifies this ClientWindow
within the scope of the current
session.
Returns a non-null String that can be used to identify this view declaration language.
id
value assigned by the page author.Enumeration
and will be removed in a future version of this API.Returns the ids of the components to visit.
image
property.image
property.
Utility method to extract view metadata from the provided UIViewRoot
.
ImportHandler
associated with this ELContext
.Return an immutable data structure containing the inbound parameters that have been declared for this flow.
include-coda
configuration of the JSP property group represented by this
JspPropertyGroupDescriptor
.include-prelude
configuration of the JSP property group represented by this
JspPropertyGroupDescriptor
.info
object made available to timer callbacks.infoClass
property.infoClass
property.infoStyle
property.infoStyle
property.
Return the MethodExpression
that must be called by the runtime immediately after activating any
FlowScoped
beans declared for this flow.
ExternalContext.getInitParameter(String)
on the wrapped
ExternalContext
object.String
containing the value of the named initialization parameter, or null
if the
initialization parameter does not exist.String
containing the value of the named initialization parameter, or null
if the
parameter does not exist.String
containing the value of the named initialization parameter, or null
if the
parameter does not exist.String
containing the value of the named context-wide initialization parameter, or
null
if the parameter does not exist.Map
whose keys are the set of application
initialization parameter names configured for this application, and whose values are the corresponding parameter
values.ExternalContext.getInitParameterMap()
on the wrapped
ExternalContext
object.Enumeration
of String
objects, or an empty Enumeration
if the filter has no initialization parameters.Enumeration
of String
objects, or an empty Enumeration
if the filter has no initialization parameters.Enumeration
of String
objects, or an empty Enumeration
if the servlet has no initialization parameters.Enumeration
of String
objects, or an empty Enumeration
if the servlet has no initialization parameters.Enumeration
of String
objects, or an empty Enumeration
if the context has no initialization parameters.InjectionPoint
representing the injected Event
instance which fired the event, or
null
if it was fired from BeanManager.fireEvent(Object, Annotation...)
;InjectionPoint
objects representing injection points of the bean, that
will be validated by the container at initialization time.InjectionPoints
.InjectionTarget
object that will be used by the container to perform
injection.InjectionTargetFactory
that provides container created InjectionTarget
instances.
If the current request is a resource request, (that is,
ResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext)
returns true
), return an InputStream
containing
the bytes of the resource.
The default behavior of this method is to call Resource.getInputStream()
on the wrapped ResourceHandler
object.
ServletInputStream
.RuntimeDelegate
instance.feature
) instances to be
utilized by the configurable instance.Integer.parseInt(String)
, otherwise call
getObject(FaceletContext, Class)
.getJsonNumber(index).intValue()
.JsonNumber
at the specified position.getJsonNumber(name).intValue()
JsonNumber
mapping
for the specified name.Nonbinding
.int
.is-xml
configuration, which specifies whether any JSP pages mapped to the JSP
property group represented by this JspPropertyGroupDescriptor
will be treated as JSP documents (XML
syntax).Class
.Constructor
.Field
.Member
.Method
.java.lang.reflect.Member
for the represented
attribute.Parameter
.JspApplicationContext
instance associated with the web application for the given
ServletContext
.<jsp-config>
related configuration that was aggregated from the web.xml
and
web-fragment.xml
descriptor files of the web application represented by this ServletContext.<jsp-property-group>
child elements of the <jsp-config>
element
represented by this JspConfigDescriptor
.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.null
if no language has been set.
Return the last displayed viewId for the current flow, as returned by
FlowHandler.getCurrentFlow(jakarta.faces.context.FacesContext)
, or null
if there is no current flow.
HttpServletRequest
object was last modified, in milliseconds since midnight January
1, 1970 GMT.layout
property.layout
property.layout
property.layout
property.null
when the ConstraintViolation
is returned
after calling Validator.validateValue(Class, String, Object, Class[])
the object the method is executed on if it is
a method parameter, cross-parameter or return value constraint or a
container element constraint hosted on a method parameter or return value
null
if it is a constructor parameter or
cross-parameter constraint or a container element constraint hosted on a
constructor parameter
the object the constructor has created if it is a
constructor return value constraint
Return the libraryName for this resource.
The default behavior of this method is to call Resource.getLibraryName()
on the wrapped
ResourceHandler
object.
Lifecycle
instance for the specified lifecycle identifier.Iterator
over the set of lifecycle identifiers supported by this factory.Return the line number in the page for this location.
Link.Builder
for the relation.Link.Builder
for the relation.Link.Builder
for the relation.
This implementation throws UnsupportedOperationException
and is provided for the sole purpose of not
breaking existing applications that extend this class.
Return the SystemEventListener
instances registered on this UIComponent
instance that are
interested in events of type eventClass
.
Return a List
that contains a single entry, the ExceptionHandler
for the
current request.
Locale
stored by a previous invocation to ELContext.setLocale(java.util.Locale)
.Locale
to be used in localizing the response being created for this view.Locale
to be used when parsing or formatting dates and times.Locale
to be used when parsing numbers.Locale
that the client will accept content in, based on the Accept-Language
header.ServletResponse.setLocale(java.util.Locale)
method.Enumeration
of Locale
objects indicating, in decreasing order starting with the
preferred locale, the locales that are acceptable to the client based on the Accept-Language header.Return the XML local name of the tag.
UIComponent
(if any), without evaluating any associated
ValueExpression
.
Return the Location of this Tag
instance in the Facelet view.
longdesc
property.MappingMatch
for this instanceServletRegistration
.getAsString()
should render in the fraction portion of the result.Validator
or Double.MAX_VALUE
if it has not been
set.Validator
, or 0
if the maximum has not been
set.Validator
.FacesMessage
s that has been
queued, whether or not they are associated with any specific UIComponent
.FacesContext.getMaximumSeverity()
on the wrapped
FacesContext
object.getAsString()
should render in the integer portion of the result.maxlength
property.maxlength
property.maxlength
property.media type
of the event data.Field
object in the case of field injection, the Method
object in the case of method parameter injection or the Constructor
object in the case of
constructor parameter injection.
Returns the FaceletCache.MemberFactory
passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)
for the purpose of creating Facelet instance.
null
, otherwise, return the message.ResourceBundle
to be used for Jakarta Server Faces messages
for this application.
The default behavior of this method is to call Application.getMessageBundle()
on the wrapped
Application
object.
MessageInterpolator
instance configured at
initialization time for the ValidatorFactory
.MessageInterpolator
implementation
or null
if none is specified.
Like FacesContext.getMessages()
, but returns a List<FacesMessage>
, enabling use from Jakarta Expression
Language expressions.
Like FacesContext.getMessages(java.lang.String)
, but returns a List<FacesMessage>
of messages for the
component with client id matching argument clientId
.
FacesContext.getMessageList()
on the wrapped
FacesContext
object.FacesContext.getMessageList(String)
on the wrapped
FacesContext
object.Iterator
over the FacesMessage
s that have been queued,
whether or not they are associated with any specific client identifier.Iterator
over the FacesMessage
s that have been queued that
are associated with the specified client identifier (if clientId
is not null
), or over the
FacesMessage
s that have been queued that are not associated with any specific
client identifier (if clientId
is null
).FacesContext.getMessages()
on the wrapped FacesContext
object.FacesContext.getMessages(String)
on the wrapped
FacesContext
object.
Returns the FaceletCache.MemberFactory
passed to FaceletCache.setMemberFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)
for the purpose of creating View Metadata
Facelet instance.
Metamodel
interface for access to the
metamodel of the persistence unit.Metamodel
interface for access to the
metamodel of the persistence unit.Return an immutable data structure containing all the method call nodes declared for this flow.
Return the MethodExpression
to be invoked to when control passes to this node.
Returns the MIME type of the specified file or null
if the MIME type is not known.
ExternalContext.getMimeType(String)
on the wrapped
ExternalContext
object.null
if the MIME type is not known.getAsString()
should render in the fraction portion of the result.Validator
, or Double.MIN_VALUE
if it has not
been set.Validator
, or 0
if the minimum has not been
set.Validator
.getAsString()
should render in the integer portion of the result.Returns the Parameter's name.
name
property.Return the request parameter name from which the value is retrieved.
Return the name of this phase.
Return the name of the parameter
Returns the name by which this attached object target is exposed to the page author.
NamedEntityGraph
annotation, XML descriptor element, or added by means of the
addNamedEntityGraph
method.null
if it is a leaf node which represents an entity / bean.RequestDispatcher
object that acts as a wrapper for the named servlet.Return the resolved XML Namespace for this tag in the Facelets view.
Starting with "this", return the closest component in the ancestry that is a NamingContainer
or
null
if none can be found.
Return the result of calling UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext)
, passing this
as the argument.
The default behavior of this method is to call FacesContext.getNamingContainerSeparatorChar()
on the wrapped
FacesContext
object.
Return the NavigationCase
representing the navigation that would be taken had
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments or null
if there is no
such case.
Return the NavigationCase
representing the navigation that would be taken had
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments or null
if there is no
such case.
Return a Map<String,
Set<NavigationCase>>
where the keys are <from-view-id>
values and the values are
Set<NavigationCase>
where each element in the Set is a NavigationCase
that applies to
that <from-view-id>
.
Return an unmodifiable view of the navigation cases within this flow.
NavigationHandler
instance that will be passed the outcome returned by any invoked application
action for this web application.
The default behavior of this method is to call Application.getNavigationHandler()
on the wrapped
Application
object.
UIComponent
.
The next FaceletHandler
(child or children) to be applied.
Return the generic FlowNode
by id, or null
if not found.
JsonObject
and advances the parser to the
corresponding END_OBJECT
.JsonObject
's
name/value pairs.ObserverMethod
object that will be used by the container to invoke the observer
when a matching event is fired.UIComponent
.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.
Return the String
of JavaScript function name that will be used to identify the client callback function
that should be run in the event of an error.
onerror
property.
Return the String
of JavaScript function name that will be used to identify the client callback function
that should be run on the occurance of a client-side event.
onevent
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onload
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onreset
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onsubmit
property.onunload
property.FacesMessage.Severity
instance.PhaseId
instance.
Returns the outcome
property of the UIOutcomeTarget
.
Return the outcome
to be used in the event of a null
return from the method.
ServletOutputStream
suitable for writing binary data in the response.page-encoding
configuration, which specifies the default page encoding for any JSP
pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.String
, or null
if the parameter does not
exist.ParameterNameProvider
instance configured at
initialization time for the ValidatorFactory
.ParameterNameProvider
implementation
or null
if none is specified.Enumeration
of String
objects containing the names of the parameters contained
in this request.Return the parameters to be included for navigation cases requiring a redirect.
Returns parameters that "submitting" ClientBehavior
implementations should include when posting back data
into the Faces lifecycle.
Return the parameters to be passed to the method.
String
objects containing all of the values the given request parameter has, or
null
if the parameter does not exist.UIComponent
of this UIComponent
, if any.Tag
that is the parent of this instance.UIComponentClassicTagBase
if any; otherwise, return
null
.UIComponentTag
if any; otherwise, return null
.Part
with the given name.
Return the ResponseWriter
to which components should direct their output for partial view rendering.
PartialViewContext.getPartialResponseWriter()
on the wrapped
PartialViewContext
object.
Return the PartialViewContext
for this request.
FacesContext.getPartialViewContext()
()} on the wrapped
FacesContext
object.PartialViewContext
instance that is
initialized using the current FacesContext
instance.Part
components of this request, provided that it is of type multipart/form-data
.PassivationCapable
bean with the given identifier.
This is a convenience method that simply calls UIComponent.getPassThroughAttributes(boolean)
, passing true
as
the argument.
This method has the same specification as UIComponent.getPassThroughAttributes()
except that it is allowed to return
null
if and only if the argument create
is false
and no pass through attribute data structure
exists for this instance.
Return the file path to the page represented by this location.
PathSegment
.PathSegment
.ValueExpression
that yields the regular expression pattern when evaluated.url-pattern
for this mapping.PersistenceProvider
implementations
available in the runtime environment.persistence.xml
file.Returns the name of the lifecycle phase in which the action is to be queued.
Return the PhaseId
which was being processed when the exception was thrown.
PhaseId
representing the current request processing lifecycle phase.PhaseEvent
events.
Return an unmodifiable list of the PhaseListener
instances attached to this UIViewRoot
instance.
PhaseListener
s for this Lifecycle
instance.JspWriter
from our BodyContent
.Producer
object that will be used by the container to call the producer
method or read the producer field.ProducerFactory
that provides container created Producer
instances for the given
field.ProducerFactory
that provides container created Producer
instances for the given
method.Return the project stage for the currently running application instance.
The default behavior of this method is to call Application.getProjectStage()
on the wrapped Application
object.
Return a beans PropertyDescriptor
for the property with name given by argument name
.
null
if there is no property by that name.null
if there is no property by that name.null
if there is no property by that name.collection
containing the property names available within the context of the
current request/response exchange context.collection
containing the property names available within the
context of the current request/response exchange context.collection
containing the property names available within the
context of the current configuration instance.collection
containing the property names available within the
context of the current request/response exchange context.Application.getELResolver()
.
Return a Class
for the property with name given by argument name
.
Return an unmodifiable Set
of the protected views currently known to this ViewHandler
instance.
ViewHandler.getProtectedViewsUnmodifiable()
on the wrapped
ViewHandler
object.public
property.Return the XML qualified name for this tag.
Nonbinding
.This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL.
BufferedReader
.
Return a Method
for the getter of the property with name given by argument name
.
Returns a String containing the real path for a given virtual path.
ExternalContext.getRealPath(String)
on the wrapped
ExternalContext
object.ServletContext.getRealPath(java.lang.String)
instead.ServletContext.getRealPath(java.lang.String)
insteadReception
for the observer method.
Construct an absolute URL suitable for a "redirect" to this NavigationCase
instance using
ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean)
on the path portion of the url.
Return a Jakarta Server Faces action URL derived from the viewId
argument that is suitable to be used by
the NavigationHandler
to issue a redirect request to the URL using a NonFaces request.
ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)
on the wrapped
ViewHandler
object.rel
property.rel
property.rel
property.rel
param, or null
if this param is not specified.rel
param as a list of strings or the empty list if rel
is
not defined.Returns the remaining expression for the current request.
null
.ExternalContext.getRemoteUser()
on the wrapped
ExternalContext
object.null
if the
user has not been authenticated.
Return a non-empty Collection<String>
of component identifiers that will be used to identify
components that should be processed during the render
phase of the request processing lifecycle.
render
property.
Convenience method to return the ClientBehaviorRenderer
instance associated with this ClientBehavior
,
if any; otherwise, return null
.
Renderer
instance associated with this component, if any; otherwise, return
null
.Renderer
instance most recently registered for the specified component family
and
rendererType
, if any; otherwise, return null
.RenderKit.getRenderer(String, String)
on the wrapped
RenderKit
object.
Returns the renderer type of the ClientBehaviorRenderer
to use for the behavior.
Renderer
type for this UIComponent
(if any).
RendererType to set on created UIComponent
instances.
rendererType
property that selects the Renderer
to be used for encoding this
component, or null
to ask the component to render itself directly.
Return the renderer-type
for a Renderer
that is capable of rendering this
resource.
The default behavior of this method is to call ResourceHandler.getRendererTypeForResourceName(String)
on the
wrapped ResourceHandler
object.
Return an Iterator
over the renderer-type entries for the given component-family.
RenderKit.getRendererTypes(String)
on the wrapped
RenderKit
object.
Return a Collection
of client identifiers from the current request with the request parameter name
PartialViewContext.PARTIAL_RENDER_PARAM_NAME
.
PartialViewContext.getRenderIds()
on the wrapped
PartialViewContext
object.RenderKit
instance for the render kit identifier specified on our UIViewRoot
, if there is
one.FacesContext.getRenderKit()
on the wrapped
FacesContext
object.RenderKit
instance for the specified render kit identifier, possibly customized based on dynamic
characteristics of the specified FacesContext
, if non-null
.RenderKit
associated with this view.Iterator
over the set of render kit identifiers registered with this factory.true
if the renderResponse()
method has been called for the current request.FacesContext.getRenderResponse()
on the wrapped
FacesContext
object.
Call UIComponentBase.getRendersChildren()
If PartialViewContext.isAjaxRequest()
returns true
this method must return true
.
Renderer
is responsible for rendering the children the component it is
asked to render.ExternalContext.getRequest()
on the wrapped
ExternalContext
object.ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest, ServletResponse)
.ExternalContext.getRequestCharacterEncoding()
on the wrapped
ExternalContext
object.
Return the result of calling getContentLenth()
on the ServletRequest
instance for this
request.
ExternalContext.getRequestContentLength()
on the wrapped
ExternalContext
object.ExternalContext.getRequestContentType()
on the wrapped
ExternalContext
object.ExternalContext.getRequestContextPath()
on the wrapped
ExternalContext
object.Map
whose keys are the set of cookie names included in the current request, and
whose values (of type jakarta.servlet.http.Cookie
) are the first (or only) cookie for each cookie name
returned by the underlying request.ExternalContext.getRequestCookieMap()
on the wrapped
ExternalContext
object.RequestDispatcher
object that acts as a wrapper for the resource located at the given path.RequestDispatcher
object that acts as a wrapper for the resource located at the given path.Map
whose keys are the set of request header names included in the current request,
and whose values (of type String) are the first (or only) value for each header name returned by the underlying
request.ExternalContext.getRequestHeaderMap()
on the wrapped
ExternalContext
object.Map
whose keys are the set of request header names included in the current request,
and whose values (of type String[]) are all of the value for each header name returned by the underlying request.ExternalContext.getRequestHeaderValuesMap()
on the wrapped
ExternalContext
object.Locale
in which the client will accept content.ExternalContext.getRequestLocale()
on the wrapped
ExternalContext
object.Iterator
over the preferred Locale
s specified in the request, in decreasing order
of preference.ExternalContext.getRequestLocales()
on the wrapped
ExternalContext
object.Map
representing the request scope attributes for the current application.ExternalContext.getRequestMap()
on the wrapped
ExternalContext
object.Map
whose keys are the set of request parameters names included in the current
request, and whose values (of type String) are the first (or only) value for each parameter name returned by the
underlying request.ExternalContext.getRequestParameterMap()
on the wrapped
ExternalContext
object.Iterator
over the names of all request parameters included in the current request.ExternalContext.getRequestParameterNames()
on the wrapped
ExternalContext
object.Map
whose keys are the set of request parameters names included in the current
request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying
request.ExternalContext.getRequestParameterValuesMap()
on the wrapped
ExternalContext
object.Return a path to this resource such that, when the browser resolves it against the base URI for the view that includes the resource, and issues a GET request to the resultant fully qualified URL, the bytes of the resource are returned in response.
The default behavior of this method is to call Resource.getRequestPath()
on the wrapped ResourceHandler
object.
null
.ExternalContext.getRequestPathInfo()
on the wrapped
ExternalContext
object.Returns the name of the scheme used to make this request, for example, http, https, or ftp.
ExternalContext.getRequestScheme()
on the wrapped
ExternalContext
object.Returns the host name of the server to which the request was sent.
ExternalContext.getRequestServerName()
on the wrapped
ExternalContext
object.Returns the port number to which the request was sent.
ExternalContext.getRequestServerPort()
on the wrapped
ExternalContext
object.null
.ExternalContext.getRequestServletPath()
on the wrapped
ExternalContext
object.HttpServletRequest
object.UIInput.setRequiredMessage(java.lang.String)
on this instance, return the message.resetValues
property.URL
for the application resource mapped to the
specified path, if it exists; otherwise, return null
.ExternalContext.getResource(String)
on the wrapped
ExternalContext
object.InputStream
for an application resource mapped to
the specified path, if it exists; otherwise, return null
.ExternalContext.getResourceAsStream(String)
on the wrapped
ExternalContext
object.InputStream
object.ResourceBundle
as defined in the application configuration resources under the specified name.
The default behavior of this method is to call
Application.getResourceBundle(jakarta.faces.context.FacesContext, String)
on the wrapped Application
object.
Return a Map<String,String>
of the ResourceBundle
for this component.
null
if this information is not available.
Return the singleton, stateless, thread-safe ResourceHandler
for this application.
The default behavior of this method is to call Application.getResourceHandler()
on the wrapped
Application
object.
Return the list of resource library contracts that have been calculated to be appropriate for use with this view, or an empty list if there are no such resource library contracts.
FacesContext.getResourceLibraryContracts()
on the wrapped
FacesContext
object.null
if this information is not available.Return the resourceName for this resource.
The default behavior of this method is to call Resource.getResourceName()
on the wrapped
ResourceHandler
object.
Set
of resource paths for all application resources
whose resource path starts with the specified argument.ExternalContext.getResourcePaths(String)
on the wrapped
ExternalContext
object.
Construct an absolute URL to this NavigationCase
instance using
ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String)
on the path portion of the url.
If the value returned from this method is used as the file
argument to the four-argument constructor for
java.net.URL
(assuming appropriate values are used for the first three arguments), then a client making
a request to the toExternalForm()
of that URL
will select the argument path
for direct rendering.
ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.ExternalContext.getResponse()
on the wrapped
ExternalContext
object.ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest, ServletResponse)
.Return the buffer size for the current response.
ExternalContext.getResponseBufferSize()
on the wrapped
ExternalContext
object.ExternalContext.getResponseCharacterEncoding()
on the wrapped
ExternalContext
object.true
if the responseComplete()
method has been called for the current request.FacesContext.getResponseComplete()
on the wrapped
FacesContext
object.ExternalContext.getResponseContentType()
on the wrapped
ExternalContext
object.
Returns a mutable Map<String, String>
whose entries will be sent as response headers during
ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)
.
The default behavior of this method is to call Resource.getResponseHeaders()
on the wrapped
ResourceHandler
object.
Returns an OutputStream
suitable for writing binary data to the user-agent.
ExternalContext.getResponseOutputStream()
on the wrapped
ExternalContext
object.
Returns a Writer
suitable for writing character data to the user-agent.
ExternalContext.getResponseOutputWriter()
on the wrapped
ExternalContext
object.ResponseStateManager
to handle rendering technology specific state management
decisions.RenderKit.getResponseStateManager()
on
the wrapped RenderKit
object.ResponseStream
to which components should direct their binary output.FacesContext.getResponseStream()
on the wrapped
FacesContext
object.ResponseWriter
to which components should direct their character-based output.FacesContext.getResponseWriter()
on the wrapped
FacesContext
object.java.util.stream.Stream
.java.util.stream.Stream
.Return an immutable data structure containing all of the return nodes declared for this flow.
rev
property.rev
property.rev
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.
Unwrap the argument t
until the unwrapping encounters an Object whose getClass()
is not
equal to FacesException.class
or jakarta.el.ELException.class
.
ExceptionHandler.getRootCause(Throwable)
on the wrapped ExceptionHandler
object.Throwable.getCause()
rootElement
property.rowClass
property.rowClass
property.rowClasses
property.rowClasses
property.wrappedData
available, return the length of the array.wrappedData
available, return the length of the list.DataModel
.DataModel
.wrappedData
available, return the length of the list.wrappedData
available, return the length of the array returned by calling
getRows()
on the underlying Result
.ResultSet
does not provide a standard way to determine the number of available rows
without scrolling through the entire ResultSet
, and this can be very expensive if the number of rows is
large.wrappedData
available, return 1.rowIndex
.rowIndex
.null
for no associated row data.rowIndex
.SortedMap
array element at the index specified by
rowIndex
of the array returned by calling getRows()
on the underlying Result
.Map
representing the values of the columns for the row specified by
rowIndex
, keyed by the corresponding column names.rows
property.SortedMap
objects.rules
property.rules
property.ServletRegistration
.RxInvoker
implementation instance.http
, https
, or
ftp
.
Return the scope itself, exposed as a Map
.
Return the name of this custom scope.
Return the script that implements this ClientBehavior's client-side logic.
Default implementation of of ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext)
.
Return the script that implements this ClientBehavior's client-side logic.
Take implementation specific action to discover a Resource
given the argument
componentResource
.
scripting-invalid
configuration, which specifies whether scripting is enabled for
any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.
Creates a SearchExpressionContext
instance for use with the SearchExpressionHandler
.
Returns the SearchExpressionContext
for the current request.
Return the thread-safe singleton SearchExpressionHandler
for this application.
Return the singleton SearchKeywordResolver
instance to be used for all search keyword resolution.
true
if the browser is sending cookies only over a secure protocol, or false
if the
browser can send cookies using any protocol.selectedClass
property.null
if there are no currently selected values.SelectItem
s for this group.Return the character used to separate segments of a clientId.
This method was originally defined to retrieve a servlet from a ServletContext
. In this version, this
method always returns null
and remains only to preserve binary compatibility. This method will be
permanently removed in a future version of Jakarta Servlets.
In lieu of this method, servlets can share information using the ServletContext
class and can perform
shared business logic by invoking methods on common non-servlet classes.
ServletConfig
instance for this servlet.ServletConfig
object.ServletConfig
object, which contains initialization and startup parameters for this servlet.ServletContext
in which the caller is executing.ServletContext
in which this filter is running.ServletContext
in which this servlet is running.ServletContext
in which the caller is executing.servlet-name
for this mapping.FilterRegistration
.
This method was originally defined to return an Enumeration
of all the servlet names known to this
context. In this version, this method always returns an empty Enumeration
and remains only to preserve
binary compatibility. This method will be permanently removed in a future version of Jakarta Servlets.
This method was originally defined to return an Enumeration
of all the servlets known to this servlet
context. In this version, this method always returns an empty enumeration and remains only to preserve binary
compatibility. This method will be permanently removed in a future version of Jakarta Servlets.
create
parameter is true
, create (if necessary) and return a session instance
associated with the current request.ExternalContext.getSession(boolean)
on the wrapped
ExternalContext
object.HttpSession
associated with this request or, if there is no current session and
create
is true, returns a new session.SessionBeanType
representing the kind of session bean.SessionCookieConfig
object through which various properties of the session tracking cookies created
on behalf of this ServletContext may be configured.
Return the id of the current session or the empty string if no session has been created and the create
parameter is false
.
The default behavior of this method is to call ExternalContext.getSessionId(boolean)
on the wrapped
ExternalContext
object.
Map
representing the session scope attributes for the current application.ExternalContext.getSessionMap()
on the wrapped
ExternalContext
object.Returns the maximum time interval, in seconds, that the Jakarta Servlet container will keep this session open between client accesses.
The default behavior of this method is to call ExternalContext.getSessionMaxInactiveInterval()
on the wrapped
ExternalContext
object.
shape
property.shape
property.shape
property.feature
instances.size
property.size
property.size
property.size
property.size
property.writeTo
to ascertain the length in bytes of the serialized form
of t
.AnnotatedType
for which this event is being fired.Bean
for which this event is being fired.ObserverMethod
for which this event is being fired.Returns the source / base component from which we will start to perform our search.
Returns an id for use as the ClientBehavior
source.
Return the immutable id for the default node that should be activated when this flow is entered.
ResponseStateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object)
.
Return the StateHelper
instance used to help this component implement PartialStateHolder
.
Like UIComponent.getStateHelper()
, but only create a state helper instance if the argument creat
is
true
.
For implementations that want to control the implementation of state saving and restoring, the
StateManagementStrategy
allows them to do so.
StateManager
instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call Application.getStateManager()
on the wrapped Application
object.
HttpServletResponse.getStatus()
on the wrapped response object.getJsonString(index).getString()
.String
value of JsonString
at the specified
position in this JSON array values.getJsonString(name).getString()
JsonString
mapping
for the specified name.String
for the name in a name/value pair,
for a string value or a number value.
If the value of this parameter comes from a ValueExpression
return the value of the expression,
otherwise, return the local value.
Manually perform standard conversion steps to get a string value from the value expression.
style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.UIInput
component.
Assume that the submitted value is always a string,
but the return type from this method is Object
..
Given a NamingContainer
component, returns the client ids of any components
underneath the NamingContainer that should be visited.
summary
property.summary
property.Iterator
over the supported Locale
s for this appication.
The default behavior of this method is to call Application.getSupportedLocales()
on the wrapped
Application
object.
Return an immutable data structure containing all of the switch nodes declared for this flow.
system
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.A reference to the Tag for which this class represents the attributes.
A reference to the Tag for which this class represents the attributes.
Return the Tag
representing this handler.
Get the tag handler delegate.
Return the implementation specific delegate instance that provides the bulk of the work for this handler instance.
A document-unique id, follows the convention "_tagId##"
<taglib>
child elements of the <jsp-config>
element represented by
this JspConfigDescriptor
.target
property.target
property.target
property.target
property.
Return the Class
of the metadata target.
Returns the List<UIComponent>
that this AttachedObjectTarget
exposes.
Returns the literal String value of the contained text.
Returns the resolved literal String value of the contained text after evaluating EL.
null
if this exception arose from a failure to decode a binary message..AroundTimeout
.TimeZone
used to interpret a time value.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
param, or null
if this param is not specified.
If this navigation case represents a flow invocation, this property is the documentId in which the flow whose id is
given by the return from NavigationCase.getFromOutcome()
is defined.
Evaluates the <to-view-id>
for this <navigation-case>
HttpServletResponse.getTrailerFields()
on the wrapped response
object.EntityTransaction
object.TransactionPhase
for the observer method.EntityManagerFactory
.
Return the value currently associated with the specified key
if any.
Performs the same logic as TransientStateHelper.getTransient(java.lang.Object)
} but if no value is found, this will return the specified
defaultValue
Return the TransientStateHelper
instance for this UIComponent
instance.
Return the TransientStateHelper
instance for this UIComponent
instance.
TraversableResolver
instance configured
at initialization time for the ValidatorFactory
.TraversableResolver
implementation
or null
if none is specified.ResponseStateManager.getState(jakarta.faces.context.FacesContext, java.lang.String)
. The default implementation returns null
.null
.StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext)
on the wrapped StateManager
object.trim-directive-whitespaces
configuration, which specifies whether template text
containing only whitespaces must be removed from the response output of any JSP pages mapped to the JSP property
group represented by this JspPropertyGroupDescriptor
.null
, returns the most general acceptable type that can be set on this bean
property.base
and property
, attempts to identify the most general type that is
acceptable for an object to be passed as the value
parameter in a future call to the CompositeELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
method.base
and property
, attempts to identify the most general type that is
acceptable for an object to be passed as the value
parameter in a future call to the ELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
method.ResourceBundle
, return null
, since the resolver is
read only.value
parameter in a future call to the ValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)
method.type
property.type
property.type
property.type
property.java.lang.Class
representing the type of the specified property.java.lang.Class
representing the type of the specified index.ValueBinding
, relative to the specified
FacesContext
.null
, and the property matches the name of a JSP implicit object, returns
null
to indicate that no types are ever accepted to setValue()
.null
, returns Object.class
to indicate that any type is valid to
set for a scoped attribute.Type
instance.type
param, or null
if this param is not specified.
Return the UIViewParameter
to which this instance refers.
Return an Iterable
over all ExceptionQueuedEvent
s that have not yet been handled by the
ExceptionHandler.handle()
method.
ExceptionHandler.getUnhandledExceptionQueuedEvents()
on the
wrapped ExceptionHandler
object.unselectedClass
property.URI
of the current resource target.UriBuilder
initialized with this link's underlying URI.
Return an actual URL
instance that refers to this resource instance.
The default behavior of this method is to call Resource.getURL()
on the wrapped ResourceHandler
object.
Return an actual URL
instance that refers to this resource instance.
UIGraphic
.FilterRegistration
.JspPropertyGroupDescriptor
.usemap
property.<f:websocket user>
, if any.Principal
object containing the name of the current authenticated user, if any; otherwise,
return null
.ExternalContext.getUserPrincipal()
on the wrapped
ExternalContext
object.java.security.Principal
object containing the name of the current authenticated user.null
if no user is authenticated for this handshake.null
if no user is authenticated for this session.java.security.Principal
object containing the name of the current authenticated user.Return the validation groups passed to the Validation API when checking constraints.
ValidationProviderResolver
strategy
instance or null
if undefined.ValidationProvider
available in the runtime environment.EditableValueHolder.getValidators()
should be used instead.UIInput.getValidators()
should be used instead.Validator
instance respecting the defined state.Validator
instance using the
factory defaults for message interpolator, traversable resolver
and constraint validator factory.
Return the TagConfig
subclass used to configure this handler instance.
Return the validator-id associated with a particular validator in your faces-config
EditableValueHolder
.Iterator
over the set of currently registered validator ids for this Application
.
The default behavior of this method is to call Application.getValidatorIds()
on the wrapped Application
object.
UIInput.setValidatorMessage(java.lang.String)
on this instance, return the message.Validator
s for this component instance.null
, returns the current value of the given property on this bean.null
and the property is a name that is resolvable by the BeanNameResolver,
returns the value resolved by the BeanNameResolver.property
object on the given base
object by querying all
component resolvers.property
object on the given base
object.property
argument.ResourceBundle
, the provided property will first be coerced to a
String
.Returns the Parameter's value.
value
property of the UICommand
.value
property of the UIGraphic
.
If there is a local value, return it, otherwise return the result of calling super.getVaue()
.
Return the value property.
value
property of the UIParameter
.value
property of the UISelectItem
.value
property of the UISelectItems
.UIComponent
.ValueBinding
, relative to the specified
FacesContext
.
Return a ValueExpression
for the value of the parameter.
target
.JsonValue
at the current parser position.HttpSession.getAttribute(java.lang.String)
.null
, and the property matches the name of a JSP implicit object, returns the
implicit object.null
, searches the page, request, session and application scopes for an
attribute with the given name and returns it, or null
if no attribute exists with the current name.EntityTag
.UIComponent.getValueExpression(java.lang.String)
.UIComponent.getValueExpression(java.lang.String)
.UIGraphic.getValueExpression(java.lang.String)
.UISelectBoolean.getValueExpression(java.lang.String)
.UISelectMany.getValueExpression(java.lang.String)
.EditableValueHolder.getValueChangeListeners()
instead.ValueChangeListener
s for this component instance.ValueChangeListener
s for this UIInput
instance.
Returns the ValueExpression
used to calculate the value for the specified property name, if any.
ValueExpression
used to calculate the value for the specified attribute or property name, if any.ValueExpression
set for value
if a ValueExpression
for url
is
requested; otherwise, perform the default superclass processing for this method.ValueExpression
set for value
if a ValueExpression
for selected
is requested; otherwise, perform the default superclass processing for this method.ValueExpression
set for value
if a ValueExpression
for
selectedValues
is requested; otherwise, perform the default superclass processing for this method.ValueExtractor
s.HttpSession.getAttributeNames()
ValueReference
for this expression instance.JsonValue
from a sequence of
JSON values.VariableMapper
associated with this ELContext
.Application.getELResolver()
.ELContext.getELResolver()
, which can be obtained by
jspContext.getELContext().getELResolver()
.variant
information.Return the immutable VDL document id for this view node.
Utility method to extract view metadata from the provided UIViewRoot
.
Return the ViewDeclarationLanguage
instance used for this
ViewHandler
instance.
ViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String)
on the wrapped
ViewHandler
object.
Return the ViewDeclarationLanguage
instance suitable for
handling the VDL contained in the page referenced by the argument viewId
.
ViewHandler
instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call Application.getViewHandler()
on the wrapped Application
object.
null
if the view identifier is nonexistent or unknown.Get the view id
Return the SystemEventListener
instances registered on this UIComponent
instance that are
interested in events of type eventClass
.
This implementation simply calls through to UIViewRoot.getViewMap(boolean)
, passing true
as the argument,
and returns the result.
Returns a Map
that acts as the interface
to the data store that is the "view scope", or, if this instance does not have such a Map
and the
create
argument is true
, creates one and returns it.
Return a reference to the view metadata for the view represented by the argument viewId
, or
null
if the metadata cannot be found.
Returns a cached View Metadata Facelet instance.
Utility method to extract view metadata from the provided UIViewRoot
.
Return a Stream
possibly lazily populated by walking the resource tree rooted at a given initial path.
Return a Stream
possibly lazily populated by walking the resource tree rooted at a given initial path.
The default behavior of this method is to call
ResourceHandler.getViewResources(FacesContext, String, int, ResourceVisitOption...)
on the wrapped
ResourceHandler
object.
The default behavior of this method is to call
ResourceHandler.getViewResources(FacesContext, String, ResourceVisitOption...)
on the wrapped
ResourceHandler
object.
FacesContext.getViewRoot()
on the wrapped FacesContext
object.
Return a Stream
possibly lazily populated by walking the view trees of every active
ViewDeclarationLanguage
rooted at a given initial path.
Return a Stream
possibly lazily populated by walking the view trees of every active
ViewDeclarationLanguage
rooted at a given initial path.
ViewHandler.getViews(FacesContext, String, ViewVisitOption...)
on the wrapped ViewHandler
object.ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...)
on the wrapped ViewHandler
object.Return an immutable data structure containing all of the view nodes declared for this flow.
Return a Stream
possibly lazily populated by walking the view tree rooted at a given initial path.
Return a Stream
possibly lazily populated by walking the view tree rooted at a given initial path.
Convenience method to return the view state as a String
with no RenderKit
specific markup.
The default behavior of this method is to call StateManager.getViewState(jakarta.faces.context.FacesContext)
on the wrapped StateManager
object.
String
without any markup related to the rendering technology supported
by this ResponseStateManager.
Return a new VisitContext
instance.
Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver
implementation.
warnClass
property.warnClass
property.warnStyle
property.warnStyle
property.
If the value returned from this method is used as the file
argument to the four-argument constructor for
java.net.URL
(assuming appropriate values are used for the first three arguments), then a client making
a push handshake request to the toExternalForm()
of that URL
will select the argument
channel
for connecting the websocket push channel in the current view.
ViewHandler.getWebsocketURL(FacesContext, String)
on the
wrapped ViewHandler
object.width
property.width
property.width
property.If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
A class that implements this interface uses this method to return an instance of the class being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
DataModel
, if any.DataModel
, if any.
Return a Method
for the setter of the property with name given by argument name
.
PrintWriter
object that can send character text to the client.xmlns
property.xmlns
property.java.util.stream.Collector
that implements a "group by" operation on the
input JsonValue
elements.java.util.stream.Collector
that implements a "group by" operation on the
input JsonValue
elements.
Take action to handle the Exception
instances residing inside the ExceptionQueuedEvent
instances
that have been queued by calls to Application().publishEvent(ExceptionQueuedEvent.class,
eventContext)
.
ExceptionHandler.handle()
on the wrapped
ExceptionHandler
object.HandleDelegate
interface is implemented by the enterprise bean container.FacesContext
, plus the outcome string returned by an executed application action.
Overloaded variant of
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
that allows the
caller to provide the defining document id for a flow to be entered by this navigation.
This method specifies the contract for satisfying resource requests.
The default behavior of this method is to call
ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)
on the wrapped
ResourceHandler
object.
ServletContainerInitializer
can handle.true
if this component has a non-null
binding attribute.
Test if this navigation case has an associated <if>
element.
true
if the executable parameters are constrained either:
because of a constraint on at least one of the parameters
because of a cascade on at least one of the parameters (via
Valid
)
because of at least one cross-parameter constraint
true
if the executable return value is constrained
either:
because of a constraint on the return value
because validation is cascaded on the return value (via
Valid
)
true
if at least one constraint declaration
matching the restrictions is present on the element,
false
otherwise.false
.Expression
.Overrides the default hash code method to take the minimum and maximum into account when generating the hash code.
JsonNumber
object.JsonString
object.
Utility method to determine if the the provided UIViewRoot
has metadata.
true
if there are more parsing states.retry the request
.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String>
causes the map returned from ExternalContext.getRequestHeaderMap()
to
be injected as the value of that field.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String[]>
causes the map returned from
ExternalContext.getRequestHeaderValuesMap()
to be injected as the value of that field.
The ServletContext
init parameter consulted by the UIComponent
to tell whether or not the
UIComponent.CURRENT_COMPONENT
and UIComponent.CURRENT_COMPOSITE_COMPONENT
attribute keys should be honored as specified.
RenderKit
instance for this Jakarta Server Faces implementation.table
element.input
element for a button of type submit
or reset
.a
element for a hyperlink that acts like a submit button.script
element for a function that acts like an ajax form submit.table
element.form
element.img
element, used to retrieve and render a graphical image.input
element of type hidden
.input
element of type password
.input
element of type text
.textarea
element.rendererType
property must be set to "jakarta.faces.Message
".rendererType
property must be set to "jakarta.faces.Messages
".input
element of type "button" or image that may be used to link to a URL handled by
the Faces Servlet resolved preemptively using the logical outcome defined by the outcome
property.a
(hyperlink) element that may be used to link to a URL handled by the Faces Servlet
resolved preemptively using the logical outcome defined by the outcome
property.MessageFormat
pattern string and substitutes in parameter values from nested UIParameter
components, and renders the result.label
element, used to define an accessible label for a corresponding input element.a
(hyperlink) element that may be used to link to an arbitrary URL defined by the
value
property.span
element if I18N attributes, CSS
styles or style classes are specified.input
element of type
checkbox
.input
elements of type checkbox
.select
element, showing either all
available options or the specified number of options.select
element, showing a single
available option at a time.select
element, showing either all
available options or the specified number of options.select
element, showing a single
available option at a time.input
elements of type radio
.HttpAuthenticationMechanism
is a mechanism for obtaining a caller's
credentials in some way, using the HTTP protocol where necessary.ServletSecurity
annotation to represent the security constraints to be
applied to all HTTP protocol methods for which a corresponding HttpMethodConstraint
element does NOT occur
within the ServletSecurity
annotation.HttpConstraint
annotation value.HttpMessageContext
contains all of the per-request state information and encapsulates the client request,
server response, container handler for authentication callbacks, and the subject representing the caller.ServletSecurity
annotation to represent security constraints on specific
HTTP protocol messages.HttpMethodConstraint
annotation value.HttpConstraintElement
value.HttpConstraintElement
value.HttpServlet
for the current HttpServletRequest
was invoked.ServletRequest
interface to provide request information for HTTP servlets.ServletResponse
interface to provide HTTP-specific functionality in sending a response.HttpSessionBindingListener
when it is bound
or unbound from a session, or to a HttpSessionAttributeListener
that has been configured in the deployment
descriptor when any attribute is bound, unbound or replaced in a session.HttpUtils
object.PassivationCapable
and its Id for passivation.Set the defining document id and flow id of this flow.
IdentifiableType
represent entity or
mapped superclass types.IdentityStore
is a mechanism for validating a caller's credentials
and accessing a caller's identity attributes.IdentityStoreHandler
is a mechanism for validating a caller's
credentials, and accessing a caller's identity attributes, by consulting
a set of one or more IdentityStore
s.
Customize this MetaRuleset
instance to advise it to ignore the attribute named by the
attribute
argument, returning this
.
Customize this MetaRuleset
instance to advise it to ignore all attributes, returning this
.
InterceptionFactory.createInterceptedInstance(Object)
.META-INF/validation.xml
file if this
method is called.Dependent
.
The presence of an entry under this key in the Map
returned from ExceptionQueuedEventContext.getAttributes()
indicates the
event occurred during the “after phase” part of the current lifecycle phase.
The presence of an entry under this key in the Map
returned from ExceptionQueuedEventContext.getAttributes()
indicates the
event occurred during the “before phase” part of the current lifecycle phase.
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
include
is storedHttpServletMapping
of the target of an
include
is storedinclude
is storedinclude
is storedinclude
is storedinclude
is storedInclude another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in Jakarta Server Pages)
Include another Facelet defined at some path, absolute to this ClassLoader/OS
Indicates the current redirect should include view parameters.
List
, Map
or
Optional
.List
, Map
or
Optional
.create<METHOD>
method of an
adapted home or local home interface (an interface that adapts an enterprise bean 2.1 or earlier EJBHome or
EJBLocalHome client view respectively).super.init(config)
.super.init(config)
.ConstraintValidator.isValid(Object, ConstraintValidatorContext)
calls.Initialized
qualifier.A MethodExpression that will be invoked when the flow is entered.
A MethodExpression that will be invoked when the flow is entered.
Implementation of PartialStateHolder.initialStateMarked()
.
Return true
if delta state changes are being tracked, otherwise false
An implementation of PartialStateHolder.initialStateMarked()
, this method is called by the runtime to test if
the PartialStateHolder.markInitialState()
method was called.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String>
causes the map returned from ExternalContext.getInitParameterMap()
to
be injected as the value of that field.
ViewHandler.initView(jakarta.faces.context.FacesContext)
on the wrapped ViewHandler
object.InjectionPoint
instance.InjectionTargetFactory
can create an InjectionTarget
for a given bean.Inject
annotation.Called by the flow system to cause the flow to be inspected for navigation rules.
FacesMessage
to be created if the conversion to
Integer
fails.Converter
implementation for java.lang.Integer
(and int primitive) values.InterceptionFactory
allows to create a wrapper instance whose method invocations are intercepted by method
interceptors and forwarded to a provided instance.MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream)
and MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)
.internal server
error
.int
.int
.FacesMessage
to be created if a value not matching
the available options is specified.FacesMessage
to be created if a value not matching
the available options is specified.Invalidates this session then unbinds any objects bound to it.
ExternalContext.invalidateSession()
on the wrapped
ExternalContext
object.null
, invoke the method, with the given parameters on this bean.method
on the given base
object by querying all
component resolvers.method
on the given base
object.FacesContext
.UIComponent.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)
and must be passed the
component with the clientId
given as an argument to invokeOnComponent
.
This method will be called by an implementation of SearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String)
with the resolved component
for the keyword.
Resolves multiple UIComponent
s for the given expression.
Resolves multiple UIComponent
s for the given expression.
clientId
equal to the argument clientId
and, if found, call the
ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
method on the argument callback
, passing the current
FacesContext
and the found component as arguments.clientId
equal to the argument clientId
and, if found, call the
ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
method on the argument callback
, passing the current
FacesContext
and the found component as arguments.UIComponentBase.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)
to provide special care for positioning the data
properly before finding the component and invoking the callback on it.UIComponent.visitTree()
to visit a single component.
Marker within the FacesContext
attributes map to indicate we are marking initial state, so the
markInitialState()
method of iterating components such as UIData
could
recognize this fact and save the initial state of descendents.
Marker within the FacesContext
attributes map to indicate we are saving state.
Return true
if and only if the flow referenced by the argument definingDocument
and id
is
currently active.
Return true
if the request header Faces-Request
is present with the value
partial/ajax
.
PartialViewContext.isAjaxRequest()
on the wrapped
PartialViewContext
object.Instance
was injected.
Return true
if this FacesListener
is an instance of a the appropriate listener class that this
event supports.
Return true
if the argument FacesListener
is an instance of the appropriate listener class that
this event supports.
true
if this FacesListener
is an instance of a listener class that this event supports.
Returns true
if and only if the argument listener
is an instance of
SystemEventListener
.
Returns true
if and only if the argument listener
is an instance of
SystemEventListener
.
true
if this FacesListener
is an instance of a
the appropriate listener class that this event supports.SecurityContext.authenticate(HttpServletRequest, HttpServletResponse, AuthenticationParameters)
autorun
property.true
if the bean involves validation:
a constraint is hosted on the bean itself
a constraint is hosted on one of the bean properties
or a bean property is marked for cascaded validation (Valid
)
@Valid
.Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so.
Return true
if component
is a composite component, otherwise false
.
From
object has been obtained as a result of
correlation (use of a Subquery
correlate
method).true
if this attribute is to be passed a MethodExpression
so that expression
evaluation can be deferred.true
if this attribute is to be passed a ValueExpression
so that expression
evaluation can be deferred.
Return the value of the disable
directive for this component.
Return whether or not the client window should be encoded into the target url.
Return the disabled status of this behavior.
disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.true
.Is the value denoting an empty value.
The default behavior of this method is to call Map.isEmpty()
on the wrapped Flash
object.
feature
instance has been previously enabled in the runtime configuration
context.feature
instance of featureClass
class has been previously enabled in the runtime
configuration context.escape
property.escape
property.escape
property.
If and only if this returns true
, the code that renders this select item must escape the label using
escaping syntax appropriate to the content type being rendered.
Return true
if PartialViewContext.isAjaxRequest()
returns true
and PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME
is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS
.
PartialViewContext.isExecuteAll()
on the wrapped
PartialViewContext
object.Determines whether a cached Facelet instance exists for this URL.
true
if getAsString
should include grouping separators if necessary.true
if this cookie contains the HttpOnly
attribute.true
if Configuration.ignoreXmlConfiguration()
has been
called.ActionListener
provided by the Jakarta Server Faces implementation
should be executed immediately (that is, during Apply Request Values phase of the request processing
lifecycle), rather than waiting until the Invoke Application phase.Return the immediate status of this behavior.
If the value of the component's immediate
attribute is true
, the action will be invoked
during the Apply Request Values Jakarta Server Faces lifecycle phase.
Return false
.
Tests whether the immediate attribute is specified.
Return the <redirect>
value for this <navigation-case>
.
Return whether or not the view parameters should be encoded into the target url.
true
if only the integer portion of the given value should be returned from
getAsObject()
.
Return true
if this component is within the view hierarchy otherwise false
Override superclass method to always return true
because a UIViewRoot
is defined to always be in a
view.
ismap
property.Return the value of this JavaBeans property for the flash for this session.
The default behavior of this method is to call Flash.isKeepMessages()
on the wrapped Flash
object.
Returns if the keyword was resolved.
A leaf keyword is a keyword that does not allow to be combined with keywords or id chains to the right.
true
if and only if this listener instance is interested in receiving events
from the instance referenced by the source
parameter.ExceptionHandler.isListenerForSource(Object)
on the wrapped ExceptionHandler
object.true
if and only if this listener instance is interested in receiving events
from the instance referenced by the source
parameter.FetchType.EAGER
has been specified have been loaded, this
method returns LoadState.LOADED
.LoadState.LOADED
.LoadState.LOADED
.Predicate.not()
method
or the CriteriaBuilder.not()
method.Determine if the passed component is not null and if it's new to the tree.
true
if the client does not yet know about the session or if the client chooses not to join the
session.
Return the value of the noSelectionOption
property.
Return the value of the noSelectionOption
property.
true
if the value at the specified location in this
array is JsonValue.NULL
.true
if the associated value for the specified name is
JsonValue.NULL
.Contextual.create(CreationalContext)
sometimes return a null value.
If true
this component will operate on postback.
opened
.
Return true
PartialViewContext.isAjaxRequest()
returns true
or if the request header
Faces-Request
is present with the value partial/process
.
PartialViewContext.isPartialRequest()
on the wrapped
PartialViewContext
object.A passthrough keyword is a keyword, that according to the context, does not require to be resolved on the server, and can be passed "unresolved" to the client.
Checks if the given expression is a "passtrough expression".
boolean
indicating whether the servlet is permanently unavailable.
This utility method simply returns the result of
ResponseStateManager.isPostback(FacesContext)
.
FacesContext.isPostback()
on the wrapped FacesContext
object.
Returns true
if the current request processing lifecycle is in the midst of processing the broadcast of
an event queued during a call to UIViewAction.decode(jakarta.faces.context.FacesContext)
.
Returns a flag indicating whether or not the runtime should publish events when asked to do so.
FacesContext.isProcessingEvents()
on the
wrapped FacesContext
object.
Return true
if the current ProjectStage
as returned by the Application
instance is equal
to stage
, otherwise return false
FacesContext.isProjectStage(jakarta.faces.application.ProjectStage)
on the wrapped
FacesContext
object.ELResolver
has successfully resolved a given (base, property) pair.RxInvoker
subclass.ArrayELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.null
, returns whether a call to BeanELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.base
and property
, attempts to determine whether a call to CompositeELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.base
and property
, attempts to determine whether a call to ELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.ListELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.MapELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.true
if a call to
ValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)
will always fail.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.true
if the specified property of the specified property is known to be immutable; otherwise,
return false
.null
, and the property matches the name of a JSP implicit object, returns
true
to indicate that implicit objects cannot be overwritten.null
, returns false
to indicate that scoped attributes are never
read-only.
Return the <redirect>
value for this <navigation-case>
.
Return the value of this property for the flash for this session.
The default behavior of this method is to call Flash.isRedirect()
on the wrapped Flash
object.
redisplay
property.component
instance (such as providers or features
) has been
previously registered in the runtime configuration context.componentClass
class has been previously registered in the
runtime configuration context.
Return a flag indicating if the resources associated with this FacesContext
instance have been released.
The default behavior of this method is to call FacesContext.isReleased()
on the wrapped FacesContext
object.
Return true
if PartialViewContext.isAjaxRequest()
returns true
and PartialViewContext.PARTIAL_RENDER_PARAM_NAME
is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS
.
PartialViewContext.isRenderAll()
on the wrapped
PartialViewContext
object.true
if this component (and its children) should be rendered during the Render Response
phase of the request processing lifecycle.
Return true
if this component should take the actions specified in the UIViewAction.decode(jakarta.faces.context.FacesContext)
method.
HttpServletRequest.isRequestedSessionIdFromURL()
instead.HttpServletRequestWrapper.isRequestedSessionIdFromURL()
instead.Return the resetValues status of this behavior.
Return true
if the incoming request has a parameter named by the value of
PartialViewContext.RESET_VALUES_PARAM_NAME
and that value is true
.
PartialViewContext.isResetValues()
on the wrapped
PartialViewContext
object.Tests whether the resetValues attribute is specified.
Instance
was injected.
Checks if the current instance of the SearchKeywordResolver
is responsible for resolving the keyword.
Returns whether the resource as identified by given resource and library name has been rendered.
The default behavior of this method is to call
ResourceHandler.isResourceRendered(FacesContext, String, String)
on the wrapped ResourceHandler
object.
Return true
if the current request is a resource request.
The default behavior of this method is to call
ResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext)
on the wrapped ResourceHandler
object.
Return true
if the argument url
contains the string given by the value of the constant
ResourceHandler.RESOURCE_IDENTIFIER
, false otherwise.
The default behavior of this method is to call ResourceHandler.isResourceURL(java.lang.String)
on the wrapped
ResourceHandler
object.
Check if the current response has been committed.
ExternalContext.isResponseCommitted()
on the wrapped
ExternalContext
object.rowData
available at the current rowIndex
.true
if there is wrappedData
available, and the current value of
rowIndex
is greater than or equal to zero, and less than the length of the array.true
if there is wrappedData
available, and the current value of
rowIndex
is greater than or equal to zero, and less than the size of the list.rowData
available at the current rowIndex
.rowData
available at the current rowIndex
.true
if there is wrappedData
available, and the current value of
rowIndex
is greater than or equal to zero, and less than the size of the list.true
if there is wrappedData
available, and the current value of
rowIndex
is greater than or equal to zero, and less than the length of the array returned by calling
getRows()
on the underlying Result
.true
if there is wrappedData
available, and the result of calling
absolute()
on the underlying ResultSet
, passing the current value of rowIndex
plus one (to account for the fact that ResultSet
uses one-relative indexing), returns true
.true
if there is wrappedData
available, and the current value of
rowIndex
is zero.rowHeader
property.
Return the value of the rowStatePreserved
JavaBeans property.
StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)
on the wrapped StateManager
object.Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
The default behavior of this method is to call ExternalContext.isSecure()
on the wrapped
ExternalContext
object.
detail
property of the associated message(s) should be displayed.detail
property of the associated message(s) should be displayed.summary
property of the associated message(s) should be
displayed.summary
property of the associated message(s) should be
displayed.
If the preceding call to ResponseStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
was stateless,
return true
.
submitted
property.
Return true if the target for this metadata element is an instance of the argument type
.
tooltip
property.tooltip
property.HttpServletRequest.getTrailerFields()
.
Implementation of StateHolder.isTransient()
.
Instance
was injected.true
if the currently authenticated user is included in the specified role.ExternalContext.isUserInRole(String)
on the wrapped
ExternalContext
object.
Return true
if the validationFailed()
method has been called for the current request.
FacesContext.isValidationFailed()
on the
wrapped FacesContext
object.Checks if the given expression is a valid expression.
true
if the specified value conforms to the syntax requirements of a value binding expression.Determines whether a cached View Metadata Facelet instance exists for this URL.
Return true
if this component should be visited, false
otherwise.
EntityTag
.ServletRequest
instance.ServletRequest
of the given class type.ServletResponse
instance.ServletResponse
of the given class type.
IterableDataModel is an implementation of DataModel
that wraps an Iterable
.
IterableDataModel
with no specified wrapped data.IterableDataModel
wrapping the specified iterable.
Return a read-only Iterator
over the row data for this model.
JsonbBuilder
objects.web.xml
and
web-fragment.xml
descriptors.ClientBuilder
implementation to be returned from
ClientBuilder.newBuilder()
.SseEventSource.Builder
implementation to be returned from
SseEventSource.Builder.newBuilder()
.RuntimeDelegate
implementation to be returned from
RuntimeDelegate.getInstance()
.Library name of Jakarta Server Faces script resource.
Resource name of Jakarta Server Faces script resource.
JsonArray
represents an immutable JSON array
(an ordered sequence of zero or more values).JsonArray
models from scratch, and for
modifying a existing JsonArray
.Jsonb
provides an abstraction over the JSON Binding framework operations:JsonObjectBuilder
and JsonArrayBuilder
instances.java.util.stream.Collector
for accumulating
JsonValue
s into JsonArray
and JsonObject
.JsonException
indicates that some exception happened during
JSON processing.JsonGenerationException
indicates an incorrect JSON is
being generated.JsonGenerator
instances.JsonObject
class represents an immutable JSON object value
(an unordered collection of zero or more name/value pairs).JsonObject
models from scratch.JsonParser
.JsonParser
instances.JsonParsingException
is used when an incorrect JSON is
being parsed.JsonReader
instances.JsonValue
represents an immutable JSON value.JsonValue
object.JsonWriter
instances.Identifier for the Jakarta Server Pages view declaration language.
<jsp-config>
related configuration of a web application.JspContext
serves as the base class for the PageContext class and abstracts all information that is not
specific to servlets.JspException
with the specified detail message and cause.JspException
with the specified cause.<jsp-property-group>
related configuration of a web
application.
Causes a value stored with a previous call to Flash.putNow(java.lang.String, java.lang.Object)
, its Jakarta Expression Language equivalent, or to the
request Map
, to be promoted to the flash so that is available on the next traversal through the
lifecycle on this session.
The default behavior of this method is to call Flash.keep(String)
on the wrapped Flash
object.
The default behavior of this method is to call Map.keySet()
on the wrapped Flash
object.
The prefix to identify a keyword.
ValueExpression
.Variant.VariantListBuilder
initialized with a set of supported languages."Last-Event-ID"
HTTP request header name as defined by
SSE specification.IdentityStore
that stores
caller credentials and identity attributes (together caller identities) in an
LDAP store, and make that implementation available as an enabled CDI bean.Validator
that checks the number of
characters in the String representation of the value of the associated component.Validator
with no preconfigured limits.Validator
with the specified preconfigured limit.Validator
with the specified preconfigured limits.
Return true
if the resource library named by the argument
libraryName
can be found.
The default behavior of this method is to call ResourceHandler.libraryExists(String)
on the wrapped
ResourceHandler
object.
LifecycleFactory
class name.Lifecycle
instance to be utilized.Lifecycle
instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
If this lifecycle has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
XmlAdapter
that maps the JAX-RS
Link
type to a value that can be marshalled and unmarshalled by JAXB.Link
that can be marshalled and
unmarshalled by JAXB.ListAttribute
represent persistent
java.util.List
-valued attributes.DataModel
that wraps an List
of Java objects.ListDataModel
with no specified wrapped data.ListDataModel
wrapping the specified list.List
.ListELResolver
.ListELResolver
whose read-only status is determined by the given parameter.
Classes tagged with this annotation are installed as listeners using the method
Application.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Class<?>, jakarta.faces.event.SystemEventListener)
or
UIComponent.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, jakarta.faces.event.ComponentSystemEventListener)
(depending on the circumstances, described below).
Container annotation to specify multiple ListenerFor
annotations on a single class.
ListJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.List
.ProviderUtil
SPI methods.
The name of a key within the application message bundle named by the return from Application.getMessageBundle()
whose value is the locale prefix used to find a packaged resource to return from ResourceHandler.createResource(java.lang.String)
(or one of
its variants).
An object that represents the Location of a tag or attribute of a tag in a View Declaration Language file.
LockModeType
argument to one of the EntityManager
methods that take locks
(lock
, find
, or refresh
) or
to the Query.setLockMode()
or
TypedQuery.setLockMode()
method.LockTimeoutException
exception
with null
as its detail message.LockTimeoutException
exception
with the specified detail message.LockTimeoutException
exception
with the specified detail message and cause.LockTimeoutException
exception
with the specified cause.LockTimeoutException
exception
with the specified object.LockTimeoutException
exception
with the specified detail message, cause, and entity.ExternalContext.log(String)
on the wrapped
ExternalContext
object.ExternalContext.log(String, Throwable)
on the wrapped
ExternalContext
object.Throwable
exception to the servlet log file,
prepended by the servlet's name.ServletContext.log(String message, Throwable throwable)
instead.
This method was originally defined to write an exception's stack trace and an explanatory error message to the servlet log file.
Throwable
exception to the servlet log file.ServletContext
.LoginToContinue
annotation provides an application the ability to declaratively
add login to continue functionality to an authentication mechanism.null
as the value returned when getUserPrincipal
, getRemoteUser
, and
getAuthType
is called on the request.FacesMessage
to be created if the conversion to
Long
fails.Converter
implementation for java.lang.Long
(and long primitive) values.Validator
that checks the value
of the corresponding component against specified minimum and maximum values.Validator
with no preconfigured limits.Validator
with the specified preconfigured limit.Validator
with the specified preconfigured limits.long
.long
.java:
namespace.ManagedBean
annotation marks a POJO (Plain Old Java Object)
as a ManagedBean.jakarta.enterprise.context.Initialized
event for
jakarta.enterprise.context.ApplicationScoped
. See 6.7.3 of the CDI spec for further details.
The presence of this annotation (along with @Inject
) on a field of any type causes the value returned from
evaluating an expression language expression to be injected as the value of that field.
jakarta.faces.annotation.ManagedProperty
, which is a CDI build-in bean
with similar semanticsManagedType
represent entity, mapped
superclass, and embeddable types.MapAttribute
represent
persistent java.util.Map
-valued attributes.Map
.MapELResolver
.MapELResolver
whose read-only status is determined by the given parameter.MapJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.Map
.java.util.Map
when the map key is itself the primary
key or a persistent field or property of the entity that is
the value of the map.java.util.Map
.MappedSuperclassType
represent mapped
superclass types.ManyToOne
or
OneToOne
relationship attribute that provides the
mapping for an EmbeddedId
primary key, an attribute within
an EmbeddedId
primary key, or a simple primary key of
the parent entity.Mark this node as the start node in the flow.
Implementation of PartialStateHolder.markInitialState()
.
The runtime must ensure that the PartialStateHolder.markInitialState()
method is called on each instance of this interface in the
view at the appropriate time to indicate the component is in its initial state.
An implementation of PartialStateHolder.markInitialState()
, this method is called by the runtime to indicate
that the instance should start tracking changes to its state.
For each of the attached objects on this instance that implement PartialStateHolder
, call
PartialStateHolder.markInitialState()
on the attached object.
Override the base class method to take special action if the method is being invoked when
StateManager.IS_BUILDING_INITIAL_STATE
is true and the rowStatePreserved
JavaBeans property for this instance is true
.
UIOutput
when PartialStateHolder.markInitialState()
is called,
check if any of the installed Validator
s are PartialStateHolders and if so, call
PartialStateHolder.markInitialState()
as appropriate.UIComponentBase
when PartialStateHolder.markInitialState()
is
called, check if the installed Converter
is a PartialStateHolder and if it is, call
PartialStateHolder.markInitialState()
on it.Mark the resource as identified by given resource and library name as rendered.
The default behavior of this method is to call
ResourceHandler.markResourceRendered(FacesContext, String, String)
on the wrapped ResourceHandler
object.
Link
into a Link.JaxbLink
.FacesMessage
to be created if the act of matching the
value against the pattern returned from RegexValidator.getPattern()
fails because of a PatternSyntaxException
.WebTarget
instance by appending a matrix parameter to the existing set of matrix parameters of
the current final segment of the URI of the current target instance.Max
annotations on the same element.FacesMessage
to be created if the maximum value check
fails.FacesMessage
to be created if the maximum length
check fails.FacesMessage
to be created if the maximum value check
fails.MediaType
with the supplied type, subtype and parameters.MediaType
with the supplied type and subtype.MediaType
with the supplied type, subtype and "charset"
parameter.MediaType
, both type and subtype are wildcards.media type
of the event data.Variant.VariantListBuilder
initialized with a set of supported media types.FacesMessage
to be created if a constraint failure is
found.Validator
.There are concrete subclasses within the implementation that map concepts in the Facelet VDL page to Jakarta Server Faces Java API calls the appropriate instances.
The root class of the abstraction that dictates how attributes on a markup element in a Facelets VDL page are wired to the Jakarta Server Faces API object instance associated with that element.
A mutable set of rules to be used in auto-wiring state to a particular object instance.
Every kind of markup element in Facelets VDL that has attributes that need to take action on a Jakarta Server Faces Java API artifact is associated with an instance of this class.
MethodExpression
.
Create a method call node in the current Flow
.
Define a method call node.
Represents a method call node in the flow graph.
Expression
that refers to a method on an object.ValueChangeListener
that
contains a MethodExpression
.Validator
that wraps a
MethodExpression
, and it performs validation by executing a method on an object identified by the
MethodExpression
.Validator
that contains a MethodExpression
.ValueChangeListener
that contains a
MethodExpression
.To accommodate method expression targets that take no
arguments instead of taking a ValueChangeEvent
argument, the implementation of this class must take
the argument methodExpressionOneArg
, extract its expression string, and create another
MethodExpression
whose expected param types match those of a zero argument method.ValueChangeListener
that contains a MethodExpression
.MethodExpression
evaluated to.MethodInfo
with the given information.MethodExpression
.MethodNotFoundException
with no detail message.MethodNotFoundException
with the provided detail message.MethodNotFoundException
with the given root cause.MethodNotFoundException
with the given detail message and root cause.MethodNotFoundException
.Min
annotations on the same element.FacesMessage
to be created if the minimum value check
fails.FacesMessage
to be created if the minimum length
check fails.FacesMessage
to be created if the minimum value check
fails.String
constant representing "multipart/form-data" media type.MediaType
constant representing "multipart/form-data" media type.Servlet
class, indicating that instances of the
Servlet expect requests that conform to the multipart/form-data MIME type.MultipartConfig
annotation value.MultipartConfig
annotation value.MultivaluedMap
interface.16
) and the default load factor
(0.75
).0.75
).MultivaluedMap
.Map
.NamedAttributeNode
is a member element of a
NamedEntityGraph
.NamedEntityGraph
annotations.
The presence of this annotation on a class automatically registers the class with the runtime as a
ComponentSystemEvent
for use with the <f:event />
tag in a page.
Named
qualifier.NamedSubgraph
is a member element of a
NamedEntityGraph
.
Components that declare a createTag = true
attribute will be placed into this tag namespace if the
namespace attribute is omitted.
UIComponent
that wants to be a naming container.
NavigationCase represents a <navigation-case>
in
the navigation rule base, as well as the <from-view-id>
with
which this <navigation-case>
is a sibling.
Construct a new NavigationCase
based on the provided arguments.
Construct a new NavigationCase
based on the provided arguments.
Define a particular combination of conditions that must match for this case to be executed, and the view id of the component tree that should be selected next.
Create a navigation case in the current Flow
.
Allows populating the redirect with parameters and setting the includeViewParams option.
Provides a simple implementation of NavigationCase
that can be
subclassed by developers wishing to provide specialized behavior to an existing NavigationCase
instance.
If this navigation case has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
NavigationHandlerWrapper provides a simple implementation of
NavigationHandler
that can be subclassed by developers wishing to provide specialized behavior to an existing
NavigationHandler
instance.
If this navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Negative
constraints on the same element.NegativeOrZero
constraints on the same element.New
qualifier was deprecated in CDI 1.1.New
qualifier.JsonbBuilder
instance as returned by the default
JsonbProvider.provider()
method.JsonbBuilder
instance as returned by
JsonbProvider.provider(String)
method.JsonbBuilder
instance as returned by
provider#create
call.ClientBuilder
instance using the default client builder implementation class provided by the
JAX-RS implementation provider.Client
instance using the default client builder implementation class provided by the JAX-RS
implementation provider.Client
instance using the default client builder implementation class provided
by the JAX-RS implementation provider.OutboundSseEvent
from provided data.OutboundSseEvent
from provided data and name.ExpressionFactory
.ExpressionFactory
, with optional properties.SeContainerInitializer
Each call returns a new instanceCreate a Facelet or View Metadata Facelet (depending on the type of factory this is) for the argument URL.
PushBuilder
for issuing server push responses from the current request.
A reference to the FaceletHandler
that represents the first nested child of this TagHandler
instance.
MessageBodyReader
implementations when reading a zero-length
message content to indicate that the message body reader is not able to produce an instance representing an
zero-length message content.NoContentException
instance.NoContentException
instance.NoContentException
instance.Base interface for building all kinds of flow nodes.
The value of this constant is taken to be the name of a request parameter whose value is inspected to verify the
safety of an incoming non-postback request with respect to the currently configured Set
of protected
views for this application.
Nonbinding
annotation.jakarta.enterprise.context.Dependent
, which is a CDI build-in scope
with approximately similar semantics.Query.getSingleResult()
or TypedQuery.getSingleResult()
is executed on a
query and there is more than one result from the query.NonUniqueResultException
exception
with null
as its detail message.NonUniqueResultException
exception
with the specified detail message.Query.getSingleResult()
or TypedQuery.getSingleResult()
is executed on a query
and there is no result to return.NoResultException
exception with
null
as its detail message.NoResultException
exception with the
specified detail message.FacesMessage
to be created if the maximum or minimum
value check fails, and both the maximum and minimum values for this validator have been set.FacesMessage
to be created if the maximum or minimum
value check fails, and both the maximum and minimum values for this validator have been set.FacesMessage
to be created if the act of matching the
value against the pattern returned from RegexValidator.getPattern()
fails because the value does not match the pattern.not
acceptable
by the server.not allowed
.null
and must contain at least one
non-whitespace character.@NotBlank
constraints on the same element.null
nor empty.@NotEmpty
constraints on the same element.not found
on the server.SecurityContext.isCallerInRole(String)
etc.SecurityContext.isCallerInRole(String)
etc.CredentialValidationResult
result of an
identity store directly on to the container.null
.NotNull
annotations on the same element.not supported
.null
.Null
annotations on the same element.
Components that are rendered by Renderers
of component-family jakarta.faces.OutcomeTarget
must use this constant as the value of the parameter named by FlowHandler.TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME
when
returning from a flow (without entering another flow) using such a component.
Because null
values are not allowed as the source for subclasses of EventObject
, such as
PostKeepFlashValueEvent
and PostPutFlashValueEvent
, this value is substituted for null
as the source in the case when a null
value is put to or kept in the flash.
FacesMessage
to be created if the conversion to
Number
fails.Converter
implementation for java.lang.Number
values.Number
object.ObserverMethodConfigurator
can configure an ObserverMethod
.SseEventSink
or
tries to write to a given SseEventSink
that is already closed (either by client closing the connection
or by calling SseEventSink.close()
on the server side.This method is guaranteed to be called after the component has been created but before it has been populated with children.
This method is guaranteed to be called after the component has been populated with children.
ReadListener
is registered with a ServletInputStream
, this method will
be invoked by the container the first time when it is possible to read data.SseEventSink
when this SseBroadcaster tries to write to it or close it.ServletRequest.startAsync()
methods.ServletOutputStream
, this method will be invoked
by the container the first time when it is possible to write data.web target
and start processing incoming
events
.OptimisticLockException
exception with
null
as its detail message.OptimisticLockException
exception with the
specified detail message.OptimisticLockException
exception with the
specified detail message and cause.OptimisticLockException
exception with the
specified cause.OptimisticLockException
exception with the
specified entity.OptimisticLockException
exception with the
specified detail message, cause, and entity.ServletContext
attribute whose value (of type
java.util.List<java.lang.String>
) contains the list of names of JAR files in
WEB-INF/lib
ordered by their web fragment names (with possible exclusions if
<absolute-ordering>
without any <others/>
is being used), or null if no
absolute or relative ordering has been specifiedDefine an outbound parameter for the flow call.
Define an outbound parameter for the flow call.
OutboundSseEvent
instances.OverridesAttribute
annotations on the same elementPageContext
for the page we are embedded in.String
form of a message parameter
value and the corresponding custom Java type T
.default value
delegated to a parameter
converter
annotated with @Lazy
annotation SHOULD occur only once the value is actually required (e.g.ParamConverter
instances.Creates a Parameter instance.
Add a parameter to the redirect.
Represents a parameter in any of several places where parameters are needed when processing flows.
Validator
.Set the parameters of the method call node.
HashTable
object with key-value
pairs.multipart/form-data
POST request.The request parameter name whose request parameter value identifies the type of partial event.
The request parameter name whose request parameter value is a Collection
of client identifiers
identifying the components that must be processed during the Apply Request Values, Process
Validations, and Update Model Values phases of the request processing lifecycle.
The request parameter name whose request parameter value is a Collection
of client identifiers
identifying the components that must be processed during the Render Response phase of the request processing
lifecycle.
The ServletContext
init parameter consulted by the runtime to determine if the partial state saving
mechanism should be used.
The property name for the PartialViewContextFactory
class name.
PartialResponseWriter decorates an existing ResponseWriter
to support the generation of
a partial response suitable for Ajax operations.
Create a PartialResponseWriter
.
Components that want to leverage the partial state saving feature must implement this interface instead of
implementing StateHolder
, from which this interface inherits.
PartialViewContextFactory is a factory object that creates (if needed) and
returns new PartialViewContext
instances.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Provides a simple implementation of
PartialViewContext
that can be subclassed by developers wishing to provide specialized behavior to an
existing PartialViewContext
instance.
If this partial view context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Bean
or
Contextual
is passivation capable.
The key in the component passthrough attributes Map
for the localName of the element corresponding to the
component.
PasswordHash
is an interface for objects that can generate and verify password hashes.Past
annotations on the same element.PastOrPresent
annotations on the same element.WebTarget
instance by appending path to the URI of the current target instance.Path
-annotated method to the existing path.Optional
,
List
or Map
.ServerEndpoint
annotation.CharSequence
must match the specified regular expression.Pattern
annotations on the same element.FacesMessage
to be created if the conversion to
Number
fails.FacesMessage
to be created if the value returned from
RegexValidator.getPattern()
is null
or the empty String.Pbkdf2PasswordHash
implementation.FacesMessage
to be created if the conversion to
Number
fails.A convenience method to signal the Jakarta Server Faces implementation to perform navigation with the provided outcome.
EntityManagerFactory
in Java SE environments.EntityManager
and its
associated persistence context.PersistenceContext
annotations.PersistenceContext
.PersistenceException
exception
with null
as its detail message.PersistenceException
exception
with the specified detail message.PersistenceException
exception
with the specified detail message and cause.PersistenceException
exception
with the specified cause.PersistenceProviderResolver
instance.EntityManagerFactory
and its
associated persistence unit.EntityManagerFactory
.PersistenceUnit
annotations.EntityManagerFactory
will be JTA or
resource-local entity managers.PessimisticLockException
exception
with null
as its detail message.PessimisticLockException
exception
with the specified detail message.PessimisticLockException
exception
with the specified detail message and cause.PessimisticLockException
exception
with the specified cause.PessimisticLockException
exception
with the specified entity.PessimisticLockException
exception
with the specified detail message, cause, and entity.jakarta.persistence.lock.scope
property for pessimistic locking.FacesContext
.getPhaseId()
method of the FacesEvent
interface.
Return a PhaseId
representation of the arcument phase
.
PluralAttribute
represent
persistent collection-valued attributes.PluralJoin
interface defines functionality
that is common to joins to all collection types.
Pop the current UIComponent
from the FacesContext
attributes map so that the previous
UIComponent
, if any, becomes the current component.
Enable the correct handling of navigation when processing a return node.
Service providers that implement this service must be called by the Jakarta Server Faces runtime exactly once for each implementation, at startup, before any requests have been serviced.
Positive
constraints on the same element.PositiveOrZero
constraints on the same element.
When an instance of this event is passed to
SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener
implementation may assume that the source
of this event instance is a UIComponent
instance and
that either that instance or an ancestor of that instance was just added to the view.
Instantiate a new PostAddToViewEvent
that indicates the argument component
was just added
to the view.
Instantiate a new PostAddToViewEvent
that indicates the argument component
was just added
to the view.
PostConstruct
annotation is used on a method that
needs to be executed after dependency injection is done to perform
any initialization.PostConstruct
callback, if it exists, according to the semantics required by the Java
EE platform specification.This event must be published by the runtime after all configuration resources have been parsed and processed.
Constructs a new PostConstructApplicationEvent
for this application.
Constructs a new PostConstructApplicationEvent
for this application.
This class is provided to allow custom scopes to publish a "post construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext
was
just created.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext
was
just created.
This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is first created.
Instantiate a new PostConstructViewMapEvent
that indicates the argument root
was just
associated with its view map.
Instantiate a new PostConstructViewMapEvent
that indicates the argument root
was just
associated with its view map.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is
kept in the flash.
Instantiate a new PostKeepFlashValueEvent
that indicates the argument key
was just kept in
the flash.
Instantiate a new PostKeepFlashValueEvent
that indicates the argument key
was just kept in
the flash.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is
stored in the flash.
Instantiate a new PostPutFlashValueEvent
that indicates the argument key
was just put to
the flash.
Instantiate a new PostPutFlashValueEvent
that indicates the argument key
was just put to
the flash.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is the UIViewRoot
instance that has just been rendered.
Instantiate a new PostRenderViewEvent
that indicates the argument root
has just been
rendered.
Instantiate a new PostRenderViewEvent
that indicates the argument root
has just been
rendered.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is in a tree that has just had its state restored.
Instantiate a new PostRestoreStateEvent
that indicates the argument component
just had its
state restored.
Instantiate a new PostRestoreStateEvent
that indicates the argument component
just had its
state restored.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is the UIComponent
instance that is that has just been validated.
Constructor
Constructor
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
before the flash
is cleared.
Instantiate a new PreClearFlashEvent
that indicates the argument key
was just put to the
flash.
Instantiate a new PreClearFlashEvent
that indicates the argument key
was just put to the
flash.
PreDestroy
annotation is used on a method as a
callback notification to signal that the instance is in the
process of being removed by the container.PreDestroy
callback, if it exists, according to the semantics required by the Java EE
platform specification.
This event must be published by the runtime before the factories associated with this Application
are released.
Constructs a new PreDestroyApplicationEvent
for this application.
Constructs a new PreDestroyApplicationEvent
for this application.
This class is provided to allow custom scopes to publish a "pre construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext
is
about to end.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext
is
about to end.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when the
clear
method is called on the map returned from UIViewRoot.getViewMap()
.
Instantiate a new ViewMapDestroydEvent
that indicates the argument root
just had its
associated view map destroyed.
Instantiate a new ViewMapDestroydEvent
that indicates the argument root
just had its
associated view map destroyed.
This ExceptionHandlerFactory
instance produces Jakarta Server Faces 1.2 compatible ExceptionHandler
instances.
container request filter
to
indicate that such filter should be applied globally on all resources in the application before the actual resource
matching occurs.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is
removed from the flash.
Instantiate a new PreRemoveFlashValueEvent
that indicates the argument key
will be removed
from the flash.
Instantiate a new PreRemoveFlashValueEvent
that indicates the argument key
will be removed
from the flash.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is a UIComponent
instance that is about to be removed from the
view.
Instantiate a new BeforeRemoveFromView
that indicates the argument component
is about to be
removed from the view.
Instantiate a new BeforeRemoveFromView
that indicates the argument component
is about to be
removed from the view.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is the UIComponent
instance that is about to be rendered and that
it is safe to call UIComponent.getParent()
, UIComponent.getClientId()
, and other methods that depend upon
the component instance being in the view.
Instantiate a new PreRenderComponentEvent
that indicates the argument component
is about to
be rendered.
Instantiate a new PreRenderComponentEvent
that indicates the argument component
is about to
be rendered.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is the UIViewRoot
instance that is about to be rendered.
Instantiate a new PreRenderViewEvent
that indicates the argument root
is about to be
rendered.
Instantiate a new PreRenderViewEvent
that indicates the argument root
is about to be
rendered.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or
ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that the
source
of this event instance is the UIComponent
instance that is about to be validated.
Constructor
Constructor
PrimaryKeyJoinColumn
annotations.String
to the client, without a carriage return-line feed (CRLF) character at the end.boolean
value to the client, with no carriage return-line feed (CRLF) character at the end.long
value to the client, with no carriage return-line feed (CRLF) at the end.float
value to the client, with no carriage return-line feed (CRLF) at the end.double
value to the client, with no carriage return-line feed (CRLF) at the end.String
to the client, followed by a carriage return-line feed (CRLF).boolean
value to the client, followed by a carriage return-line feed (CRLF).long
value to the client, followed by a carriage return-line feed (CRLF).float
value to the client, followed by a carriage return-line feed (CRLF).double
value to the client, followed by a carriage return-line feed (CRLF).jakarta.annotation.Priority
class-level annotation value when used or applied by JAX-RS runtime.Priority
annotation can be applied to classes
or parameters to indicate in what order they should be used.IdentityStore
s.ActionEvent
occurs.MethodExpression
passed in
our constructor.FacesContext.renderResponse()
or FacesContext.responseComplete()
to be called.Bean
object.Bean
object.UIComponentBase.processDecodes(jakarta.faces.context.FacesContext)
processing to perform the following steps.UIComponent.processDecodes(jakarta.faces.context.FacesContext)
to ensure that the form is decoded before its children.The default implementation performs the following action.
If the argument event
is an instance of PostRestoreStateEvent
and
PartialViewContext.isPartialRequest()
returns true
, then loop over all component resources and
call ResourceHandler.markResourceRendered(FacesContext, String, String)
for each of them.
SystemEvent
subclass are true.ExceptionHandler.processEvent(jakarta.faces.event.SystemEvent)
on the wrapped
ExceptionHandler
object.SystemEvent
subclass are true.SystemEvent
subclass are true.(cause==null ? null : cause.toString())
(which typically contains the class and detail message of
cause
).jakarta.annotation.ManagedBean
, EJB session or message-driven bean, enabled bean, enabled interceptor or enabled
decorator.jakarta.annotation.ManagedBean
, EJB session or
message-driven bean, enabled bean, enabled interceptor or enabled decorator.
Broadcast this event instance to the specified FacesListener
, by whatever mechanism is appropriate.
Broadcast this event instance to the specified FacesListener
by calling the superclass's
processListener()
implementation.
FacesEvent
to the specified FacesListener
, by whatever mechanism is appropriate.FacesListener
, by whatever mechanism is appropriate.Bean
object.ObserverMethod
object.
Perform lifecycle processing on components during the indicated phaseId
.
PartialViewContext.processPartial(PhaseId)
on the wrapped
PartialViewContext
object.Bean
object.Bean
object.
The default implementation must call
UIComponentBase.processRestoreState(jakarta.faces.context.FacesContext, java.lang.Object)
from within a try
block.
Bean
object.BeforeBeanDiscovery.addAnnotatedType(AnnotatedType)
,
BeforeBeanDiscovery.addAnnotatedType(AnnotatedType, String)
or
AfterTypeDiscovery.addAnnotatedType(AnnotatedType, String)
AfterBeanDiscovery.addBean()
or AfterBeanDiscovery.addBean(Bean)
, before registering the
Bean
object.ObserverMethod
added through
AfterBeanDiscovery.addObserverMethod(ObserverMethod)
or AfterBeanDiscovery.addObserverMethod()
, before
registering the ObserverMethod
object.UIComponentBase.processUpdates(jakarta.faces.context.FacesContext)
processing to perform the following steps.UIComponent.processUpdates(jakarta.faces.context.FacesContext)
to ensure that the children of this UIForm
instance are only
processed if UIForm.isSubmitted()
returns true
.processUpdates
behavior inherited from UIComponentBase
, calls
updateModel()
.
Override the default UIComponentBase.processValidators(jakarta.faces.context.FacesContext)
processing to perform the following steps.
Override UIComponent.processValidators(jakarta.faces.context.FacesContext)
to ensure that the children of this UIForm
instance are
only processed if UIForm.isSubmitted()
returns true
.
processValidators
behavior
inherited from UIComponentBase
, calls validate()
if the immediate
property is false
(which is the default); if the component is invalid afterwards, calls FacesContext.renderResponse()
.
If UISelectOne.getGroup()
is set, and UIInput.getSubmittedValue()
is empty, and at least one other component having the
same group within a UIForm
parent has a non-empty UIInput.getSubmittedValue()
or returns
true
on UIInput.isLocalValueSet()
or returns false
on UIInput.isValid()
, then skip
validation for current component, else perform standard superclass processing by
super.processValidators(context)
.
Specialize superclass behavior to treat null
differently.
MethodExpression
passed in
our constructor.ValueChangeEvent
occurs.Producer
.ProducerConfigurator
can configure a Producer
.ProducerFactory
can create an Producer
for a given bean.MessageBodyWriter
can
produce.
The value of this constant is the name used for JNDI lookups for setting the current value to be returned by
Application.getProjectStage()
.
The value of this constant is the value of the param-name
for setting the current value to be returned
by Application.getProjectStage()
.
This class enables a feature similar to the RAILS_ENV
feature of the Ruby on Rails web framework.
ValueExpression
or MethodExpression
.PropertyNotFoundException
with no detail message.PropertyNotFoundException
with the provided detail message.PropertyNotFoundException
with the given root cause.PropertyNotFoundException
with the given detail message and root cause.PropertyNotFoundException
.ValueExpression
.PropertyNotWritableException
with no detail message.PropertyNotWritableException
with the provided detail message.PropertyNotWritableException
with the given root cause.PropertyNotWritableException
with the given detail message and root cause.ELResolver
.This exception is thrown by the runtime when a violation of the view protection mechanism is encountered.
T
.ServiceLoader.load(Class)
method.ServiceLoader.load(Class)
method, matching providerName
.AuthConfigFactory.PROVIDER_REGISTRATION_PERMISSION_NAME
) for use in
authorizing access to the update methods of the factory implementation class.Configuration
of type T
.
If FacesContext.isProcessingEvents()
is true
and there are one or more
listeners for events of the type represented by systemEventClass
, call those listeners, passing
source
as the source of the event.
This method functions exactly like Application.publishEvent(FacesContext,Class,Object)
, except the run-time must use the
argument sourceBaseType
to find the matching listener instead of using the Class
of the
source
argument.
The default behavior of this method is to call
Application.publishEvent(jakarta.faces.context.FacesContext, Class, Object)
on the wrapped
Application
object.
The default behavior of this method is to call
Application.publishEvent(jakarta.faces.context.FacesContext, Class, Class, Object)
on the wrapped
Application
object.
The CDI annotation @
Push
allows you to inject a PushContext
associated with a given
<f:websocket>
channel in any container managed artifact in WAR.
Push the current UIComponent
this
to the FacesContext
attribute map using the key
UIComponent.CURRENT_COMPONENT
saving the previous UIComponent
associated with UIComponent.CURRENT_COMPONENT
for a subsequent call to UIComponent.popComponentFromEL(jakarta.faces.context.FacesContext)
.
CDI interface to send a message object to the push socket channel as identified by @
Push
.
Enable the correct handling of navigation when processing a return node.
Return the previously stored value and store the specified key/value pair.
Store the specified mapKey
/value
in a Map
that is internal to the helper, and
return the previously stored value.
The default behavior of this method is to call Map.put(K, V)
on the wrapped Flash
object.
The default behavior of this method is to call Map.putAll(Map)
on the wrapped Flash
object.
ELContext
.Puts a value in the flash so that it can be accessed on this traversal of the lifecycle, rather than on the next traversal.
The default behavior of this method is to call Flash.putNow(String, Object)
on the wrapped Flash
object.
Return the previously stored value and store the specified key/value pair.
HttpSession.setAttribute(java.lang.String, java.lang.Object)
Qualifier
annotation.NamedQuery
or NamedNativeQuery
annotation.WebTarget
instance by configuring a query parameter on the URI of the current target instance.QueryTimeoutException
exception
with null
as its detail message.QueryTimeoutException
exception
with the specified detail message.QueryTimeoutException
exception
with the specified detail message and cause.QueryTimeoutException
exception
with the specified cause.QueryTimeoutException
exception
with the specified query.QueryTimeoutException
exception
with the specified detail message, cause, and query.queueEvent
and take the following action.UIComponentBase.queueEvent(jakarta.faces.event.FacesEvent)
processing to wrap any queued events in a wrapper so that we
can reset the current row index in broadcast()
.UIComponentBase.queueEvent(jakarta.faces.event.FacesEvent)
behavior to accumulate the queued events for later
broadcasting.Method
AnnotatedMethod
String
.MessageBodyReader
that supports mapping the message entity stream onto the requested type.MessageBodyReader
that supports mapping the message entity stream onto the requested type.MessageBodyReader
that supports mapping the message entity stream onto the requested type.MessageBodyReader
that supports mapping the message entity stream onto the requested type.MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream)
.ReaderInterceptor
to intercept calls to (@link
jakarta.ws.rs.ext.MessageBodyReader#readFrom}.InputStream
.Reception
mode for the observer to buildretry
field.responseComplete()
method to be called on the FacesContext
instance for the current request.ExternalContext.redirect(String)
on the wrapped
ExternalContext
object.Write a redirect operation.
Create a redirect within this navigation case.
3xx
status codes).
Construct a reference to a UIViewParameter
.
ELException
.getAuthContext
method.A Validator that checks against a Regular Expression (which is the pattern property).
feature
meta-provider) to be instantiated and used in the scope of this configurable context.feature
meta-provider) to be instantiated and used in the scope of this configurable context.feature
meta-provider) to be instantiated and used in the scope of this configurable context.feature
meta-provider) to be instantiated and used in the scope of this configurable context.feature
meta-provider) to be instantiated and used in the scope of this configurable context.feature
meta-provider) to be instantiated and used in the scope of this configurable context.feature
meta-provider) to be instantiated and used in the scope of this configurable context.feature
meta-provider) to be instantiated and used in the scope of this configurable context.SseEventSink
instance to this SseBroadcaster
.InboundSseEvent
consumer.InboundSseEvent
and Throwable
consumers.InboundSseEvent
and Throwable
consumers and onComplete callback.Servlet
or Filter
registered via one of the addServlet or
addFilter methods, respectively, on ServletContext
may be further configured.Contextual.destroy(Object, CreationalContext)
.FacesContext
instance.FacesContext.release()
on the wrapped FacesContext
object.PartialViewContext
instance.PartialViewContext.release()
on the wrapped
PartialViewContext
object.ConstraintValidatorFactory
that the instance is no longer
being used by the Jakarta Bean Validation provider.RememberMeCredential
represents a credential presented as a token,
for the explicit usage with the Jakarta Security provided remember me function.RememberMeIdentityStore
is a mechanism for validating a caller's
credentials and accessing a caller's identity attributes that's specifically
tailored for the "remember me" feature.Remove the key/value pair from the helper, returning the value previously stored under this key.
Remove a value from the inner data structure.
The default behavior of this method is to call Map.remove(Object)
on the wrapped Flash
object.
target
.ActionListener
(if any) from the set of listeners interested in being notified when
ActionEvent
s occur.ActionListener
(if any) from the set of listeners interested in being notified when
ActionEvent
s occur.
Remove the specified AjaxBehaviorListener
from the set of listeners registered to receive event notifications
from this AjaxBehavior
.
Remove the specified BehaviorListener
from the set of listeners registered to receive event notifications
from this Behavior
.
Remove argument component
, which is assumed to represent a resource instance, as a resource to this
view.
Remove argument component
, which is assumed to represent a resource instance, as a resource to this
view.
DataModelListener
from the set interested in notifications from this DataModel
.listener
from the list of ELContextListener
s.
The default behavior of this method is to call
Application.removeELContextListener(jakarta.el.ELContextListener)
on the wrapped Application
object.
FacesListener
from the set of listeners registered to receive event notifications from
this UIComponent
.FacesListener
from the set of listeners registered to receive event notifications from
this UIComponent
.toRemove
is in the list of PhaseListener
s for this instance, it must be removed.PhaseListener
instance that is no longer interested in being notified before and after
the processing for standard phases of the request processing lifecycle.
Remove the argument urlPattern
from the thread safe Set
of protected views for this
application, if present in the Set
.
ViewHandler.removeProtectedView(java.lang.String)
on the wrapped
ViewHandler
object.Validator
instance from the set associated with this component, if it was previously associated.HttpSession.removeAttribute(java.lang.String)
ValueChangeListener
(if any) from the set of listeners interested in being notified when
ValueChangeEvent
s occur.ValueChangeListener
(if any) from the set of listeners interested in being notified when
ValueChangeEvent
s occur.responseComplete()
method has been called on the FacesContext
instance associated with the
current request.Reserved ID value to indicate entire ViewRoot.
RenderKitFactory
class name.ViewHandler.calculateRenderKitId(jakarta.faces.context.FacesContext)
to derive a RenderKit ID.UIComponent
s into the output stream (or writer) associated with the response we are creating for a particular
request.If this renderer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Renderer
instances that, together, know how to render Jakarta Server Faces UIComponent
instances for a specific
client.RenderKit
instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
If this render kit has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
FacesContext.renderResponse()
on the wrapped
FacesContext
object.FacesContext
.ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)
on the wrapped
ViewHandler
object.
Render a view rooted at argumentview
.
target
with the specified value
.IllegalStateException
if called outside the
scope of a request (e.g.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
Object>
causes the map returned from ExternalContext.getRequestCookieMap()
to
be injected as the value of that field.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
Object>
causes the map returned from ExternalContext.getRequestMap()
to be
injected as the value of that field.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String>
causes the map returned from ExternalContext.getRequestParameterMap()
to be injected as the value of that field.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String []>
causes the map returned from
ExternalContext.getRequestParameterValuesMap()
to be injected as the value of that field.
jakarta.enterprise.context.RequestScoped
, which is a CDI build-in scope
with similar semantics.RequestScoped
annotation.FacesMessage
to be created if a required check fails.A Validator that checks for an empty value in the same way that UIInput checks for a value.
If the request parameter named by the value of this constant has a parameter value of true
, the
implementation must return true
from PartialViewContext.isResetValues()
.
Convenience method to reset this component's value to the un-initialized state.
Convenience method to reset this component's value to the un-initialized state.
Visit the clientIds and, if the component is an instance of EditableValueHolder
, call its
EditableValueHolder.resetValue()
method.
FeatureDescriptor
that specifies whether the variable
or property can be resolved at runtime.
Try to resolve one or multiple UIComponent
s based on the keyword and calls
SearchKeywordContext.invokeContextCallback(jakarta.faces.component.UIComponent)
for each resolved component.
Resolves to a single clientId or passthrough expression for the given expression.
Resolves to a List
with clientIds or passthrough expressions for the given expressions.
Resolves a single UIComponent
s for the given expression.
Resolves multiple UIComponent
s for the given expression(s).
BeanManager
was injected or the Java EE
component from whose JNDI environment namespace the BeanManager
was obtained.java.lang.Method
.BeanManager
was
injected or the Java EE component from whose JNDI environment namespace the BeanManager
was obtained.WebTarget
instance by resolving a URI template with a given name
in the URI of the
current target instance using a supplied value.WebTarget
instance by resolving a URI template with a given name
in the URI of the
current target instance using a supplied value.name
in this UriBuilder
instance using a supplied value.name
in this UriBuilder
instance using a supplied value.WebTarget
instance by resolving a URI template with a given name
in the URI of the
current target instance using a supplied encoded value.name
in this UriBuilder
instance using a supplied encoded value.WebTarget
instance by resolving one or more URI templates in the URI of the current target
instance using supplied name-value pairs.WebTarget
instance by resolving one or more URI templates in the URI of the current target
instance using supplied name-value pairs.UriBuilder
instance using supplied name-value pairs.UriBuilder
instance using supplied name-value pairs.WebTarget
instance by resolving one or more URI templates in the URI of the current target
instance using supplied name-encoded value pairs.UriBuilder
instance using supplied name-value pairs.
Returns the URL
of a Facelet template file.
null
.Resource
annotation marks a resource that is needed
by the application.
An instance of
Resource
is a Java object representation of the artifact that is served up in response to a resource
request from the client.
This file must be located in META-INF/contracts/<contractName>/
in a jar file that contains a
resource library contract, where <contractName>
is the name of the contract.
The default value for the ResourceHandler.RESOURCE_EXCLUDES_PARAM_NAME
init param.
The ServletContext
init parameter consulted by the ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)
to tell which kinds of
resources must never be served up in response to a resource request.
Resource.getRequestPath()
returns the value of this constant as the prefix of the URI.
ResourceBundle
.
Container annotation to specify multiple ResourceDependency
annotations on a single class.
Instances of UIComponent
or Renderer
that have this
annotation (or ResourceDependencies
attached at the class level will automatically have a resource dependency
added so that the named resource will be present in user agent's view of the UIViewRoot
in which this
component or renderer is used.
ResourceHandler is the
run-time API by which UIComponent
and Renderer
instances, and the ViewDeclarationLanguage
can reference
Resource
instances. An implementation of this class must be thread-safe.
Provides a simple
implementation of ResourceHandler
that can be subclassed by developers wishing to provide specialized
behavior to an existing ResourceHandler
instance.
If this resource handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Defines the resource traversal options.
If this resource has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Response.ResponseBuilder
instance and obtain a
Response from that.Response
to obtain an instance.FacesContext.responseComplete()
on the wrapped
FacesContext
object.Flushes the buffered response content to the client.
ExternalContext.responseFlushBuffer()
on
the wrapped ExternalContext
object.response
with the
specified cause and a detail message of (cause==null ? null : cause.toString())
(which typically contains the
class and detail message of cause
).Resets the current response.
ExternalContext.responseReset()
on the wrapped
ExternalContext
object.Sends an HTTP status code with message.
ExternalContext.responseSendError(int,String)
on the wrapped
ExternalContext
object.StateManager
that knows the specific rendering technology being used to generate
the response.ResponseWriter
that can be subclassed by developers wishing to provide specialized behavior to an existing
ResponseWriter
instance.If this response writer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
UIComponent
subclasses that need to restore the objects they saved using
UIComponentBase.saveAttachedState(jakarta.faces.context.FacesContext, java.lang.Object)
.StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)
on the wrapped StateManager
object.
Both MethodExpression
instances described in the constructor must be restored.
Both MethodExpression
instances described in the constructor must be restored.
Restore the "transient state" using the object passed as state.
For components that need to support the concept of transient state, this method will restore any state saved on a
prior call to UIComponent.saveTransientState(jakarta.faces.context.FacesContext)
.
null
.StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String)
on the wrapped
StateManager
object.StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)
on the wrapped
StateManager
object.FacesContext
and viewId
.ViewHandler.restoreView(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.Restore the state of the view with information in the request.
Restore a UIViewRoot
from a previously created view.
Restore ViewScope state.
DataModel
that wraps a JSTL
Result
object, typically representing the results of executing an SQL query via JSTL tags.ResultDataModel
with no specified wrapped data.ResultDataModel
wrapping the specified Result
.DataModel
that wraps a
ResultSet
of Java objects.ResultSetDataModel
with no specified wrapped data.ResultSetDataModel
wrapping the specified ResultSet
.
Assuming the component metadata for argument
topLevelComponent
has been made available by an earlier call to
ViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource)
, leverage the component metadata for the purpose of re-targeting
attached objects from the top level composite component to the individual AttachedObjectTarget
instances
inside the composite component.
Assuming the component metadata for argument topLevelComponent
has been made available by an earlier
call to ViewDeclarationLanguage.getComponentMetadata(jakarta.faces.context.FacesContext, jakarta.faces.application.Resource)
, leverage the component metadata for the purpose of
re-targeting any method expressions from the top level component to the appropriate inner component.
Create a return node in the current Flow
.
Define a return node.
Represents a return node in the flow graph.
EntityTransaction.commit()
fails.RollbackException
exception
with null
as its detail message.RollbackException
exception
with the specified detail message.RollbackException
exception
with the specified detail message and cause.RollbackException
exception
with the specified cause.RuntimeDelegate
class.T
.CompletionStage
.RxInvoker
subclass provider.RxInvoker
provider.
This method is called by UIComponent
subclasses that want to save one or more attached objects.
StateManager.saveView(jakarta.faces.context.FacesContext)
. The default implementation calls saveView
and
inspects the return. If the return is an Object []
, it casts the result to an Object []
wrapping the first and second elements in an instance of StateManager.SerializedView
, which it then returns. Otherwise, it
returns null
StateManager.saveSerializedView(jakarta.faces.context.FacesContext)
on the wrapped StateManager
object.
Implementation of StateHolder.saveState(jakarta.faces.context.FacesContext)
.
Serializable
Object.
Both MethodExpression
instances described in the constructor must be saved.
Both MethodExpression
instances described in the constructor must be saved.
Return the object containing related "transient states".
For components that need to support the concept of transient state, this method will save any state that is known to be transient in nature.
StateManager.saveView(jakarta.faces.context.FacesContext)
on
the wrapped StateManager
object.
Return the state of the current view in an Object
that
implements Serializable
and can be passed to
java.io.ObjectOutputStream.writeObject()
without causing a java.io.NotSerializableException
to be thrown. The default implementation must perform the following algorithm or its semantic equivalent,
explicitly performing all the steps listed here.
Content-Length
.Request-Line
is not allowed for
the resource identified by the Request-URI
.Request-URI
is longer than the server is willing to interpret.Location
field.DataModel
that wraps an individual Java
object.ScalarDataModel
with no specified wrapped data.ScalarDataModel
wrapping the specified scalar object.ScheduledExecutorService
.URI
).
A structure that contains the name of the scope and the scope itself exposed as a Map<String,
Object>
.
Construct this structure with the supplied arguments.
The property name for the SearchExpressionContext
class name.
A context object that is used to hold state relating to resolve a search expression.
Provide for separation of interface and implementation for the SearchExpressionContext
contract.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Provides a simple implementation of SearchExpressionHandler
that can be subclassed by developers wishing to
provide specialized behavior to an existing SearchExpressionHandler
instance.
If this search expression handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
An enum that specifies hints that impact the behavior of a component tree search.
SearchKeywordContext provides context information that may be useful to
SearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String)
implementations.
Construct a new context with the given arguments.
A SearchKeywordResolver is responsible for resolving a single keyword.
Event
for the given additional required qualifiers.Event
for the given required type and additional required qualifiers.Event
for the given required type and additional required qualifiers.Instance
for the given additional required qualifiers.Instance
for the given required type and additional required qualifiers.Instance
for the given required type and additional required qualifiers.Selection
interface defines an item that is to be
returned in a query result.UISelectMany
or UISelectOne
component.SelectItem
with no initialized property values.SelectItem
with the specified value.SelectItem
with the specified value and label.SelectItem
instance with the specified value, label and description.SelectItem
instance with the specified property values.SelectItem
instance with the specified property values.SelectItem
instance with the specified property values.SelectItem
that identifies a set of options that will be
made available as a subordinate "submenu" or "options list", depending upon the requirements of the
UISelectMany
or UISelectOne
renderer that is actually used.SelectItemGroup
with no initialized property values.SelectItemGroup
with the specified label and no associated selectItem
s.SelectItemGroup
with the specified properties.@
Push
.@
Push
, targeted to the
given user as identified by <f:websocket user>
.@
Push
, targeted to the
given users as identified by <f:websocket user>
.The context-param that allows the separator char for clientId strings to be set on a per-web application basis.
GeneratedValue
annotation.SequenceGenerator
annotations.JsonGenerator
instance.JsonGenerator
instance.If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the jakarta.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable.
String
representation of Server sent events media type.ServerEndpointConfig.Builder
objects for
the purposes of deploying a server endpoint.5xx
status codes).Process an incoming request, and create the corresponding response according to the following specification.
service
method and dispatches them to the
do
XXX methods defined in this class.service
method.cannot be served
.readLine
method for reading data one line at a time.Servlet
may be further configured.Servlet
registered via one of the addServlet methods on
ServletContext
may be further configured.ServletSecurity
annotation value.HttpConstraintElement
value as the default Constraint element
and with no HTTP Method specific constraint elements.HttpConstraintElement
value as the default Constraint element
and with a collection of HTTP Method specific constraint elements.ServletSecurity
annotation value.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
Object>
causes the map returned from ExternalContext.getSessionMap()
to be
injected as the value of that field.
jakarta.enterprise.context.SessionScoped
, which is a CDI build-in scope
with similar semantics.SessionScoped
annotation.JsonString
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonNumber
at the specified position.JsonValue.TRUE
or JsonValue.FALSE
value
at the specified position.JsonObject
from an object builder at the specified position.JsonArray
from an array builder at the specified position.accept
property.acceptcharset
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.accesskey
property.ActionSource2.setActionExpression(jakarta.el.MethodExpression)
.UICommand.setActionExpression(jakarta.el.MethodExpression)
.MethodExpression
pointing at the appication action to be invoked, if this UIComponent
is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property.MethodExpression
pointing at the appication action to be invoked, if this UIComponent
is
activated by the user, during the Apply Request Values or Invoke Application phase of the request
processing lifecycle, depending on the value of the immediate
property.ActionListener
to be registered for all ActionSource
components.
The default behavior of this method is to call
Application.setActionListener(jakarta.faces.event.ActionListener)
on the wrapped Application
object.
ActionSource.addActionListener(jakarta.faces.event.ActionListener)
.UICommand.addActionListener(jakarta.faces.event.ActionListener)
.alt
property.alt
property.alt
property.alt
property.alt
property.alt
property.AnnotatedType
.Application
instance that will be returned for this web application.Support method which is backed by the current VariableMapper.
SetAttribute
represent
persistent java.util.Set
-valued attributes.autocomplete
property.autocomplete
property.autocomplete
property.autorun
property.BeanAttributes
.bgcolor
property.bgcolor
property.ValueExpression
that references a backing bean property of
the Converter
instance to be created.ValueExpression
that references a backing bean property of
the Validator
instance to be created.bodyContent
for this tag handler.bodyrows
property.bodyrows
property.border
property.border
property.border
property.border
property.
This must be called by the runtime at startup time, before any requests are serviced, and allows for the
FaceletCache
implementation to provide the FaceletCache.MemberFactory
instances that will be used to create
instances of Facelets and View Metadata Facelets.
captionClass
property.captionClass
property.captionStyle
property.captionStyle
property.CDIProvider
to use.cellpadding
property.cellpadding
property.cellspacing
property.cellspacing
property.charset
property.charset
property.charset
property.ClassLoader
.
Associate this instance with a ClientWindow
.
The default behavior of this method is to call ExternalContext.setClientWindow(jakarta.faces.lifecycle.ClientWindow)
on the wrapped
ExternalContext
object.
cols
property.columnClasses
property.columnClasses
property.columns
property.Set the MIME content-type for this resource.
The default behavior of this method is to call Resource.setContentType(String)
on the wrapped
ResourceHandler
object.
Converter
(if any) that is registered for this UIComponent
.Converter
instance to be created.ValueExpression
set for the "converterMessage" with the literal argument provided to this
method.coords
property.coords
property.coords
property.getAsString()
with a type
of currency
.getAsString()
with a type
of currency
.FacesContext
instance for the request that is being processed by the current thread.The implementation must call this method at the earliest possble point in time after entering into a new phase in the request processing lifecycle.
FacesContext.setCurrentPhaseId(PhaseId)
on the wrapped
FacesContext
object.Locale
for this application.
The default behavior of this method is to call Application.setDefaultLocale(java.util.Locale)
on the wrapped
Application
object.
renderKitId
to be used to render this application.
The default behavior of this method is to call Application.setDefaultRenderKitId(String)
on the wrapped
Application
object.
If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded.
dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.dir
property.disable
property of the UIParameter
.Set whether or not the client window should be encoded into the target url.
Sets the disabled status of this behavior.
disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.true
.disabledClass
property.disabledClass
property.disabledClass
property.disabledClass
property.disabledClass
property.disabledClass
property.enabledClass
property.enabledClass
property.enabledClass
property.enabledClass
property.enabledClass
property.enabledClass
property.enctype
property.errorClass
property.errorClass
property.errorStyle
property.errorStyle
property.escape
property.escape
property.escape
property.Set the value of the escape property.
Set the ExceptionHandler
for this request.
FacesContext.setExceptionHandler(ExceptionHandler)
on the
wrapped FacesContext
object.
Sets the component identifiers that will be used to identify components that should be processed during the
execute
phase of the request processing lifecycle.
execute
property.factoryName/implName
mapping in such a way that FactoryFinder.getFactory(java.lang.String)
will find this mapping when searching for a match.AuthConfigFactory.SET_FACTORY_PERMISSION_NAME
, that is used to authorize access to the
setFactory method.fatalClass
property.fatalClass
property.fatalStyle
property.fatalStyle
property.
Set the FlowHandler
instance used by the NavigationHandler
to satisfy the requirements of the faces
flows feature.
footerClass
property.footerClass
property.footerClass
property.for
property.fragment
property.frame
property.frame
property.Set the FunctionMapper to use in EL evaluation/creation.
group
property.Sets the name of the radio button group.
getAsString()
should include grouping separators if necessary.headerClass
property.headerClass
property.headerClass
property.height
property.hreflang
property.hreflang
property.hreflang
property.UIComponent
(if any).image
property.image
property.UIComponent
.Sets the immediate status of this behavior.
UIComponent
.Set whether or not the page parameters should be encoded into the target url.
info
object made available to timer callbacks.infoClass
property.infoClass
property.infoStyle
property.infoStyle
property.InjectionTarget
which performs injection for this target.true
if only the integer portion of the given value should be returned from
getAsObject()
.Updates the status as to whether or not this component is currently within the view hierarchy.
Overridden to take no action.
ismap
property.SetJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.Set
.JspContext
for this invocation.JspIdConsumer
.
Setter for keepMessages
JavaBeans property.
The default behavior of this method is to call Flash.setKeepMessages(boolean)
on the wrapped Flash
object.
Sets if the keyword was resolved.
label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.label
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.lang
property.layout
property.layout
property.layout
property.layout
property.Set the libraryName for this resource.
The default behavior of this method is to call Resource.setLibraryName(String)
on the wrapped
ResourceHandler
object.
loadOnStartup
priority on the Servlet represented by this dynamic ServletRegistration.Locale
for this instance.Locale
to be used in localizing the response being created for this view.Locale
to be used when parsing or formatting dates and times.Locale
to be used when parsing numbers.longdesc
property.getAsString()
should render in the fraction portion of the result.Validator
.Validator
.Validator
.getAsString()
should render in the integer portion of the result.maxlength
property.maxlength
property.maxlength
property.ResourceBundle
to be used for Jakarta Server Faces messages
for this application.
The default behavior of this method is to call Application.setMessageBundle(String)
on the wrapped
Application
object.
getAsString()
should render in the fraction portion of the result.Validator
.Validator
.Validator
.getAsString()
should render in the integer portion of the result.MultipartConfigElement
to be applied to the mappings defined for this
ServletRegistration
.name
property.Set the request parameter name from which the value is retrieved.
NavigationHandler
instance that will be passed the outcome returned by any invoked application action
for this web application.
The default behavior of this method is to call Application.setNavigationHandler(NavigationHandler)
on the
wrapped Application
object.
Set the value of the noSelectionOption
property.
Set the value of the noSelectionOption
property.
JsonValue.NULL
value at the specified position.ObserverMethod
.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error.
onerror
property.Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity.
onevent
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onload
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.Controls whether or not this component operates on postback.
onreset
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onsubmit
property.onunload
property.
Sets the outcome
property of the UIOutcomeTarget
.
PageContext
of the page containing this tag instance.Parameter
object.java.util.Calendar
to a Parameter
object.java.util.Date
to a Parameter
object.java.util.Calendar
to a named parameter.java.util.Date
to a named parameter.java.util.Calendar
to a positional
parameter.java.util.Date
to a positional parameter.Parameter
object.java.util.Calendar
to a Parameter
object.java.util.Date
to a Parameter
object.java.util.Calendar
to a named parameter.java.util.Date
to a named parameter.java.util.Calendar
to a positional
parameter.java.util.Date
to a positional parameter.Parameter
object.java.util.Calendar
to a Parameter
object.java.util.Date
to a Parameter
object.java.util.Calendar
to a named parameter.java.util.Date
to a named parameter.java.util.Calendar
to a positional
parameter.java.util.Date
to a positional parameter.
Set the parent UIComponent
of this
UIComponent
.
Tag
that is the parent of this instance.Dynamically indicate that this is a partial request.
The default behavior of this method is to call PartialViewContext.setPartialRequest(boolean)
on the wrapped
PartialViewContext
object.
Attempt to set the lifecycle phase in which this instance will queue its ActionEvent
.
PhaseId
during which this event will be delivered.
Allows control of wheter or not the runtime will publish events when
Application.publishEvent(FacesContext, Class, Object)
or
Application.publishEvent(FacesContext, Class, Class, Object)
is called.
FacesContext.setProcessingEvents(boolean)
on the wrapped
FacesContext
object.Producer
object that will be used by the container to call the producer
method or read the producer field.ELResolver
has successfully resolved a given (base, property) pair.ELResolver
has successfully resolved a given (base, property) pair and to
notify the EvaluationListener
s.<el-resolver>
element at the right place in the application configuration resources which will be
considered in the normal course of expression evaluation. This method now will cause the argument
resolver
to be wrapped inside an implementation of ELResolver
and exposed to the Jakarta
Expression Language resolution system as if the user had called Application.addELResolver(jakarta.el.ELResolver)
.public
property.ServletInputStream
to invoke the provided ReadListener
when it is possible to readreadonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.
Setting this property to true
indicates that the next request on this session will be a redirect.
The default behavior of this method is to call Flash.setRedirect(boolean)
on the wrapped Flash
object.
redisplay
property.detail
property of the associated message(s) should be displayed.detail
property of the associated message(s) should be displayed.rel
property.rel
property.rel
property.
Sets the component identifiers that will be used to identify components that should be processed during the
render
phase of the request processing lifecycle.
render
property.
Indicate the entire view must be rendered if renderAll
is true
.
PartialViewContext.setRenderAll(boolean)
on the wrapped
PartialViewContext
object.rendered
property of this UIComponent
.
Sets the if
property of this component.
RenderKit
associated with this view.ExternalContext.getRequest()
.ExternalContext.setRequest(Object)
on the wrapped
ExternalContext
object.ExternalContext.setRequestCharacterEncoding(String)
on the
wrapped ExternalContext
object.ValueExpression
set for the "requiredMessage" with the literal argument provided to this method.Set the resetValues status of this behavior.
resetValues
property.
Set the ResourceHandler
instance that will be utilized for rendering the markup for resources, and for
satisfying client requests to serve up resources.
The default behavior of this method is to call
Application.setResourceHandler(ResourceHandler)
on the wrapped Application
object.
Set the resource library contracts calculated as valid to use with this view.
FacesContext.setResourceLibraryContracts(java.util.List<java.lang.String>)
on the wrapped
FacesContext
object.Set the resourceName for this resource.
The default behavior of this method is to call Resource.setResourceName(String)
on the wrapped
ResourceHandler
object.
ExternalContext.getResponse()
.ExternalContext.setResponse(Object)
on the wrapped
ExternalContext
object.Set the buffer size for the current response.
ExternalContext.setResponseBufferSize(int)
on the wrapped
ExternalContext
object.ExternalContext.getResponseCharacterEncoding()
on the wrapped
ExternalContext
object.Set the content length of the response.
ExternalContext.setResponseContentLength(int)
on the wrapped ExternalContext
object.Sets the content type of the response being sent to the client, if the response has not been committed yet.
ExternalContext.setResponseContentType(String)
on the wrapped
ExternalContext
object.Set the response header with the given name and value.
ExternalContext.setResponseHeader(String,String)
on the
wrapped ExternalContext
object.Sets the HTTP status code for the response.
ExternalContext.setResponseStatus(int)
on the wrapped
ExternalContext
object.ResponseStream
to which components should direct their binary output.FacesContext.setResponseStream(ResponseStream)
on the wrapped
FacesContext
object.ResponseWriter
to which components should direct their character-based output.FacesContext.setResponseWriter(ResponseWriter)
on the wrapped
FacesContext
object.rev
property.rev
property.rev
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.rootElement
property.rowClass
property.rowClass
property.rowClasses
property.rowClasses
property.rowHeader
property.rows
property.
If this property is set to true
, the UIData
must take steps to ensure that modifications to
its iterated children will be preserved on a per-row basis.
rules
property.rules
property.runAs
role for this ServletRegistration
.
Set the SearchExpressionHandler
instance used by the application.
selectedClass
property.null
to indicate that there are no currently selected values.SelectItem
s for this group.ServletSecurityElement
to be applied to the mappings defined for this
ServletRegistration
.Specifies the time, in seconds, between client requests before the Jakarta Servlet container will invalidate this session.
The default behavior of this method is to call ExternalContext.setSessionMaxInactiveInterval(int)
on the
wrapped ExternalContext
object.
shape
property.shape
property.shape
property.detail
property of the associated message(s) should be displayed.detail
property of the associated message(s) should be displayed.summary
property of the associated message(s) should be displayed.summary
property of the associated message(s) should be displayed.size
property.size
property.size
property.size
property.size
property.StateManager
instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call
Application.setStateManager(StateManager)
on the wrapped Application
object.
setStatus(int)
, to send an error with a description use sendError(int, String)
.
Sets the status code and message for this response.HttpServletResponseWrapper.setStatus(int)
, to send an error with a description use HttpServletResponseWrapper.sendError(int, String)
style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.UIForm
instance (as opposed to other
forms in the page) is experiencing a submit during this request processing lifecycle, this method must be called,
with true
as the argument, during the UIComponent.decode(jakarta.faces.context.FacesContext)
for this UIForm
instance.UIInput
component.summary
property.summary
property.Locale
instances representing the supported Locale
s for this application.
The default behavior of this method is to call Application.setSupportedLocales(java.util.Collection)
on the
wrapped Application
object.
system
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.Set a reference to the Tag for which this class represents the attributes.
Set a reference to the Tag for which this class represents the attributes.
target
property.target
property.target
property.target
property.TimeZone
used to interpret a time value.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.tooltip
property.tooltip
property.HttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>)
on the wrapped response
object.
Implementation of StateHolder.setTransient(boolean)
.
type
property.type
property.type
property.type
property.unselectedClass
property.ViewHandler.renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot)
is now responsible for setting up the response
writer. This method is now a no-op.UIGraphic
.usemap
property.A comma-separated list of validation groups which are used to filter which validations get checked by this validator.
EditableValueHolder.addValidator(jakarta.faces.validator.Validator)
instead, obtaining the argument Validator
by creating an instance of
MethodExpressionValidator
.UIInput.addValidator(jakarta.faces.validator.Validator)
instead, obtaining the argument Validator
by creating an instance of
MethodExpressionValidator
.Validator
instance to be created.ValueExpression
set for the "validatorMessage" with the literal argument provided to this
method.null
, attempts to set the value of the given property on this bean.property
object on the given base
object.property
object on the given base
object.property
argument.PropertyNotWritableException
.value
property of the UICommand
.UIData
.value
property of the UIGraphic
.value
property of the\ UIParameter
.value
property of the UISelectItem
.value
property of the UISelectItems
.UIComponent
(if any).ValueBinding
, relative to the specified
FacesContext
.null
, and the property matches the name of a JSP implicit object, throws
PropertyNotWritableException
to indicate that implicit objects cannot be overwritten.null
, sets an existing scoped attribute to the new value, or creates a new
scoped attribute if one does not exist by this name.UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression)
.UIComponent.setValueExpression(java.lang.String, jakarta.el.ValueExpression)
.UIData.setValueExpression(java.lang.String, jakarta.el.ValueExpression)
.UIGraphic.setValueExpression(java.lang.String, jakarta.el.ValueExpression)
.UISelectBoolean.setValueExpression(java.lang.String, jakarta.el.ValueExpression)
.UISelectMany.setValueExpression(java.lang.String, jakarta.el.ValueExpression)
.EditableValueHolder.addValueChangeListener(jakarta.faces.event.ValueChangeListener)
instead, obtaining the argument ValueChangeListener
by
creating an instance of MethodExpressionValueChangeListener
.UIInput.addValueChangeListener(jakarta.faces.event.ValueChangeListener)
instead, obtaining the argument ValueChangeListener
by
creating an instance of MethodExpressionValueChangeListener
.
Sets the ValueExpression
used to calculate the value for the specified property name.
ValueExpression
used to calculate the value for the specified attribute or property name, if any.ValueExpression
used to calculate the value for the specified attribute or property name, if any.ValueExpression
specified for url
under value
instead; otherwise, perform
the default superclass processing for this method.ValueExpression
used to calculate the value for the specified attribute or property name, if any.ValueExpression
specified for selected
under value
instead; otherwise,
perform the default superclass processing for this method.ValueExpression
specified for selectedValues
under value
instead;
otherwise, perform the default superclass processing for this method.ValueExpression
used to calculate the value for the specified attribute or property name, if any.Set the VariableMapper to use in EL evaluation/creation.
<el-resolver>
element at the
right place in the application configuration resources which will be considered in the normal course of expression
evaluation. This method now will cause the argument resolver
to be wrapped inside an implementation of
ELResolver
and exposed to the Jakarta Expression Language resolution system as if the user had called
Application.addELResolver(jakarta.el.ELResolver)
.ViewHandler
instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call
Application.setViewHandler(ViewHandler)
on the wrapped Application
object.
FacesContext.setViewRoot(UIViewRoot)
on the wrapped
FacesContext
object.warnClass
property.warnClass
property.warnStyle
property.warnStyle
property.width
property.width
property.width
property.DataModel
.DataModel
.ServletOutputStream
to invoke the provided WriteListener
when it is possible to
writexmlns
property.xmlns
property.FacesMessage
to be created if the conversion to
Short
fails.Converter
implementation for java.lang.Short
(and short primitive) values.Singleton
annotation.SingularAttribute
represents persistent
single-valued properties or fields.
The default behavior of this method is to call Map.size()
on the wrapped Flash
object.
Size
annotations on the same element.END_ARRAY
.END_OBJECT
.Specializes
annotation.
Splits an string, based on SearchExpressionHandler.getExpressionSeperatorChars(jakarta.faces.context.FacesContext)
with possible
multiple expressions into an array.
SqlResultSetMapping
annotations.OutboundSseEvent
and SseBroadcaster
.incoming Server-Sent Events
.SseEventSource
builder class.web targets
created by the client instance that is using this SSL context.AsyncContext
with the original (unwrapped)
ServletRequest and ServletResponse objects.AsyncContext
with the given request and
response objects.ServletRequest.startAsync()
on the wrapped request object.ServletRequest.startAsync(ServletRequest, ServletResponse)
on the wrapped request object.
Open an XML CDATA
block.
The default behavior of this method is to call ResponseWriter.startCDATA()
on the wrapped
ResponseWriter
object.
Write the start of a partial response.
ResponseWriter.startDocument()
on the wrapped
ResponseWriter
object.ResponseWriter.startElement(String, jakarta.faces.component.UIComponent)
on the wrapped
ResponseWriter
object.Write the start of an error.
Write the start of an eval operation.
Write the start of an extension operation.
Write the start of an insert operation where the contents will be inserted after the specified target node.
Write the start of an insert operation where the contents will be inserted before the specified target node.
Write the start of an update operation.
STATE_SAVING_METHOD_PARAM_NAME
that
indicates state saving should take place on the client.ServletContext
init parameter consulted by the StateManager
to tell where the state
should be saved.STATE_SAVING_METHOD_PARAM_NAME
that
indicates state saving should take place on the server.
Define a Map
-like contract that makes it easier for components to implement PartialStateHolder
.
Encapsulate the saving and restoring of the view to enable the VDL to take over the responsibility for handling this feature.
Serializable
in the 1.0 version of the spec. It was also not a
static inner class, so it can't be made to be Serializable
. Therefore, it is being deprecated in version
1.2 of the spec. The replacement is to use an implementation dependent Object
.StateManager
that can be
subclassed by developers wishing to provide specialized behavior to an existing StateManager
instance.If this state manager has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ELResolver
for resolving static fields, enum constants and static methods.StaticMetamodel
annotation specifies that the class
is a metamodel class that represents the entity, mapped
superclass, or embeddable class designated by the value
element.Response
when the application
wishes to stream the output.FacesMessage
to be created if the conversion of the
BigDecimal
value to String
fails.FacesMessage
to be created if the conversion of the
BigInteger
value to String
fails.FacesMessage
to be created if the conversion of the
Boolean
value to String
fails.FacesMessage
to be created if the conversion of the
Byte
value to String
fails.FacesMessage
to be created if the conversion of the
Character
value to String
fails.FacesMessage
to be created if the conversion of the
DateTime
value to String
fails.FacesMessage
to be created if the conversion of the
Double
value to String
fails.FacesMessage
to be created if the conversion of the
Float
value to String
fails.FacesMessage
to be created if the conversion of the
Integer
value to String
fails.FacesMessage
to be created if the conversion of the
Long
value to String
fails.FacesMessage
to be created if the conversion of the
Number
value to String
fails.FacesMessage
to be created if the conversion of the
Short
value to String
fails.InvocationCallback
to process the future
result of the invocation.Subquery
interface defines functionality that is
specific to subqueries.
Install the listener instance referenced by argument listener
into the application as a listener for events of type systemEventClass
that originate from objects of
type sourceClass
.
Install the listener instance referenced by argument listener
into application as a listener for events of type systemEventClass
.
The default behavior of this method is to call
Application.subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
The default behavior of this method is to call
Application.subscribeToEvent(Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
This implementation throws UnsupportedOperationException
and is provided for the sole purpose of not
breaking existing applications that extend this class.
Install the listener instance referenced by argument componentListener
as a listener for events of type
eventClass
originating from this specific instance of UIComponent
.
Install the listener instance referenced by argument listener
into the UIViewRoot
as a
listener for events of type systemEventClass
.
ConstraintValidator
can validate.AsyncResponse
into a parameter of an invoked JAX-RS resource
or sub-resource method
.
Create a switch node in the current Flow
.
Create a switch case in the current switch.
Create a new case in the current switch.
Represents a case within a switch node in the flow graph.
Create a case in the current switch.
Define a particular list of cases that will be inspected in the order they are defined to determine where to go next in the flow graph.
Represents a switch node in the flow graph.
EntityManager.joinTransaction()
method.
Pass the argument source
to the superclass constructor.
Pass the argument source
to the superclass constructor.
By implementing this class, an object indicates that it is a listener for one or more kinds of SystemEvent
s.
Classes that implement this interface agree to maintain a list of SystemEventListener
instances for each kind
of SystemEvent
they can generate.
GeneratedValue
annotation.TableGenerator
annotations.The runtime must create an instance of this class for each element in the Facelets XHTML view.
A reference to the Tag
instance corresponding to this TagHandler
instance.
The property name for the TagHandlerDelegate
class name.
Representation of an XML attribute name=value pair on an XML element in a Facelet file.
An Exception caused by a TagAttribute
A set of TagAttributes, usually representing all attributes on a Tag.
Passed to the constructor of TagHandler
subclass, it defines the document definition of the handler we are
instantiating.
TagHandler
.
An Exception caused by a Tag
Wrap the argument tag
so the exception can reference its information.
Wrap the argument tag
so the exception can reference its information.
Wrap the argument tag
so the exception can reference its information.
Wrap the argument tag
so the exception can reference its information.
Foundation class for FaceletHandler
s associated with a
markup element in a Facelet document.
Every TagHandler
instance is associated with a Tag
.
Abstract class that defines methods relating to helping tag handler instances.
Abstract factory for creating instances of
TagHandlerDelegate
.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
See TagConfig.getTagId()
.
<taglib>
related configuration of a web application.event source builder
that provides convenient way how to configure and
fine-tune various aspects of a newly prepared event source instance.java.util.Date
and
java.util.Calendar
.java.util.Date
or java.util.Calendar
.String
constant representing "text/html" media type.MediaType
constant representing "text/html" media type.String
constant representing "text/plain" media type.MediaType
constant representing "text/plain" media type.String
constant representing "text/xml" media type.MediaType
constant representing "text/xml" media type.An interface that allows other code to identify FaceletHandlers that may provide text (String) content.
FacesMessage
to be created if the conversion to
Time
fails.TimedObject
interface contains a callback method that is used to deliver timer expiration
notifications.Timer
interface contains information about a timer that was created through the enterprise bean
Timer Service.title
on this link.
The presence of this component attribute on an ActionSource
component will cause the
default ActionListener
to interpret the value of the attribute as the toFlowDocumentId value to pass
to
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String, java.lang.String)
.
Components that are rendered by Renderers
of component-family jakarta.faces.OutcomeTarget
must use this constant as the parameter name for a parameter representing the defining document id of the flow that
this component will cause to be entered.
Cookie
with the same name, value, path, domain and version as this
NewCookie
.Response.Status
.Set the to-flow-document-id of the current navigation case.
object
to a String
instance as JSON.object
to a String
instance as JSON.JsonPatch
as JsonArray
.java.util.stream.Collector
that accumulates the input JsonValue
elements into a JsonArray
.java.util.stream.Collector
that accumulates the input Map.Entry<String,JsonValue>
elements into a JsonObject
.java.util.stream.Collector
that accumulates the input JsonValue
elements into a JsonObject
.JsonMergePatch
as JsonValue
.Response
.ResultSet
object to a Result
object.maxRows
of a ResultSet
object to a Result
object.FacesMessage.Severity
instance.
Call through to Resource.getRequestPath()
and return the result.
PhaseId
instance.Set the to-view-id of the current navigation case.
TransactionAttribute
annotation specifies whether the container is to invoke a business method
within a transaction context.TransactionAttributeType
is used with the TransactionAttribute
annotation to
specify whether the methods of a session bean or message driven bean are called with a valid transaction context.TransactionManagementType
is used with the TransactionManagement
annotation to
specify whether container-managed or bean-managed transaction management is used.TransactionPhase
for the observer to buildTransactionRequiredException
exception with
null
as its detail message.TransactionRequiredException
exception with
the specified detail message.@TransientReference
resolves to a dependent scoped bean, then the bean will be
destroyed after the invocation completes.TransientReference
annotation.
Define a Map
-like contract that makes it easier for components to implement
TransientStateHolder
.
This interface is implemented by classes that need to save state that is expected to be available only within the scope of the current request.
Perform a transition in the flow graph for the current user's ClientWindow
.
Validator
.TupleElement
interface defines an element that is returned in
a query result tuple.FeatureDescriptor
that specifies the runtime type of
the variable or property.Type
(that will be used during typesafe resolution)
of the InjectionPoint to build.Type
represent persistent object
or attribute types.type
on this link.FacesMessage
to be created if the current value of
this component is not of the correct type.FacesMessage
to be created if the current value of
this component is not of the correct type.Typed
annotation.UIComponent
that represents a single column of data within a parent
UIData
component.UIColumn
instance with default property values.UIComponent
that represents a user interface component which, when activated
by the user, triggers an application specific "command" or "action".UICommand
instance with default property values.UIComponent
.BodyTag
. This class has been replaced by
UIComponentELTag
.UIComponentTagBase
is the base class for all Jakarta Server Pages tags that use the
"classic" Jakarta Server Pages tag interface that correspond to a UIComponent
instance in the view.UIComponentELTag
specializes its superclass to allow for properties that take their values from Jakarta
Expression Language expressions.UIComponentELTag
, which extends
UIComponentClassicTagBase
to add properties that use the Jakarta Expression Language API introduced as
part of Jakarta Server Pages 2.1.UIComponentTagBase
is the base class for all Jakarta Server Pages tags that correspond
to a UIComponent
instance in the view.UIComponent
that supports data binding to a collection of data objects represented by a DataModel
instance, which is the current value of this component itself (typically established via a ValueExpression
).UIData
instance with default property values.UIComponent
that represents an input form to be
presented to the user, and whose child components represent (among other things) the input fields to be included when
the form is submitted.UIForm
instance with default property values.UIComponent
that displays a graphical image to the user.UIGraphic
instance with default property values.UIImportConstants
instance with renderer type set to null
.UIComponent
that represents a component that both
displays output to the user (like UIOutput
components do) and processes request parameters on the subsequent
request that need to be decoded.UIInput
instance with default property values.UIComponent
, identified by a clientId
or component id
relative to the closest ancestor NamingContainer
.UIMessage
instance with default property values.FacesContext
and
displaying them to the user.UIMessages
instance with default property values.NamingContainer
functionality.UINamingContainer
instance with default property values.
This component is paired with the jakarta.faces.Button
or
jakarta.faces.Link
renderers and encapsulates properties relating to the rendering of outcomes directly
to the response.
UIOutcomeTarget
instance with default property values.UIComponent
that has a
value, optionally retrieved from a model tier bean via a value expression, that is displayed to the user.UIOutput
instance with default property values.UIComponent
that manages the layout of its child components.UIPanel
instance with default property values.UIComponent
that represents an optionally named configuration parameter for
a parent component.UIParameter
instance with default property values.UISelectBoolean
instance with default property values.UISelectMany
or UISelectOne
component, and causes the addition of a
SelectItem
instance to the list of available options for the parent component.UISelectItem
instance with default property values.UISelectMany
or UISelectOne
component, and causes the addition of one or more SelectItem
instances to the list of available options in
the parent component.UISelectItems
instance with default property values.UIComponent
that
represents the user's choice of a zero or more items from among a discrete set of available options.UISelectMany
instance with default property values.UIComponent
that represents the user's choice
of zero or one items from among a discrete set of available options.UISelectOne
instance with default property values.UIViewAction represents a method invocation that occurs during the request processing lifecycle, usually in response to an initial request, as opposed to a postback.
UIViewAction
instance with default property values.
UIViewParameter represents a binding between a
request parameter and a model property or UIViewRoot
property.
UIViewParameter
instance with default property values.
Inner class to encapsulate a UIViewParameter
instance so that it may be safely referenced regardless of
whether or not the current view is the same as the view in which this UIViewParameter
resides.
UIViewRoot
instance with default property values.
The <f:websocket>
tag opens an one-way (server to client) websocket based push connection in
client side which can be reached from server side via PushContext
interface injected in any CDI/container
managed artifact via @
Push
annotation.
UIWebsocket
instance with default property values.UnavailableException.UnavailableException(String)
instead.UnavailableException.UnavailableException(String, int)
instead.createUniqueId()
method.
UniqueIdVendor is an interface implemented by UIComponents
that also implement
NamingContainer
so that they can provide unique ids based on their own clientId.
Link.JaxbLink
into a Link
.
Remove the listener instance referenced by argument listener
from the application as a listener for events of type systemEventClass
that originate from objects of
type sourceClass
.
Remove the listener instance referenced by argument listener
from the application as a listener for events of type systemEventClass
.
The default behavior of this method is to call
Application.unsubscribeFromEvent(Class, Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
The default behavior of this method is to call
Application.unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener)
on the wrapped
Application
object.
This implementation throws UnsupportedOperationException
and is provided for the sole purpose of not
breaking existing applications that extend this class.
Remove the listener instance referenced by argument componentListener
as a listener for events of type
eventClass
originating from this specific instance of UIComponent
.
Remove the listener instance referenced by argument listener
from the UIViewRoot
as a
listener for events of type systemEventClass
.
@child(n)
, @next
and @previous
.ValueExtractor
definition so that it is applied automatically when
detecting constraints declared on the container type supported by the extractor, causing
the constraints to be applied to the container's elements instead of the container.payload()
of a constraint to indicate if a value
should be unwrapped before validation.ValueExtractor
by the
UnwrapByDefault
annotation.FacesMessage
to be created if a model update error
occurs, and the thrown exception has no message.Write an attribute update operation.
UIInput
, if any, as appropriate.
Call through to superclass UIInput.updateModel(jakarta.faces.context.FacesContext)
then take the additional action of pushing the value into
request scope if and only if the value is not a value expression, is valid, and the local value was set on this
lifecycle execution.
This exception indicates a failure to update the model and is created to wrap any exception that occurs during
UIInput.updateModel(jakarta.faces.context.FacesContext)
.
Store the argument facesMessage
so it may be returned from UpdateModelException.getFacesMessage()
and pass the
argument cause
to the super constructor.
HttpUpgradeHandler
for a given class and uses it for the http protocol upgrade
processing.HttpUpgradeHandler
for a given class and uses it for the http protocol upgrade
processing.uriTemplate
string and copies the parsed components of the supplied URI to the UriBuilder
replacing any existing values for those components.fromXxx(...)
methods to obtain an instance.UriBuilder.build(Object...)
methods when a URI
cannot be
constructed based on the current state of the builder.UriBuilderException
without detail message.UriBuilderException
with the specified detail message.UriBuilderException
with the specified detail message and cause.cause==null ? null : cause.toString()
) (which typically contains the class and detail message of
cause).
Return true
if the user-agent requesting this resource needs
an update.
The default behavior of this method is to call Resource.userAgentNeedsUpdate(jakarta.faces.context.FacesContext)
on the wrapped
ResourceHandler
object.
Validator
compliant this new context.UIInput
.Verify that the value is valid according to the Bean Validation constraints.
Credential
and return the identity and attributes
of the caller it represents.object
.The name of a context parameter that indicates how empty values should be handled with respect to validation.
object
named propertyName
.UIInput
, ensure that any specified values are equal to one of the available options.UIInput
, ensure that any specified value is equal to one of the available options.propertyName
of the class beanType
would the property value be value
.The delimiter that is used to separate the list of fully-qualified group names as strings.
Sets a flag which indicates that a conversion or validation error occurred while processing the inputs.
FacesContext.validationFailed()
on the
wrapped FacesContext
object.ConstraintValidator
.IdentityStore
should be used for.EditableValueHolder
.The name of the Jakarta Servlet context attribute which holds the object used by Jakarta Server Faces to obtain Validator instances.
The standard validator id for this validator, as defined by the Jakarta Server Face specification.
Used in creating ValidatorHandler
and all implementations.
Validator
instances.Validator
instance on the EditableValueHolder
associated with our most immediate surrounding
instance of a tag whose implementation class is a subclass of UIComponentTag
.validate()
method of a Validator
to indicate that validation failed.Allow this one exception to contain multiple messages.
Allow this one exception to contain multiple messages, while passing on the root cause to the superclass
Validator
instances.
Handles setting a Validator
instance on an
EditableValueHolder
parent.
Construct this instance around the configuration information in argument config
ValidatorELTag
. The remainder of the functionality, namely,
the binding facility and the implementation of the ValidatorTag.createValidator()
method, is now an implementation detail.ValueExpression
.
A ValueChangeEvent
is a notification that the local value of the source component has been change as a result
of user interface activity.
Construct a new event object from the specified source component, old value, and new value.
Construct a new event object from the Faces context, specified source component, old value and new value.
ValueChangeEvent
s.Expression
that can get or set a value.T
.ValueExtractor
.ValueExtractor
is illegal, e.g.ValueExtractor
definition is illegal, e.g.UIComponent
that wishes to support a local value, as well as access data in the model tier via a value
expression, and support conversion between String and the model tier data's native data type.
A VDL handler that exposes Converter
to a page author.
A marker interface for VDL tags that represent <composite:valueHolder/>
for use by the
composite component page author.
MediaType
by parsing the supplied string.List
of valid FacesMessage.Severity
instances, in ascending
order of their ordinal value.
The default behavior of this method is to call Map.values()
on the wrapped Flash
object.
PhaseId
instances, in ascending order of their ordinal value.Map
of valid FacesMessage.Severity
instances, keyed by name.ELResolver
when operating with a null
base
argument.ELResolver
newInstance
method to obtain an instance.Vetoed
annotation.
The property name for the ViewDeclarationLanguage
class name.
The value of this constant is used as the key in the component attributes Map
for the
Location
in the view at which this component instance resides.
The key in the value set of the view metadata BeanDescriptor, the value of which is a
List<
.UIViewParameter.Reference
>
Reserved ID value to indicate serialized ViewState.
Create a view node in the current Flow
.
The contract that a view declaration language must implement to interact with the Jakarta Server Faces runtime.
ViewDeclarationLanguageFactory is a factory object
that creates (if needed) and returns a new ViewDeclarationLanguage
instance based on the VDL found in a
specific view.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Provides a simple implementation of ViewDeclarationLanguage
that
can be subclassed by developers wishing to provide specialized behavior to an existing
ViewDeclarationLanguage
instance.
If this view declaration language has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Tests whether a physical resource corresponding to the specified viewId exists.
FacesException
when attempting to restore the view
StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)
results in failure on postback.
Provides a simple implementation of ViewHandler
that can be
subclassed by developers wishing to provide specialized behavior to an existing ViewHandler
instance.
If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
Object>
causes the map returned from UIViewRoot.getViewMap()
to be injected
as the value of that field.
Marker interface for SystemEvent
s that indicate the view map has been created
(PostConstructViewMapEvent
, or destroyed (PreDestroyViewMapEvent
).
ViewMetadata
is reponsible for extracting and providing view parameter metadata from VDL views.
Define a view node in a flow graph.
ViewNode is the class that represents a VDL view in a faces flow graph.
Superclass of Resource
that is only for use with views.
If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true,
exceptions thrown by PhaseListener
s installed on the UIViewRoot
are queued to the
ExceptionHandler
instead of being logged and swallowed.
jakarta.faces.view.ViewScoped
. The functionality of this corresponding
annotation is identical to this one, but it is implemented as a CDI custom scope.
When this annotation, along with jakarta.inject.Named
is found on a class, the runtime must place the bean in a CDI scope such that it remains active
as long as NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
does not cause a navigation to a view
with a viewId that is different than the viewId of the current view.
Defines the view traversal options.
VisitContext.invokeVisitCallback()
to visit the specified component.
The property name for the VisitContextFactory
class name.
A simple callback interface that enables taking action on a specific UIComponent (either facet or child) during a component tree visit.
A context object that is used to hold state relating to performing a component tree visit.
Provide for separation of interface and implementation for the
VisitContext
contract.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Provides a simple implementation of VisitContext
that can be
subclassed by developers wishing to provide specialized behavior to an existing VisitContext
instance.
If this visit context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
An enum that specifies hints that impact the behavior of a component tree visit.
An enum that specifies the possible results of a call to VisitCallback.visit(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.UIComponent)
.
Perform a tree visit starting at this node in the tree.
Override the behavior in UIComponent.visitTree(jakarta.faces.component.visit.VisitContext, jakarta.faces.component.visit.VisitCallback)
to handle
iteration correctly.
cancel
method on the client Future
object corresponding
to the currently executing asynchronous business method.
If a <context-param>
with the param name equal to the value of
ResourceHandler.WEBAPP_CONTRACTS_DIRECTORY_PARAM_NAME
exists, the runtime must interpret its value as a path, relative to
the web app root, where resource library contracts are to be located.
If a <context-param>
with the param name equal to the value of
ResourceHandler.WEBAPP_RESOURCES_DIRECTORY_PARAM_NAME
exists, the runtime must interpret its value as a path, relative to
the web app root, where resources are to be located.
This web socket event will be fired when a new <f:websocket>
has been
@
WebsocketEvent.Opened
or @
WebsocketEvent.Closed
.
Indicates that a <f:websocket>
has closed.
Indicates that a <f:websocket>
has opened.
String
constant representing wildcard "*/*" media type .WithAnnotations
may be applied to any portable extension observer method with an event parameter type of
ProcessAnnotatedType
to filter the events delivered.MediaType
instance with the same type, subtype and parameters copied from the original instance
and the supplied "charset" parameter.Jsonb
instance.ExpressionFactory
that delegates MethodExpression
and
ValueExpression
creation to the given ExpressionFactory
.Writer.write(char[], int, int)
on the wrapped
ResponseWriter
object.JsonValue
to the output source.array
to the output
source.ResponseWriter.writeAttribute(String, Object, String)
on the
wrapped ResponseWriter
object.ResponseWriter.writeComment(Object)
on the wrapped
ResponseWriter
object.Write a string containing the markup specific doctype.
ResponseWriter.writeDoctype(java.lang.String)
on the wrapped
ResponseWriter
object.object
to the output
source.Write a string containing the markup specific preamble.
ResponseWriter.writePreamble(java.lang.String)
on the wrapped
ResponseWriter
object.MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)
.Object
instance, in an implementation dependent
manner.StateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object)
. The default implementation calls the
non-deprecated variant of the method passing an Object []
as the second argument, where the first
element of the array is the return from getStructure()
and the second is the return from
getState()
on the argument state
.StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
on the wrapped
StateManager
object.StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)
on the wrapped StateManager
object.StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
, or noting where state information should later be written.ViewHandler.writeState(jakarta.faces.context.FacesContext)
on
the wrapped ViewHandler
object.state
and write it into the output using the
current ResponseWriter
, which must be correctly positioned already.ResponseStateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object)
. The default implementation creates a two
element Object
array with the first element being the return from calling
StateManager.SerializedView.getStructure()
, and the second being the return from StateManager.SerializedView.getState()
. It then
passes this Object
array to ResponseStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
.ResponseWriter.writeText(Object, String)
on the wrapped
ResponseWriter
object.ResponseWriter.writeText(Object, UIComponent, String)
on the
wrapped ResponseWriter
object.ResponseWriter.writeText(char[], int, int)
on the wrapped
ResponseWriter
object.ResponseWriter.writeURIAttribute(String, Object, String)
on
the wrapped ResponseWriter
object.Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.