null
as its detail message.AbstractClearableCredential
contains behavior common to
Credential
implementations that can be meaningfully
cleared.Marshaller
implementation.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.Unmarshaller
implementation.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.Action
annotation allows explicit association of a
WS-Addressing Action
message addressing property with
input
, output
, and
fault
messages of the mapped WSDL operation.
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
"action
" property.
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.
ActivationSpec
.java.awt.datatransfer.DataFlavor
class.
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.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 invocationAttachmentPart
object to this SOAPMessage
object.SOAPElement
object.SOAPElement
object.SyntheticBeanBuilder
that allows configuring a new synthetic bean
of given beanClass
.ProcessBean
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
.
SOAPBody
object and sets it as the
SOAPBody
object for this SOAPEnvelope
object.SOAPBodyElement
object with the specified
name and adds it to this SOAPBody
object.SOAPBodyElement
object with the specified
QName and adds it to this SOAPBody
object.index
.index
.SOAPElement
object initialized with the
given Name
object and adds the new element to this
SOAPElement
object.SOAPElement
object initialized with the given
QName
object and adds the new element to this SOAPElement
object.SOAPElement
object initialized with the
specified local name and adds the new element to this
SOAPElement
object.SOAPElement
object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement
object.SOAPElement
object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement
object.SOAPElement
as a child of this
SOAPElement
instance.
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.scopeAnnotation
and given contextClass
.scopeAnnotation
and given contextClass
.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.
Detail
object and sets it as the
Detail
object for this SOAPFault
object.DetailEntry
object with the given
name and adds it to this Detail
object.DetailEntry
object with the given
QName and adds it to this Detail
object.Document
to this SOAPBody
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.3.2 "ELResolver" of the Jakarta Faces Specification Document.
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
.SOAPFault
object and adds it to
this SOAPBody
object.SOAPFault
object and adds it to
this SOAPBody
object.SOAPFault
object and adds it to this
SOAPBody
object.SOAPFault
object and adds it to this
SOAPBody
object.SOAPFault
object and adds it to this SOAPBody
object.locale
.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.
MimeHeader
object with the specified name and value
to this MimeHeaders
object's list of headers.SOAPHeader
object and sets it as the
SOAPHeader
object for this SOAPEnvelope
object.SOAPHeaderElement
object initialized with the
specified name and adds it to this SOAPHeader
object.SOAPHeaderElement
object initialized with the
specified qname and adds it to this SOAPHeader
object.annotation
as an interceptor binding annotation.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.AttachmentPart
object.MimeHeader
object with the specified
name and value and adds it to this SOAPPart
object.data
for optimized binary storage as an attachment.data
for optimized binary storage as an attachment.createNamedQuery
or
createNamedStoredProcedureQuery
method.SOAPElement
object.SOAPHeaderElement
object initialized
with the specified name and adds it to this SOAPHeader
object.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.SyntheticObserverBuilder
that allows configuring a new synthetic observer
for given eventType
.SyntheticObserverBuilder
that allows configuring a new synthetic observer
for given eventType
.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.annotation
as a qualifier annotation.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.Address
.address
to the
W3CEndpointReference
instance's
wsa:Address
.AddressingFeature
with the
use of addressing requirements.AddressingFeature
with the
use of addressing requirements.AddressingFeature
with the
use of addressing requirements.AddressingFeature
with the
use of addressing requirements.
Add another MetaRule
to this ruleset, returning this
.
Cause the argument resolver
to be added to the head of the resolver chain.
annotation
as a stereotype annotation.data
as an attachment and return attachment's content-id, cid.Text
object initialized with the given
String
and adds it to this SOAPElement
object.PersistenceUnitInfo.getClassLoader()
method.SOAPHeaderElement
object initialized
with the specified List of supported SOAP URIs and adds it to this
SOAPHeader
object.SOAPHeaderElement
object initialized
with the specified array of supported SOAP URIs and adds it to this
SOAPHeader
object.SOAPHeaderElement
object initialized
with the specified supported SOAP URI and adds it to this
SOAPHeader
object.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
.AdministeredObjectDefinition
annotations.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.source
to XML.target
.
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.
MimeMultipart.initializeProperties()
method called from
constructors and the parse method.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.

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.
Supports inline instantiation of the ApplicationMap
qualifier.
Path
.ApplicationScoped
annotation.ApplicationServerInternalException
is thrown
by an application
server to indicate error conditions specific to an application server.
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
.
f:metadata
tag.Take the action prescribed in the Jakarta 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.List
of AnnotationMember
s.boolean
.byte
.char
.double
.float
.int
.long
.AnnotationInfo
.AssertFalse
annotations on the same element.AssertTrue
annotations on the same element.short
.ManagedConnection
instance.String
.Type
.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.AsyncHandler
interface is implemented by
clients that wish to receive callback notification of the completion of
service endpoint operations invoked asynchronously.CompletableFuture
instance that the Jakarta EE Product Provider supplies to the caller
of the asynchronous method.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.
SOAPMessage
object.
Create or restore the ClientWindow
to be used to display the UIViewRoot
for
this run through the lifecycle.
W3CEndpointReference
instance's
wsa:EndpointReference
element.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.Authenticator
.(cause==null ? null : cause.toString())
(which typically contains the class and detail message of
cause
).receive
or when the message listener the session
has called to process the message successfully returns.receive
or when the message listener the session has called
to process the message successfully returns.jakarta.servlet.http.registerSession
and auto applies this for every request.
The ServletContext
init parameter consulted by the runtime to tell if the automatic mapping of the
FacesServlet
to the extensionless variant (without *.xhtml
) should be enabled.
bad client request
.URI
for the application.UriBuilder
that includes the application root path.BasicAuthenticationCredential
extends UsernamePasswordCredential
to represent credentials used by HTTP Basic Authentication.BasicType
represent basic types (including
temporal and enumerated types).JobOperator
API methods to its callers.bean
that declares this observer method.BeanAttributes
instance.Bean
instance.BeanContainer
is a superclass of BeanManager
containing capabilities that are portable across
all CDI environments.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.source
to XML.target
.ThreadContextRestorer
instance.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
.Binding
interface is the base interface
for Jakarta XML Web Services protocol bindings.BindingProvider
interface provides access to the
protocol binding and associated context objects for request and
response message processing.BindingType
annotation is used to
specify the binding to use for a web service
endpoint implementation class.BodyPart
.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.
AnnotationInfo
that includes all annotation members defined by previous method calls
on this builder.Jsonb
based on the
parameters and configuration specified previously in this builder.Cookie
instance using all the configuration previously specified in this builder.NewCookie
instance using all the configuration previously specified in this builder.OutboundSseEvent
.web target
.W3CEndpointReference
from the accumulated
properties set on this W3CEndpointReferenceBuilder
instance.ServiceLoader
.ValidatorFactory
instance based on the
default Jakarta Bean Validation provider and following the XML configuration.BuildCompatibleExtension
implementations.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.BytesMessage
object is used to send a message containing a stream of uninterpreted bytes.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.ClaimsDefinition
annotation defines claims mapping in openid connect
client configuration.PersistenceUnitInfo.addTransformer
method.
The default behavior of this method is to call Map.clear()
on the wrapped Flash
object.
AttachmentPart
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.
JMSProducer
acknowledge
method.acknowledge
method.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.
ClientWindow
.
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.Instance.Handle.destroy()
.Writer.close()
on the wrapped ResponseWriter
object.JMSConsumer
.QueueBrowser
.QueueRequestor
and its session.TopicRequestor
and its session.ValidatorFactory
instance.SseEventSink
instances.SseEventSink
instance and release all associated resources.SOAPConnection
object.XmlAdapter
to handle xs:token
and its derived types.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.TransactionInProgressRuntimeException
, since it should not be called for an XAJMSContext
object.TransactionInProgressException
, since it should not be called for an XASession
object.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.ComparisonTerm
.CompletableFuture
instance that the Jakarta EE Product Provider supplies to the caller of the
asynchronous method.CompletableFuture
that is already completed with the specified value.CompletionStage
that is already completed with the specified value.CompletionListener
is implemented by the application and may be specified when a message is sent
asynchronously.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 <IP_ADDRESS> "faces.CompositeComponentAttributesELResolver" of the Jakarta Faces Specification Document,
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 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.Connection
object is a client's active connection to its Jakarta Messaging provider.ConnectionAdapter
.asynchronous
response
lifecycle events.Connection
objects provide a special facility for creating a
ConnectionConsumer
(optional).ConnectionEventListener
interface provides an event
callback mechanism to enable an application server to receive
notifications from a ManagedConnection
instance.ConnectionFactory
object encapsulates a set of connection configuration parameters that has been defined by
an administrator.ConnectionFactory
provides an interface for getting
connection to an EIS instance.ConnectionFactoryDefinition
annotations.ConnectionMetaData
object provides information describing the Connection
object.ConnectionMetaData
provides information
about an EIS instance connected through a Connection instance.Connector
annotation is a component-defining annotation and
it can be used by the resource adapter developer to specify that the JavaBean
is a resource adapter JavaBean.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.MethodConfig
objects for each constructor of this class,
as defined by ClassInfo.constructors
.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
.fileName(fileName).content(content)
.contentStream
is another such stream representing
the content of this body part.contentStream
is another such stream representing
the content of this message.WorkContext
instance.WorkContext
instance.ELContext
has been created.java.lang.reflect.Proxy
).ContextService
to be registered in JNDI by the container
under the JNDI name that is specified in the
ContextServiceDefinition.name()
attribute.ContextServiceDefinition
annotations on the same type.WorkContext
instance was successfully set
as the execution context for the Work
instance.WorkContext
instance was set as the
execution context for the Work
instance it was associated
with.Callable
with context
that is captured from the thread that invokes
contextualCallable
.BiConsumer
with context
that is captured from the thread that invokes
contextualConsumer
.Consumer
with context
that is captured from the thread that invokes
contextualConsumer
.BiFunction
with context
that is captured from the thread that invokes
contextualFunction
.BiFunction
with context
that is captured from the thread that invokes
contextualFunction
.Runnable
with context
that is captured from the thread that invokes
contextualRunnable
.Supplier
with context captured from the thread that invokes
contextualSupplier
.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
.
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.
from
to group to
during cascading.ConvertGroup
annotations
on the same element.Convert
annotations.Cookie.Builder
instead.Cookie.Builder
instead.Cookie.Builder
instead.Cookie.AbstractCookieBuilder
instance.Cookie
builder class.Cookie
builder class.CompletableFuture
that is completed by the completion of the
specified stage.CompletionStage
that is completed by the completion of the
specified stage.AnnotationBuilder
for given annotation type.AnnotationBuilder
for given annotation type.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.Service
instance.Service
instance.Service
instance.Service
instance.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
.AttachmentPart
object.AttachmentPart
object and populates it using
the given DataHandler
object.AttachmentPart
object and populates it with
the specified data of the specified content type.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
.
Binder
object that can be used for
associative/in-place unmarshalling/marshalling.Binder
for W3C DOM.QueueBrowser
object to peek at the messages on the specified queue.QueueBrowser
object to peek at the messages on the specified queue using a message selector.QueueBrowser
object to peek at the messages on the specified queue.QueueBrowser
object to peek at the messages on the specified queue using a message selector.QueueBrowser
object to peek at the messages on the specified queue.QueueBrowser
object to peek at the messages on the specified queue using a message selector.JsonArrayBuilder
and JsonObjectBuilder
objects.JsonArrayBuilder
and JsonObjectBuilder
objects.BytesMessage
object.BytesMessage
object.Creates a ClientBehaviorContext instance.
UIComponent
instance of the class
specified by a previous call to addComponent()
for the specified component type.
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.
Create and return a TagHandlerDelegate
instance designed for use with ComponentHandler
.
SeBootstrap.Configuration.Builder
.SOAPConnection
.JMSConsumer
for the specified destination.JMSConsumer
for the specified destination, using a message selector.JMSConsumer
for the specified destination, specifying a message selector and the noLocal
parameter.MessageConsumer
for the specified destination.MessageConsumer
for the specified destination, using a message selector.MessageConsumer
for the specified destination, specifying a message selector and the
noLocal
parameter.EntityManagerFactory
is to be created.JMSContext
with the specified session mode using the same connection as this JMSContext
and creating a new session.JAXBContext
class.JAXBContext
class.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.
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.Detail
object which serves as a container
for DetailEntry
objects.JsonStructure
.JsonStructure
.Dispatch
instance for use with objects of
the client's choosing.Dispatch
instance for use with objects of
the client's choosing.Dispatch
instance for use with objects of
the client's choosing.Dispatch
instance for use with Jakarta XML Binding
generated objects.Dispatch
instance for use with Jakarta XML Binding
generated objects.Dispatch
instance for use with Jakarta XML Binding
generated objects.Dispatch
instance for use with objects of
the user's choosing.Dispatch
instance for use with objects of
the user's choosing.Dispatch
instance for use with objects of
the user's choosing.Dispatch
instance for use with Jakarta XML Binding
generated objects.Dispatch
instance for use with Jakarta XML Binding
generated objects.Dispatch
instance for use with Jakarta XML Binding
generated objects.noLocal
parameter, and creates a consumer on that durable subscription.noLocal
parameter, and creates a consumer on that durable subscription.noLocal
parameter, and creates a consumer on that durable subscription.noLocal
parameter, and creates a consumer on that durable subscription.SOAPElement
object from an existing DOM
Element
.SOAPElement
object initialized with the
given Name
object.SOAPElement
object initialized with the
given QName
object.SOAPElement
object initialized with the
given local name.SOAPElement
object with the given
local name, prefix and uri.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.EntityPart.Builder
.SOAPFault
object initialized with the given reasonText
and faultCode
SOAPFault
object
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
.Instance
object to access to beans instances.InterceptionFactory
for the given CreationalContext
and type.JAXBIntrospector
object that can be used to
introspect Jakarta XML Binding objects.Link.Builder
.AsyncListener
class.MapMessage
object.MapMessage
object.Marshaller
object that can be used to convert a
java content tree into XML data.JsonValue
s
which when applied to the source
, yields the target
.JsonValue
s
which when applied to the source
, yields the target
.JsonValue
.JsonValue
.Message
object.Message
object.SOAPMessage
object with the default
SOAPPart
, SOAPEnvelope
, SOAPBody
,
and SOAPHeader
objects.InputStream
object into a
new SOAPMessage
object and returns the SOAPMessage
object.
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.
MethodExpression
for later evaluation.Name
object initialized with the
given local name, namespace prefix, and namespace URI.Name
object initialized with the
given local name and namespace prefix.Name
object initialized with the
given local name.Name
object initialized with the
given local name, namespace prefix, and namespace URI.Name
object initialized with the
given local name.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
.ObjectMessage
object.ObjectMessage
object.ObjectMessage
object.ObjectMessage
object.Result
object.JsonParser
objects.JsonParser
instances.jsonPointer
string.jsonPointer
string.JMSProducer
object which can be used to configure and send messagesMessageProducer
to send messages to the specified destination.QName
whose namespace URI is the one associated
with the parameter, prefix
, in the context of this
SOAPElement
.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.Queue
object which encapsulates a specified provider-specific queue name.Queue
name.Queue
object which encapsulates a specified provider-specific queue name.QueueSession
object, specifying transacted
and acknowledgeMode
.QueueSession
object.JsonReader
objects.JsonReader
objects.QueueReceiver
object to receive messages from the specified queue.QueueReceiver
object to receive messages from the specified queue using a message selector.
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
.
QueueSender
object to send messages to the specified queue.Session
object, specifying transacted
and acknowledgeMode
.Session
object, specifying sessionMode
.Session
object, specifying no arguments.Session
object.noLocal
parameter, and creates a consumer on that durable subscription.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.StreamMessage
object.StreamMessage
object.TemporaryQueue
object.TemporaryQueue
object.TemporaryQueue
object.TemporaryTopic
object.TemporaryTopic
object.TemporaryTopic
object.TextMessage
object.TextMessage
object.TextMessage
object.TextMessage
object.java.util.Timer
instance.Topic
object which encapsulates a specified provider-specific topic name.Topic
object which encapsulates a specified provider-specific topic name.Topic
name.TopicSession
object, specifying transacted
and acknowledgeMode
.TopicSession
object.CriteriaQuery
object that returns a tuple of
objects as its result.Generate an identifier for a component.
Result
object.Unmarshaller
object that can be used to convert XML
data into a java content tree.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.
Create and return a TagHandlerDelegate
instance designed for use with ValidatorHandler
.
ValueExpression
for later evaluation.Variant.VariantListBuilder
.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()
.W3CEndpointReference
.W3CEndpointReference
.JsonWriter
objects.JsonWriter
objects.XAConnection
with the default user identity.XAConnection
with the specified user identity.XAJMSContext
with the default user identityXAQueueSession
object.XASession
object.XATopicSession
object.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.Trigger
implementation, which supports 5 or 6 fields
delimited by a single space character, plus a ZoneId
.FacesMessage
to be created if the conversion to
Number
fails.Executor
that runs tasks on the same thread from which
execute
is invoked but with context that is captured from the thread
that invokes currentContextExecutor
.IdentityStore
that
stores caller credentials and identity attributes in a relational database,
and make that implementation available as an enabled CDI bean.DataContentHandlers
.DataHandler
instance referencing the
specified DataSource.DataHandler
instance representing an object
of this MIME type.DataHandler
instance referencing a URL.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.PERSISTENT
.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 Faces implementation.Locale
.Locale
.SeBootstrap.Configuration.PORT
property indicating that the implementation MUST use its default port.ViewHandler.DEFAULT_FACELETS_SUFFIX
instead.ViewHandler.FACELETS_SUFFIX_PARAM_NAME
instead.
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 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.
PERSISTENT
and NON_PERSISTENT
.Dependent
annotation.Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document.
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 section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document.
ViewHandler.deriveViewId(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.JsonParser
.JsonParser
.Destination
object encapsulates a provider-specific address.Destroyed
qualifier.Node
object from the tree.DetailEntry
objects.Detail
object, giving details for
a SOAPFault
object.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.
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.Dispatch
interface provides support
for the dynamic invocation of a service endpoint operations.ManagedConnection
implementation.ManagedConnection
instance from all of its connection
handles.Work
instance that would be distributed by a
DistributableWorkManager
for execution in a remote
DistributableWorkManager
WorkManager
that supports distributed
execution of Work instances.
Doctype is an interface that must be implemented by any UIComponent
that represents a document type declaration.
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.condition()
evaluates to true.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
.Work
instance for processing.Work
instance for processing.WorkContext
type passed in by the Work
instance.MessageFactory
instances that create
SOAPMessages
whose concrete type is based on the
Content-Type
MIME header passed to the
createMessage
method.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.
EISSystemException
is used to indicate any EIS
specific system-level
error conditions.isCallerInRole (String reference)
permissions.EJB
annotations.ELContext
has been created.ELContext
has been created.ELContext
is created.W3CEndpointReference
instance's
wsa:EndpointReference
element.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.ExternalContext.encodeResourceURL(String)
on the wrapped
ExternalContext
object.ExternalContext.encodeWebsocketURL(String)
on the wrapped
ExternalContext
object.toJson()
methods will default to this property
for encoding of output JSON data.DataSource
that also implements
EncodingAware
may specify the Content-Transfer-Encoding
to use for its 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.
ThreadContextSnapshot
began on this thread and restore the previous
context that was on the thread prior to that point.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.
EndpointContext
allows multiple endpoints in an application
to share any information.endpointName
as
wsam:ServiceName/@EndpointName
in the
wsa:Metadata
element.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
null
as its detail message.EntityNotFoundException
exception with the
specified detail message.EntityNotFoundException
exception with the
specified detail message.EntityPart
is one part of a multipart entity.EntityPart
instances.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.isMimeTypeEqual
method.hashCode()
contract,
use isMimeTypeEqual(String)
instead.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.AnnotationTarget
(which is most likely
a DeclarationInfo
).BeanInfo
.ObserverInfo
.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
Performs the same logic as StateHelper.eval(java.io.Serializable)
} but if no value is found, this will return the
return-value of the defaultValueSupplier
The default behavior of this method is to call
Application.evaluateExpressionGet(jakarta.faces.context.FacesContext, String, Class)
on the wrapped
Application
object.
Iterator
over all the SOAPHeaderElement
objects
in this SOAPHeader
object.Iterator
over all the SOAPHeaderElement
objects
in this SOAPHeader
object
that have the specified actor.Iterator
over all the SOAPHeaderElement
objects
in this SOAPHeader
object
that have the specified actor and that have a MustUnderstand attribute
whose value is equivalent to true
.
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.
Connection
object, it informs the Connection
object's ExceptionListener
, if one has been registered.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
.Work
instance must be executed.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.
Iterator
over all the SOAPHeaderElement
objects
in this SOAPHeader
object and detaches them
from this SOAPHeader
object.Document
and sets
the first child of this SOAPBody
as it's document
element.ValueExtractor
is
tied or specifies the type of the wrapped element(s) of non-generic container types.Iterator
over all the SOAPHeaderElement
objects
in this SOAPHeader
object
that have the specified actor and detaches them
from this SOAPHeader
object.
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 a list of alternate suffixes for Facelet based XHTML pages containing Jakarta 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.
FacesContextFactory
class name.ResourceBundle
identifier for messages whose message identifiers are defined in the Jakarta Faces
specification.Library name of Jakarta Faces script resource.
Resource name of Jakarta Faces script resource.
The presence of this annotation on a class automatically registers the class with the runtime as a Behavior
.
Supports inline instantiation of the FacesBehavior
qualifier.
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 class deployed within an application
guarantees activation of Jakarta Faces and its CDI specific features, even when
/WEB-INF/faces-config.xml
is absent and FacesServlet
is not explicitly registered.
Supports inline instantiation of the FacesConfig
qualifier.
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
.
Supports inline instantiation of the FacesConverter
qualifier.
Supports inline instantiation of the FacesDataModel
qualifier.
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
.
Supports inline instantiation of the FacesValidator
qualifier.
Any wrapper class in Jakarta 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.
CompletableFuture
that is already exceptionally completed with the specified Throwable
.CompletionStage
that is already exceptionally completed with the specified Throwable
.FaultAction
annotation is used inside an Action
annotation to allow an explicit association of a WS-Addressing
Action
message addressing property with the fault
messages of the WSDL operation mapped from the exception class.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.FieldConfig
objects for each field of this class,
as defined by ClassInfo.fields
.java.lang.Object
,
as well as all direct and indirect superinterfaces.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.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.
Supports inline instantiation of the FlowBuilderParameter
qualifier.
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.
Supports inline instantiation of the FlowDefinition
qualifier.
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.
Supports inline instantiation of the ApplicationMap
qualifier.
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.FolderAdapter
.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
SeBootstrap.Configuration.PORT
property indicating that the implementation MUST scan for a free port.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 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
.org.ietf.jgss.GSSCredential
interface in
J2SE Version 1.4, which provides similar functionality.T
.T
.Contextual.create(CreationalContext)
and return the new instance.key
.key
.
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.
Return the value of the 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.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.
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 Faces lifecycle.
ViewHandler.getActionURL(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.MessageEndpointFactory
.SOAPHeaderElement
.MethodExpression
that will be invoked after this view is rendered.Iterator
over all of the attribute
Name
objects in this
SOAPElement
object.Iterator
over all of the attributes
in this SOAPElement
as QName
objects.Header
objects.MimeHeader
s in this MimeHeaders
object.AttachmentPart
object
as an iterator over the MimeHeader
objects.SOAPPart
object
as an iterator over the MimeHeader
objects.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.
send
on this JMSProducer
object have been configured to be asynchronous then
this method returns the CompletionListener
that has previously been configured.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.
AttachmentPart
object that is associated with an
attachment that is referenced by this SOAPElement
or
null
if no such attachment exists.cid
, as a byte[]
.cid
, and return as a DataHandler
.AttachmentPart
objects that are part of
this SOAPMessage
object.AttachmentPart
objects that have header
entries that match the specified headers.
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.HttpExchange
.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.HttpExchange
.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.
Cookie.setAttribute(String, String)
as well as any
predefined setter method, except for version
.null
.ExternalContext.getAuthType()
on the wrapped
ExternalContext
object.autocomplete
property.autocomplete
property.JMSContext
will be started automatically when a
consumer is created.InputStream
which can be used to obtain the
content of AttachmentPart
as Base64 encoded
character data, this method would base64 encode the raw bytes
of the attachment and return.Bean
object representing the bean that defines the injection point.Bean
object that is about to be registered.BeanContainer
for this container.BeanContainer
for the current context.BeanManager
/BeanContainer
was injected or,
in the Jakarta EE environment, the Jakarta EE component from whose JNDI environment namespace the
BeanManager
/BeanContainer
was obtained, according to the rules of typesafe resolution.BeanManager
/BeanContainer
was injected or, in the Jakarta EE
environment, the Jakarta EE component from whose JNDI environment namespace the
BeanManager
/BeanContainer
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
.SOAPBody
object associated with this
SOAPEnvelope
object.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 Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta 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)
.
boolean
value with the specified name.JMSProducer
, converted to a
boolean
.boolean
property with the specified name.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
.byte
value with the specified name.JMSProducer
, converted to a
String
.byte
property with the specified name.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.getCause
method of Throwable
to return the next exception in the chain of nested exceptions.Throwable
object embedded in this
SOAPException
if there is one.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
.Iterator
over all the immediate child
Node
s of this element.Iterator
over all the immediate child
Node
s of this element with the specified name.Iterator
over all the immediate child
Node
s of this element with the specified qname.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.cmdName
for the MIME type.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
since in normal usage ScopedAttributeELResolver
will handle calls to
ELResolver.getCommonPropertyType(ELContext, Object)
.null
since in normal usage ScopedAttributeELResolver
will handle calls to
ELResolver.getCommonPropertyType(ELContext, Object)
.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.
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.
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.ServletRequest
from which this ServletConnection
was obtained.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.AttachmentPart
object as a Java
object.Source
object.SOAPMessage
object's
content.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.
JMSContext
object associated with this XAJMSContext
.Policy
provider to activate the PolicyContextHandler
registered to the context object key and cause it to return the corresponding policy context object from the
container.PolicyContext
class to activate the handler and obtain from it the
context object identified by the (case-sensitive) key.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.ContextService
which has the same propagation settings as this ManagedExecutorService
and uses this ManagedExecutorService
as the default asynchronous execution facility for
CompletionStage
and CompletableFuture
instances
that it creates via the withContextCapture
methods.
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).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.DataHandler
object for this AttachmentPart
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.JMSProducer
WorkContext
and any other related debugging information.WorkContext
and any other related debugging information.WorkContext
and any other related debugging information.WorkContext
and any other related debugging information.MessageProducer
.SOAPFault
object.DetailEntry
s in this Detail
object.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.double
value with the specified name.JMSProducer
, converted to a
double
.double
property with the specified name.ELContext
that was created.ELContext
instance for this FacesContext
instance.FacesContext.getELContext()
on the wrapped
FacesContext
object.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.
Result
.jaxbElement
.SOAPElement
object.SOAPElement
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.getEncoding(DataSource)
except that instead
of reading the data from an InputStream
it uses the
writeTo
method to examine the data.SOAPElement
object.enctype
property.Class
object corresponding to the message
endpoint class.EndpointReference
associated with
this BindingProvider
instance.EndpointReference
associated with
this BindingProvider
instance.EndpointReference
associated with
this Endpoint
instance.EndpointReference
associated with
this Endpoint
instance.EndpointReference
for this
endpoint.EndpointReference
associated with
this endpoint.SOAPEnvelope
object associated with this
SOAPPart
object.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.
WorkException
.
Create and return a A new ExceptionHandler
instance.
Return the ExceptionHandler
for this request.
FacesContext.getExceptionHandler()
on the wrapped
FacesContext
object.ExceptionListener
object for this connection.ExceptionListener
object for the JMSContext's connection.PolicyConfiguration.addToExcludedPolicy(Permission)
and PolicyConfiguration.addToExcludedPolicy(PermissionCollection)
.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.ManagedExecutorService
or
ManagedScheduledExecutorService
when executing this task.Endpoint
instance.Service
instance.Service
instance.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.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.
ViewDeclarationLanguage
creates and
caches instances of Facelets.
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".
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).Return the identifier of the component family to which this component belongs.
UIWebsocket.COMPONENT_FAMILY
.fatalClass
property.fatalClass
property.fatalStyle
property.fatalStyle
property.SOAPFault
object in this SOAPBody
object.SOAPFault
instance.SOAPFault
object.SOAPFault
object.SOAPFault
object as a SAAJ Name
object.SOAPFault
object as a QName
object.SOAPFault
object.Iterator
over a distinct sequence of
Locale
s for which there are associated Reason Text items.Locale
.Iterator
over a sequence of
String
objects containing all of the Reason Text items for
this SOAPFault
.SOAPFault
object.SOAPFault
object.SOAPFault
object.SOAPFault
as an iterator over
QNames
.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.
float
value with the specified name.JMSProducer
, converted to a
float
.float
property with the specified name.
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
.CompletableFuture
instance that the Jakarta EE Product Provider supplies to the caller of the
asynchronous method.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
.String
objects.SOAPHeader
object for
this SOAPEnvelope
object.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.HttpContext
for this exchange.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.
ManagedTask.IDENTITY_NAME
execution property of the task if
it also implements the ManagedTask
interface.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 eventInjectionPoint
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.InputStream
representing
the data and throws the appropriate exception if it can
not do so.
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)
.int
value with the specified name.getJsonNumber(index).intValue()
.JsonNumber
at the specified position.getJsonNumber(name).intValue()
JsonNumber
mapping
for the specified name.Nonbinding
.int
.JMSProducer
, converted to a
int
.int
property with the specified name.ManagedConnection
objects chosen from a specified set of ManagedConnection
objects.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
.JMSCorrelationID
header value that has been set on this JMSProducer
, as a String
.JMSCorrelationID
header value that has been set on this JMSProducer
, as an array of
bytes.DeliveryMode
value specified for this message.Destination
object for this message.JMSReplyTo
header value that has been set on this JMSProducer
.Destination
object to which a reply to this message should be sent.JMSType
header value that has been set on this JMSProducer
.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.
The default behavior of this method is to call FacesContext.getLifecycle()
on the wrapped
FacesContext
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.getCause
and
initCause
methods of the
java.lang.Throwable
class..getCause
and
initCause
methods of the
java.lang.Throwable
class.Marshaller.Listener
registered with this Marshaller
.Unmarshaller.Listener
registered with this Unmarshaller
.
This implementation throws UnsupportedOperationException
and is provided for the sole purpose of not