breaking existing applications that extend this class.
Return the SystemEventListener
instances registered on this UIComponent
instance that are
interested in events of type eventClass
.
Return a List
that contains a single entry, the ExceptionHandler
for the
current request.
Locale
stored by a previous invocation to ELContext.setLocale(java.util.Locale)
.Locale
to be used in localizing the response being created for this view.Locale
to be used when parsing or formatting dates and times.Locale
to be used when parsing numbers.Locale
that the client will accept content in, based on the Accept-Language
header.ServletResponse.setLocale(java.util.Locale)
method.Enumeration
of Locale
objects indicating, in decreasing order starting with the
preferred locale, the locales that are acceptable to the client based on the Accept-Language header.args
.args
.Return the XML local name of the tag.
ServletRequest.getLocalAddr()
.Name
object represents.jakarta.resource.spi.LocalTransaction
instance.UIComponent
(if any), without evaluating any associated
ValueExpression
.
Return the Location of this Tag
instance in the Facelet view.
long
value with the specified name.longdesc
property.JMSProducer
, converted to a
long
.long
property with the specified name.ManagedTaskListener
to receive notification of lifecycle
events of this task.Enumeration
of all the names in the MapMessage
object.MappingMatch
for this instanceServletRegistration
.Header
objects.MimeHeader
objects whose name matches
a name in the given array of names.MimeHeader
objects that match a name in
the given array.MimeHeader
objects that match a name in
the given array.getAsString()
should render in the fraction portion of the result.Validator
or Double.MAX_VALUE
if it has not been
set.Validator
, or 0
if the maximum has not been
set.Validator
.FacesMessage
s that has been
queued, whether or not they are associated with any specific UIComponent
.FacesContext.getMaximumSeverity()
on the wrapped
FacesContext
object.getAsString()
should render in the integer portion of the result.maxlength
property.maxlength
property.MediaType.valueOf(part.getHeaders().getFirst(HttpHeaders.CONTENT_TYPE))
.media type
of the event data.Field
object in the case of field injection, the Method
object in the case of method parameter injection or the Constructor
object in the case of
constructor parameter injection.
Returns the FaceletCache.MemberFactory
passed to FaceletCache.setCacheFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)
for the purpose of creating Facelet instance.
null
, otherwise, return the message.SOAPException
object.SOAPMessage
from this message context.ResourceBundle
to be used for Jakarta Faces messages
for this application.
The default behavior of this method is to call Application.getMessageBundle()
on the wrapped
Application
object.
MessageContext
for the current part.MessageContext
for the request being served
at the time this method is called.MessageFactory
instance used by this SOAP binding.MessageInterpolator
instance configured at
initialization time for the ValidatorFactory
.MessageInterpolator
implementation
or null
if none is specified.
Like FacesContext.getMessages()
, but returns a List<FacesMessage>
, enabling use from Jakarta Expression
Language expressions.
Like FacesContext.getMessages(java.lang.String)
, but returns a List<FacesMessage>
of messages for the
component with client id matching argument clientId
.
FacesContext.getMessageList()
on the wrapped
FacesContext
object.FacesContext.getMessageList(String)
on the wrapped
FacesContext
object.JMSConsumer
's MessageListener
.MessageConsumer
's MessageListener
.Iterator
over the FacesMessage
s that have been queued,
whether or not they are associated with any specific client identifier.Iterator
over the FacesMessage
s that have been queued that
are associated with the specified client identifier (if clientId
is not null
), or over the
FacesMessage
s that have been queued that are not associated with any specific
client identifier (if clientId
is null
).FacesContext.getMessages()
on the wrapped FacesContext
object.FacesContext.getMessages(String)
on the wrapped
FacesContext
object.JMSConsumer
's message selector expression.
Returns the FaceletCache.MemberFactory
passed to FaceletCache.setCacheFactories(jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>, jakarta.faces.view.facelets.FaceletCache.MemberFactory<V>)
for the purpose of creating View Metadata
Facelet instance.
Metamodel
interface for access to the
metamodel of the persistence unit.Metamodel
interface for access to the
metamodel of the persistence unit.Return an immutable data structure containing all the method call nodes declared for this flow.
Return the MethodExpression
to be invoked to when control passes to this node.
MethodReference
for the method to which this method
expression resolves.String
.MimeHeader
object
in this SOAPPart
object that
is identified by the given String
.SOAPMessage
object in a transport-independent fashion.
Returns the MIME type of the specified file or null
if the MIME type is not known.
ExternalContext.getMimeType(String)
on the wrapped
ExternalContext
object.null
if the MIME type is not known.getAsString()
should render in the fraction portion of the result.Validator
, or Double.MIN_VALUE
if it has not
been set.Validator
, or 0
if the minimum has not been
set.Validator
.getAsString()
should render in the integer portion of the result.SOAPHeaderElement
.getFile
method on the URL used to
instantiate the object.Returns the Parameter's name.
name
property.Return the request parameter name from which the value is retrieved.
Return the name of this phase.
Return the name of the parameter
Returns the name by which this attached object target is exposed to the page author.
NamedEntityGraph
annotation, XML descriptor element, or added by means of the
addNamedEntityGraph
method.WorkContext
.WorkContext
.WorkContext
.WorkContext
.null
if it is a leaf node which represents an entity / bean.MimeHeader
object.RequestDispatcher
object that acts as a wrapper for the named servlet.Return the resolved XML Namespace for this tag in the Facelets view.
Iterator
over the namespace prefix
String
s declared by this element.
Starting with "this", return the closest component in the ancestry that is a NamingContainer
or
null
if none can be found.
Return the result of calling UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext)
, passing this
as the argument.
The default behavior of this method is to call FacesContext.getNamingContainerSeparatorChar()
on the wrapped
FacesContext
object.
Return the NavigationCase
representing the navigation that would be taken had
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments or null
if there is no
such case.
Return the NavigationCase
representing the navigation that would be taken had
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
been called with the same arguments or null
if there is no
such case.
Return a Map<String,
Set<NavigationCase>>
where the keys are <from-view-id>
values and the values are
Set<NavigationCase>
where each element in the Set is a NavigationCase
that applies to
that <from-view-id>
.
Return an unmodifiable view of the navigation cases within this flow.
NavigationHandler
instance that will be passed the outcome returned by any invoked application
action for this web application.
The default behavior of this method is to call Application.getNavigationHandler()
on the wrapped
Application
object.
UIComponent
.
The next FaceletHandler
(child or children) to be applied.
Return the generic FlowNode
by id, or null
if not found.
UnsupportedOperationException
.NoLocal
attribute for this subscriber.Header
objects.MimeHeader
objects whose name does not
match a name in the given array of names.MimeHeader
objects whose name does
not match a name in the given array.MimeHeader
objects whose name does
not match a name in the given array.JsonObject
and advances the parser to the
corresponding END_OBJECT
.JMSProducer
, converted to
objectified format.JsonObject
's
name/value pairs.ObserverMethod
object that will be used by the container to invoke the observer
when a matching event is fired.UIComponent
.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onblur
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onchange
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.onclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.ondblclick
property.
Return the String
of JavaScript function name that will be used to identify the client callback function
that should be run in the event of an error.
onerror
property.
Return the String
of JavaScript function name that will be used to identify the client callback function
that should be run on the occurance of a client-side event.
onevent
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onfocus
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeydown
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeypress
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onkeyup
property.onload
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousedown
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmousemove
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseout
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseover
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onmouseup
property.onreset
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onselect
property.onsubmit
property.onunload
property.FacesMessage.Severity
instance.PhaseId
instance.
Returns the outcome
property of the UIOutcomeTarget
.
Return the outcome
to be used in the event of a null
return from the method.
OutputStream
where the
data can be written and throws the appropriate exception if it can
not do so.ServletOutputStream
suitable for writing binary data in the response.page-encoding
configuration, which specifies the default page encoding for any JSP
pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.String
, or null
if the parameter does not
exist.ParameterNameProvider
instance configured at
initialization time for the ValidatorFactory
.ParameterNameProvider
implementation
or null
if none is specified.Enumeration
of String
objects containing the names of the parameters contained
in this request.Return the parameters to be included for navigation cases requiring a redirect.
Returns parameters that "submitting" ClientBehavior
implementations should include when posting back data
into the Faces lifecycle.
Return the parameters to be passed to the method.
String
objects containing all of the values the given request parameter has, or
null
if the parameter does not exist.UIComponent
of this UIComponent
, if any.Multipart
object,
or null
if not known.Part
that contains this Multipart
object, or null
if not known.Node
object.Part
with the given name.
Return the ResponseWriter
to which components should direct their output for partial view rendering.
PartialViewContext.getPartialResponseWriter()
on the wrapped
PartialViewContext
object.
Return the PartialViewContext
for this request.
FacesContext.getPartialViewContext()
()} on the wrapped
FacesContext
object.PartialViewContext
instance that is
initialized using the current FacesContext
instance.Part
components of this request, provided that it is of type multipart/form-data
.PassivationCapable
bean with the given identifier.
This is a convenience method that simply calls UIComponent.getPassThroughAttributes(boolean)
, passing true
as
the argument.
This method has the same specification as UIComponent.getPassThroughAttributes()
except that it is allowed to return
null
if and only if the argument create
is false
and no pass through attribute data structure
exists for this instance.
Return the file path to the page represented by this location.
PathSegment
.PathSegment
.ValueExpression
that yields the regular expression pattern when evaluated.url-pattern
for this mapping.Source
that may be used to retrieve the entire
message payload.PolicyConfiguration.addToRole(String, Permission)
and PolicyConfiguration.addToRole(String, PermissionCollection)
, indexed by the role names used
in those calls.PersistenceProvider
implementations
available in the runtime environment.persistence.xml
file.Returns the name of the lifecycle phase in which the action is to be queued.
Return the PhaseId
which was being processed when the exception was thrown.
PhaseId
representing the current request processing lifecycle phase.PhaseEvent
events.
Return an unmodifiable list of the PhaseListener
instances attached to this UIViewRoot
instance.
PhaseListener
s for this Lifecycle
instance.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.getPort
method returns a proxy.Iterator
for the list of
QName
s of service endpoints grouped by this
serviceIterator
for the list of
QName
s of service endpoints grouped by this
serviceName
object
was initialized.JMSProducer
Producer
object that will be used by the container to call the producer
method or read the producer field.ProducerFactory
that provides container created Producer
instances for the given
field.ProducerFactory
that provides container created Producer
instances for the given
method.Return the project stage for the currently running application instance.
The default behavior of this method is to call Application.getProjectStage()
on the wrapped Application
object.
Endpoint
instance.
Return a beans PropertyDescriptor
for the property with name given by argument name
.
null
if there is no property by that name.null
if there is no property by that name.null
if there is no property by that name.Binder
.Marshaller
.Unmarshaller
.Set
view of the names of all the message properties that have been set on this
JMSProducer.Enumeration
of all the property names.collection
containing the property names available within the context of the
current request/response exchange context.collection
containing the property names available within the
context of the current request/response exchange context.collection
containing the property names available within the
context of the current configuration instance.collection
containing the property names available within the
context of the current request/response exchange context.
Return a Class
for the property with name given by argument name
.
Return an unmodifiable Set
of the protected views currently known to this ViewHandler
instance.
ViewHandler.getProtectedViewsUnmodifiable()
on the wrapped
ViewHandler
object.ServletRequest
from which this ServletConnection
was obtained as defined by the protocol in use.null
if there is none.public
property.Return the XML qualified name for this tag.
Name
object represents.Nonbinding
.This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL.
Queue
associated with this queue receiver.QueueSender
.XAQueueSession
.AttachmentPart
object as an
InputStream as if a call had been made to getContent
and no
DataContentHandler
had been registered for the
content-type
of this AttachmentPart
.AttachmentPart
object as a
byte[] array as if a call had been made to getContent
and no
DataContentHandler
had been registered for the
content-type
of this AttachmentPart
.BufferedReader
.
Return a Method
for the getter of the property with name given by argument name
.
Returns a String containing the real path for a given virtual path.
ExternalContext.getRealPath(String)
on the wrapped
ExternalContext
object.Reception
for the observer method.
Construct an absolute URL suitable for a "redirect" to this NavigationCase
instance using
ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean)
on the path portion of the url.
Return a Jakarta Faces action URL derived from the viewId
argument that is suitable to be used by
the NavigationHandler
to issue a redirect request to the URL using a NonFaces request.
ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean)
on the wrapped
ViewHandler
object.rel
property.rel
property.rel
property.rel
param, or null
if this param is not specified.SOAPHeaderElement
rel
param as a list of strings or the empty list if rel
is
not defined.Returns the remaining expression for the current request.
ServletRequest.getRemoteAddr()
.null
.ExternalContext.getRemoteUser()
on the wrapped
ExternalContext
object.null
if the
user has not been authenticated.
Return a non-empty Collection<String>
of component identifiers that will be used to identify
components that should be processed during the render
phase of the request processing lifecycle.
render
property.
Convenience method to return the ClientBehaviorRenderer
instance associated with this ClientBehavior
,
if any; otherwise, return null
.
Renderer
instance associated with this component, if any; otherwise, return
null
.Renderer
instance most recently registered for the specified component family
and
rendererType
, if any; otherwise, return null
.RenderKit.getRenderer(String, String)
on the wrapped
RenderKit
object.
Returns the renderer type of the ClientBehaviorRenderer
to use for the behavior.
Renderer
type for this UIComponent
(if any).
RendererType to set on created UIComponent
instances.
Return the renderer-type
for a Renderer
that is capable of rendering this
resource.
The default behavior of this method is to call ResourceHandler.getRendererTypeForResourceName(String)
on the
wrapped ResourceHandler
object.
Return an Iterator
over the renderer-type entries for the given component-family.
RenderKit.getRendererTypes(String)
on the wrapped
RenderKit
object.
Return a Collection
of client identifiers from the current request with the request parameter name
PartialViewContext.PARTIAL_RENDER_PARAM_NAME
.
PartialViewContext.getRenderIds()
on the wrapped
PartialViewContext
object.RenderKit
instance for the render kit identifier specified on our UIViewRoot
, if there is
one.FacesContext.getRenderKit()
on the wrapped
FacesContext
object.RenderKit
instance for the specified render kit identifier, possibly customized based on dynamic
characteristics of the specified FacesContext
, if non-null
.RenderKit
associated with this view.Iterator
over the set of render kit identifiers registered with this factory.true
if the renderResponse()
method has been called for the current request.FacesContext.getRenderResponse()
on the wrapped
FacesContext
object.
Call UIComponentBase.getRendersChildren()
If PartialViewContext.isAjaxRequest()
returns true
this method must return true
.
Renderer
is responsible for rendering the children the component it is
asked to render.ExternalContext.getRequest()
on the wrapped
ExternalContext
object.ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest, ServletResponse)
.ExternalContext.getRequestCharacterEncoding()
on the wrapped
ExternalContext
object.
Return the result of calling getContentLenth()
on the ServletRequest
instance for this
request.
ExternalContext.getRequestContentLength()
on the wrapped
ExternalContext
object.ExternalContext.getRequestContentType()
on the wrapped
ExternalContext
object.ExternalContext.getRequestContextPath()
on the wrapped
ExternalContext
object.Map
whose keys are the set of cookie names included in the current request, and
whose values (of type jakarta.servlet.http.Cookie
) are the first (or only) cookie for each cookie name
returned by the underlying request.ExternalContext.getRequestCookieMap()
on the wrapped
ExternalContext
object.RequestDispatcher
object that acts as a wrapper for the resource located at the given path.RequestDispatcher
object that acts as a wrapper for the resource located at the given path.Map
whose keys are the set of request header names included in the current request,
and whose values (of type String) are the first (or only) value for each header name returned by the underlying
request.ExternalContext.getRequestHeaderMap()
on the wrapped
ExternalContext
object.Map
whose keys are the set of request header names included in the current request,
and whose values (of type String[]) are all of the value for each header name returned by the underlying request.ExternalContext.getRequestHeaderValuesMap()
on the wrapped
ExternalContext
object.Locale
in which the client will accept content.ExternalContext.getRequestLocale()
on the wrapped
ExternalContext
object.Iterator
over the preferred Locale
s specified in the request, in decreasing order
of preference.ExternalContext.getRequestLocales()
on the wrapped
ExternalContext
object.Map
representing the request scope attributes for the current application.ExternalContext.getRequestMap()
on the wrapped
ExternalContext
object.Map
whose keys are the set of request parameters names included in the current
request, and whose values (of type String) are the first (or only) value for each parameter name returned by the
underlying request.ExternalContext.getRequestParameterMap()
on the wrapped
ExternalContext
object.Iterator
over the names of all request parameters included in the current request.ExternalContext.getRequestParameterNames()
on the wrapped
ExternalContext
object.Map
whose keys are the set of request parameters names included in the current
request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying
request.ExternalContext.getRequestParameterValuesMap()
on the wrapped
ExternalContext
object.Return a path to this resource such that, when the browser resolves it against the base URI for the view that includes the resource, and issues a GET request to the resultant fully qualified URL, the bytes of the resource are returned in response.
The default behavior of this method is to call Resource.getRequestPath()
on the wrapped ResourceHandler
object.
null
.ExternalContext.getRequestPathInfo()
on the wrapped
ExternalContext
object.Returns the name of the scheme used to make this request, for example, http, https, or ftp.
ExternalContext.getRequestScheme()
on the wrapped
ExternalContext
object.Returns the host name of the server to which the request was sent.
ExternalContext.getRequestServerName()
on the wrapped
ExternalContext
object.Returns the port number to which the request was sent.
ExternalContext.getRequestServerPort()
on the wrapped
ExternalContext
object.null
.ExternalContext.getRequestServletPath()
on the wrapped
ExternalContext
object.UIInput.setRequiredMessage(java.lang.String)
on this instance, return the message.resetValues
property.URL
for the application resource mapped to the
specified path, if it exists; otherwise, return null
.ExternalContext.getResource(String)
on the wrapped
ExternalContext
object.ResourceAdapter
object.InputStream
for an application resource mapped to
the specified path, if it exists; otherwise, return null
.ExternalContext.getResourceAsStream(String)
on the wrapped
ExternalContext
object.InputStream
object.ResourceBundle
as defined in the application configuration resources under the specified name.
The default behavior of this method is to call
Application.getResourceBundle(jakarta.faces.context.FacesContext, String)
on the wrapped Application
object.
Return a Map<String,String>
of the ResourceBundle
for this component.
null
if this information is not available.
Return the singleton, stateless, thread-safe ResourceHandler
for this application.
The default behavior of this method is to call Application.getResourceHandler()
on the wrapped
Application
object.
Return the list of resource library contracts that have been calculated to be appropriate for use with this view, or an empty list if there are no such resource library contracts.
FacesContext.getResourceLibraryContracts()
on the wrapped
FacesContext
object.null
if this information is not available.Return the resourceName for this resource.
The default behavior of this method is to call Resource.getResourceName()
on the wrapped
ResourceHandler
object.
Set
of resource paths for all application resources
whose resource path starts with the specified argument.ExternalContext.getResourcePaths(String)
on the wrapped
ExternalContext
object.
Construct an absolute URL to this NavigationCase
instance using
ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String)
on the path portion of the url.
If the value returned from this method is used as the file
argument to the four-argument constructor for
java.net.URL
(assuming appropriate values are used for the first three arguments), then a client making
a request to the toExternalForm()
of that URL
will select the argument path
for direct rendering.
ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, String)
on the wrapped ViewHandler
object.ExternalContext.getResponse()
on the wrapped
ExternalContext
object.ServletRequest.startAsync()
or
ServletRequest.startAsync(ServletRequest, ServletResponse)
.Return the buffer size for the current response.
ExternalContext.getResponseBufferSize()
on the wrapped
ExternalContext
object.ExternalContext.getResponseCharacterEncoding()
on the wrapped
ExternalContext
object.true
if the responseComplete()
method has been called for the current request.FacesContext.getResponseComplete()
on the wrapped
FacesContext
object.ExternalContext.getResponseContentType()
on the wrapped
ExternalContext
object.
Returns a mutable Map<String, String>
whose entries will be sent as response headers during
ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)
.
The default behavior of this method is to call Resource.getResponseHeaders()
on the wrapped
ResourceHandler
object.
Returns an OutputStream
suitable for writing binary data to the user-agent.
ExternalContext.getResponseOutputStream()
on the wrapped
ExternalContext
object.
Returns a Writer
suitable for writing character data to the user-agent.
ExternalContext.getResponseOutputWriter()
on the wrapped
ExternalContext
object.ResponseStateManager
to handle rendering technology specific state management
decisions.RenderKit.getResponseStateManager()
on
the wrapped RenderKit
object.ResponseStream
to which components should direct their binary output.FacesContext.getResponseStream()
on the wrapped
FacesContext
object.ResponseWriter
to which components should direct their character-based output.FacesContext.getResponseWriter()
on the wrapped
FacesContext
object.java.util.stream.Stream
.java.util.stream.Stream
.Return an immutable data structure containing all of the return nodes declared for this flow.
rev
property.rev
property.rev
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.role
property.SOAPHeaderElement
.
Unwrap the argument t
until the unwrapping encounters an Object whose getClass()
is not
equal to FacesException.class
or jakarta.el.ELException.class
.
ExceptionHandler.getRootCause(Throwable)
on the wrapped ExceptionHandler
object.Throwable.getCause()
null
.rootElement
property.rowClass
property.rowClass
property.rowClasses
property.rowClasses
property.wrappedData
available, return the length of the array.wrappedData
available, return the length of the list.DataModel
.DataModel
.wrappedData
available, return the length of the list.ResultSet
does not provide a standard way to determine the number of available rows
without scrolling through the entire ResultSet
, and this can be very expensive if the number of rows is
large.wrappedData
available, return 1.rowIndex
.rowIndex
.null
for no associated row data.rowIndex
.Map
representing the values of the columns for the row specified by
rowIndex
, keyed by the corresponding column names.rows
property.SortedMap
objects.rules
property.rules
property.ServletRegistration
.RxInvoker
implementation instance.SameSite
attribute for this cookie or null
if the attribute is not set.Schema
object (including null) set by the
Binder.setSchema(Schema)
method.Schema
object
being used to perform marshal-time validation.Schema
object
being used to perform unmarshal-time validation.http
, https
, or
ftp
.
Return the scope itself, exposed as a Map
.
Return the name of this custom scope.
Return the script that implements this ClientBehavior's client-side logic.
Default implementation of of ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext)
.
Return the script that implements this ClientBehavior's client-side logic.
Take implementation specific action to discover a Resource
given the argument
componentResource
.
scripting-invalid
configuration, which specifies whether scripting is enabled for
any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.
Creates a SearchExpressionContext
instance for use with the SearchExpressionHandler
.
Returns the SearchExpressionContext
for the current request.
Return the thread-safe singleton SearchExpressionHandler
for this application.
Return the singleton SearchKeywordResolver
instance to be used for all search keyword resolution.
true
if the browser is sending cookies only over a secure protocol, or false
if the
browser can send cookies using any protocol.selectedClass
property.null
if there are no currently selected values.SelectItem
s for this group.Return the character used to separate segments of a clientId.
ServletConfig
instance for this servlet.ServletConfig
object.ServletConfig
object, which contains initialization and startup parameters for this servlet.ServletContext
in which the caller is executing.ServletContext
in which this filter is running.ServletContext
in which this servlet is running.ServletContext
in which the caller is executing.servlet-name
for this mapping.FilterRegistration
.create
parameter is true
, create (if necessary) and return a session instance
associated with the current request.ExternalContext.getSession(boolean)
on the wrapped
ExternalContext
object.ServerSession
's Session
.XASession
.HttpSession
associated with this request or, if there is no current session and
create
is true, returns a new session.SessionBeanType
representing the kind of session bean.SessionCookieConfig
object through which various properties of the session tracking cookies created
on behalf of this ServletContext may be configured.
Return the id of the current session or the empty string if no session has been created and the create
parameter is false
.
The default behavior of this method is to call ExternalContext.getSessionId(boolean)
on the wrapped
ExternalContext
object.
Map
representing the session scope attributes for the current application.ExternalContext.getSessionMap()
on the wrapped
ExternalContext
object.Returns the maximum time interval, in seconds, that the Jakarta Servlet container will keep this session open between client accesses.
The default behavior of this method is to call ExternalContext.getSessionMaxInactiveInterval()
on the wrapped
ExternalContext
object.
shape
property.shape
property.shape
property.short
value with the specified name.JMSProducer
, converted to a
short
.short
property with the specified name.getClasses
method is preferred over
getSingletons
.size
property.size
property.size
property.size
property.writeTo
to ascertain the length in bytes of the serialized form
of t
.AttachmentPart
object.SOAPMessage
object.SOAPFactory
instance used by this SOAP binding.SOAPMessage
object.SOAPMessage
object.AnnotatedType
for which this event is being fired.Bean
for which this event is being fired.ObserverMethod
for which this event is being fired.Returns the source / base component from which we will start to perform our search.
Returns an id for use as the ClientBehavior
source.
Return the immutable id for the default node that should be activated when this flow is entered.
ResponseStateManager.writeState(jakarta.faces.context.FacesContext,java.lang.Object)
.
Return the StateHelper
instance used to help this component implement PartialStateHolder
.
Like UIComponent.getStateHelper()
, but only create a state helper instance if the argument creat
is
true
.
For implementations that want to control the implementation of state saving and restoring, the
StateManagementStrategy
allows them to do so.
StateManager
instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call Application.getStateManager()
on the wrapped Application
object.
HttpServletResponse.getStatus()
on the wrapped response object.String
value with the specified name.getJsonString(index).getString()
.String
value of JsonString
at the specified
position in this JSON array values.getJsonString(name).getString()
JsonString
mapping
for the specified name.String
for the name in a name/value pair,
for a string value or a number value.JMSProducer
, converted to a
String
.String
property with the specified name.
If the value of this parameter comes from a ValueExpression
return the value of the expression,
otherwise, return the local value.
Manually perform standard conversion steps to get a string value from the value expression.
style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.style
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.styleClass
property.UIInput
component.
Assume that the submitted value is always a string,
but the return type from this method is Object
..
Given a NamingContainer
component, returns the client ids of any components
underneath the NamingContainer that should be visited.
summary
property.summary
property.Iterator
over the supported Locale
s for this appication.
The default behavior of this method is to call Application.getSupportedLocales()
on the wrapped
Application
object.
Return an immutable data structure containing all of the switch nodes declared for this flow.
null
if there is none.system
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.tabindex
property.Tag
instance corresponding to this TagHandler
instance.A reference to the Tag for which this class represents the attributes.
A reference to the Tag for which this class represents the attributes.
Return the Tag
representing this handler.
Get the tag handler delegate.
Return the implementation specific delegate instance that provides the bulk of the work for this handler instance.
TagConfig
used to instantiate this handler.A document-unique id, follows the convention "_tagId##"
<taglib>
child elements of the <jsp-config>
element represented by
this JspConfigDescriptor
.target
property.target
property.target
property.target
property.
Return the Class
of the metadata target.
Returns the List<UIComponent>
that this AttachedObjectTarget
exposes.
Returns the literal String value of the contained text.
Returns the resolved literal String value of the contained text after evaluating EL.
null
if this exception arose from a failure to decode a binary message..ThreadContextProvider
implementation.AroundTimeout
.JMSProducer
.TimeZone
used to interpret a time value.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
property.title
param, or null
if this param is not specified.
If this navigation case represents a flow invocation, this property is the documentId in which the flow whose id is
given by the return from NavigationCase.getFromOutcome()
is defined.
TopicPublisher
.Topic
associated with this subscriber.XATopicSession
.
Evaluates the <to-view-id>
for this <navigation-case>
HttpServletResponse.getTrailerFields()
on the wrapped response
object.EntityTransaction
object.TransactionPhase
for the observer method.ManagedConnectionFactory
.TransactionSynchronization
instance.EntityManagerFactory
.
Return the value currently associated with the specified key
if any.
Performs the same logic as TransientStateHelper.getTransient(java.lang.Object)
} but if no value is found, this will return the specified
defaultValue
Return the TransientStateHelper
instance for this UIComponent
instance.
Return the TransientStateHelper
instance for this UIComponent
instance.
TraversableResolver
instance configured
at initialization time for the ValidatorFactory
.TraversableResolver
implementation
or null
if none is specified.trim-directive-whitespaces
configuration, which specifies whether template text
containing only whitespaces must be removed from the response output of any JSP pages mapped to the JSP property
group represented by this JspPropertyGroupDescriptor
.null
, returns the most general acceptable type that can be set on this bean
property.base
and property
, attempts to identify the most general type that is
acceptable for an object to be passed as the value
parameter in a future call to the CompositeELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
method.base
and property
, attempts to identify the most general type that is
acceptable for an object to be passed as the value
parameter in a future call to the ELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
method.ResourceBundle
, return null
, since the resolver is
read only.value
parameter in a future call to the ValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)
method.type
property.type
property.
Return the value of the type
property.
type
property.type
property.null
, and the property matches the name of a JSP implicit object, returns
null
to indicate that no types are ever accepted to setValue()
.null
since in normal usage ScopedAttributeELResolver
will handle calls to
ELResolver.getType(ELContext, Object, Object)
.null
since in normal usage ScopedAttributeELResolver
will handle calls to
ELResolver.getType(ELContext, Object, Object)
.null
, returns Object.class
to indicate that any type is valid to
set for a scoped attribute.Type
instance.type
param, or null
if this param is not specified.
Return the UIViewParameter
to which this instance refers.
PolicyConfiguration.addToUncheckedPolicy(Permission)
and PolicyConfiguration.addToUncheckedPolicy(PermissionCollection)
.
Return an Iterable
over all ExceptionQueuedEvent
s that have not yet been handled by the
ExceptionHandler.handle()
method.
ExceptionHandler.getUnhandledExceptionQueuedEvents()
on the
wrapped ExceptionHandler
object.unselectedClass
property.Name
object represents.URI
of the current resource target.UriBuilder
initialized with this link's underlying URI.
Return an actual URL
instance that refers to this resource instance.
The default behavior of this method is to call Resource.getURL()
on the wrapped ResourceHandler
object.
Return an actual URL
instance that refers to this resource instance.
UIGraphic
.FilterRegistration
.JspPropertyGroupDescriptor
.usemap
property.<f:websocket user>
, if any.user
.Principal
object containing the name of the current authenticated user, if any; otherwise,
return null
.ExternalContext.getUserPrincipal()
on the wrapped
ExternalContext
object.java.security.Principal
object containing the name of the current authenticated user.null
if no user is authenticated for this handshake.null
if no user is authenticated for this session.java.security.Principal
object containing the name of the current authenticated user.Principal
that represents the authenticated
user for this HttpExchange
.Return the validation groups passed to the Validation API when checking constraints.
ValidationProviderResolver
strategy
instance or null
if undefined.ValidationProvider
available in the runtime environment.Validator
instance respecting the defined state.Validator
instance using the
factory defaults for message interpolator, traversable resolver
and constraint validator factory.
Return the TagConfig
subclass used to configure this handler instance.
Return the validator-id associated with a particular validator in your faces-config
EditableValueHolder
.Iterator
over the set of currently registered validator ids for this Application
.
The default behavior of this method is to call Application.getValidatorIds()
on the wrapped Application
object.
UIInput.setValidatorMessage(java.lang.String)
on this instance, return the message.Validator
s for this component instance.null
, returns the current value of the given property on this bean.null
and the property is a name that is resolvable by the BeanNameResolver,
returns the value resolved by the BeanNameResolver.property
object on the given base
object by querying all
component resolvers.property
object on the given base
object.property
argument.ResourceBundle
, the provided property will first be coerced to a
String
.Returns the Parameter's value.
value
property of the UICommand
.value
property of the UIGraphic
.
If there is a local value, return it, otherwise return the result of calling super.getVaue()
.
Return the value property.
value
property of the UIParameter
.value
property of the UISelectItem
.SelectItemGroup
instance containing one or more SelectItem
instances represented by any nested UISelectItems
or
UISelectItem
components.value
attribute and wrap each item in a new SelectItemGroup
instance whereby the item is exposed as a request
attribute under the key specified by the var
property.value
property of the UISelectItems
.UIComponent
.
Return a ValueExpression
for the value of the parameter.
target
.JsonValue
at the current parser position.null
, and the property matches the name of a JSP implicit object, returns the
implicit object.null
, searches the Class and static imports for an import with the given name
and returns it if an import exists with the given name.null
since in normal usage ScopedAttributeELResolver
will handle calls to
ELResolver.getValue(ELContext, Object, Object)
.null
, searches the page, request, session and application scopes for an
attribute with the given name and returns it if an attribute exists with the current name.EntityTag
.MimeHeader
object.Text
node or the
value of the immediate child of this node otherwise.ValueChangeListener
s for this component instance.ValueChangeListener
s for this UIInput
instance.
Returns the ValueExpression
used to calculate the value for the specified property name, if any.
ValueExpression
used to calculate the value for the specified attribute or property name, if any.ValueExpression
set for value
if a ValueExpression
for url
is
requested; otherwise, perform the default superclass processing for this method.ValueExpression
set for value
if a ValueExpression
for selected
is requested; otherwise, perform the default superclass processing for this method.ValueExpression
set for value
if a ValueExpression
for
selectedValues
is requested; otherwise, perform the default superclass processing for this method.ValueExtractor
s.ValueReference
for this expression instance.JsonValue
from a sequence of
JSON values.VariableMapper
associated with this ELContext
.ELContext.getELResolver()
, which can be obtained by
jspContext.getELContext().getELResolver()
.variant
information.Return the immutable VDL document id for this view node.
Utility method to extract view metadata from the provided UIViewRoot
.
Return the ViewDeclarationLanguage
instance used for this
ViewHandler
instance.
ViewHandler.getViewDeclarationLanguage(jakarta.faces.context.FacesContext, java.lang.String)
on the wrapped
ViewHandler
object.
Return the ViewDeclarationLanguage
instance suitable for
handling the VDL contained in the page referenced by the argument viewId
.
ViewHandler
instance that will be utilized during the Restore View and Render
Response phases of the request processing lifecycle.
The default behavior of this method is to call Application.getViewHandler()
on the wrapped Application
object.
null
if the view identifier is nonexistent or unknown.Get the view id
Return the SystemEventListener
instances registered on this UIComponent
instance that are
interested in events of type eventClass
.
This implementation simply calls through to UIViewRoot.getViewMap(boolean)
, passing true
as the argument,
and returns the result.
Returns a Map
that acts as the interface
to the data store that is the "view scope", or, if this instance does not have such a Map
and the
create
argument is true
, creates one and returns it.
Return a reference to the view metadata for the view represented by the argument viewId
, or
null
if the metadata cannot be found.
Returns a cached View Metadata Facelet instance.
Utility method to extract view metadata from the provided UIViewRoot
.
Return a Stream
possibly lazily populated by walking the resource tree rooted at a given initial path.
Return a Stream
possibly lazily populated by walking the resource tree rooted at a given initial path.
The default behavior of this method is to call
ResourceHandler.getViewResources(FacesContext, String, int, ResourceVisitOption...)
on the wrapped
ResourceHandler
object.
The default behavior of this method is to call
ResourceHandler.getViewResources(FacesContext, String, ResourceVisitOption...)
on the wrapped
ResourceHandler
object.
FacesContext.getViewRoot()
on the wrapped FacesContext
object.
Return a Stream
possibly lazily populated by walking the view trees of every active
ViewDeclarationLanguage
rooted at a given initial path.
Return a Stream
possibly lazily populated by walking the view trees of every active
ViewDeclarationLanguage
rooted at a given initial path.
ViewHandler.getViews(FacesContext, String, ViewVisitOption...)
on the wrapped ViewHandler
object.ViewHandler.getViews(FacesContext, String, int, ViewVisitOption...)
on the wrapped ViewHandler
object.Return an immutable data structure containing all of the view nodes declared for this flow.
Return a Stream
possibly lazily populated by walking the view tree rooted at a given initial path.
Return a Stream
possibly lazily populated by walking the view tree rooted at a given initial path.
Convenience method to return the view state as a String
with no RenderKit
specific markup.
The default behavior of this method is to call StateManager.getViewState(jakarta.faces.context.FacesContext)
on the wrapped StateManager
object.
String
without any markup related to the rendering technology supported
by this ResponseStateManager.Iterator
over the namespace prefix
String
s visible to this element.
Return a new VisitContext
instance.
Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver
implementation.
warnClass
property.warnClass
property.warnStyle
property.warnStyle
property.
If the value returned from this method is used as the file
argument to the four-argument constructor for
java.net.URL
(assuming appropriate values are used for the first three arguments), then a client making
a push handshake request to the toExternalForm()
of that URL
will select the argument
channel
for connecting the websocket push channel in the current view.
ViewHandler.getWebsocketURL(FacesContext, String)
on the
wrapped ViewHandler
object.width
property.width
property.width
property.Work
instance which is the cause of the event.WorkContexts
that needs to be used by the
WorkManager
to set up the execution context while executing
a Work
instance.WorkManager
instance.If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
A class that implements this interface uses this method to return an instance of the class being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
DataModel
, if any.DataModel
, if any.
Return a Method
for the setter of the property with name given by argument name
.
PrintWriter
object that can send character text to the client.XAResource
to the caller.javax.transaction.xa.XAresource
instance.XATerminator
instance.xmlns
property.xmlns
property.ZonedDateTime
that is supplied to the
getNextRunTime
and
skipRun
methods.ZonedDateTime
that is supplied to the
getNextRunTime
and
skipRun
methods.java.util.stream.Collector
that implements a "group by" operation on the
input JsonValue
elements.java.util.stream.Collector
that implements a "group by" operation on the
input JsonValue
elements.
Take action to handle the Exception
instances residing inside the ExceptionQueuedEvent
instances
that have been queued by calls to Application().publishEvent(ExceptionQueuedEvent.class,
eventContext)
.
ExceptionHandler.handle()
on the wrapped
ExceptionHandler
object.HandleDelegate
interface is implemented by the enterprise bean container.handleFault
method is invoked for fault message
processing.handleMessage
method is invoked for normal processing
of inbound and outbound messages.FacesContext
, plus the outcome string returned by an executed application action.
Overloaded variant of
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)
that allows the
caller to provide the defining document id for a flow to be entered by this navigation.
Handler
interface
is the base interface for Jakarta XML Web Services handlers.This method specifies the contract for satisfying resource requests.
The default behavior of this method is to call
ResourceHandler.handleResourceRequest(jakarta.faces.context.FacesContext)
on the wrapped
ResourceHandler
object.
HandlerResolver
is an interface implemented
by an application to get control over the handler chain
set on proxy/dispatch objects at the time of their creation.Instance.Handle
objects.ServletContainerInitializer
can handle.
Test if this navigation case has an associated <if>
element.
true
if the executable parameters are constrained either:
because of a constraint on at least one of the parameters
because of a cascade on at least one of the parameters (via
Valid
)
because of at least one cross-parameter constraint
true
if the executable return value is constrained
either:
because of a constraint on the return value
because validation is cascaded on the return value (via
Valid
)
true
if at least one constraint declaration
matching the restrictions is present on the element,
false
otherwise.false
.SOAPFault
has a Detail
subelement and false otherwise.SOAPFault
object exists in this
SOAPBody
object.ActivationDataFlavor
.Expression
.Overrides the default hash code method to take the minimum and maximum into account when generating the hash code.
JsonNumber
object.JsonString
object.name
.
Utility method to determine if the the provided UIViewRoot
has metadata.
true
if there are more parsing states.true
if the property with the given name is registered in the current request/response exchange
context, or false
if there is no property by that name.true
if the property with the given name is registered in the current request/response exchange
context, or false
if there is no property by that name.true
if the property with the given name is registered in the current request/response exchange
context, or false
if there is no property by that name.HttpHeaders.RETRY_AFTER
retry the request.value
member.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String>
causes the map returned from ExternalContext.getRequestHeaderMap()
to
be injected as the value of that field.
Supports inline instantiation of the HeaderMap
qualifier.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String[]>
causes the map returned from
ExternalContext.getRequestHeaderValuesMap()
to be injected as the value of that field.
Supports inline instantiation of the HeaderValuesMap
qualifier.
XmlAdapter
for xs:hexBinary
.WorkContext
that allows a Work
instance to propagate quality-of-service (QoS) hints about the Work
to the WorkManager
.T
.null
value.host
to be used.host
to be used.RenderKit
instance for this Jakarta Faces implementation.table
element.input
element for a button of type submit
or reset
.a
element for a hyperlink that acts like a submit button.script
element for a function that acts like an ajax form submit.table
element.form
element.img
element, used to retrieve and render a graphical image.input
element of type file
.input
element of type hidden
.input
element of type password
.input
element of type text
.textarea
element.rendererType
property must be set to "jakarta.faces.Message
".rendererType
property must be set to "jakarta.faces.Messages
".input
element of type "button" or image that may be used to link to a URL handled by
the Faces Servlet resolved preemptively using the logical outcome defined by the outcome
property.a
(hyperlink) element that may be used to link to a URL handled by the Faces Servlet
resolved preemptively using the logical outcome defined by the outcome
property.MessageFormat
pattern string and substitutes in parameter values from nested UIParameter
components, and renders the result.label
element, used to define an accessible label for a corresponding input element.a
(hyperlink) element that may be used to link to an arbitrary URL defined by the
value
property.span
element if I18N attributes, CSS
styles or style classes are specified.input
element of type
checkbox
.input
elements of type checkbox
.select
element, showing either all
available options or the specified number of options.select
element, showing a single
available option at a time.select
element, showing either all
available options or the specified number of options.select
element, showing a single
available option at a time.input
elements of type radio
.HttpAuthenticationMechanism
is a mechanism for obtaining a caller's
credentials in some way, using the HTTP protocol where necessary.HttpAuthenticationMechanism
interface that
can be subclassed by developers wishing to provide extra or different
functionality.HTTPBinding
interface is an
abstraction for the XML/HTTP binding.ServletSecurity
annotation to represent the security constraints to be
applied to all HTTP protocol methods for which a corresponding HttpMethodConstraint
element does NOT occur
within the ServletSecurity
annotation.HttpConstraint
annotation value.HttpHandler
which is invoked to handle requests
destined for that path on the associated container.HTTPException
exception represents a
XML/HTTP fault.HttpMessageContext
contains all of the per-request state information and encapsulates the client request,
server response, container handler for authentication callbacks, and the subject representing the caller.ServletSecurity
annotation to represent security constraints on specific
HTTP protocol messages.HttpMethodConstraint
annotation value.HttpConstraintElement
value.HttpConstraintElement
value.HttpServlet
for the current HttpServletRequest
was invoked.ServletRequest
interface to provide request information for HTTP servlets.ServletResponse
interface to provide HTTP-specific functionality in sending a response.HttpSessionBindingListener
when it is bound
or unbound from a session, or to an HttpSessionAttributeListener
that has been configured in the deployment
descriptor when any attribute is bound, unbound or replaced in a session.PassivationCapable
and its Id for passivation.Set the defining document id and flow id of this flow.
IdentifiableType
represent entity or
mapped superclass types.ManagedTask.getExecutionProperties()
or
ContextService.createContextualProxy()
to provide a String that identifies the task.IdentityStore
is a mechanism for validating a caller's credentials
and accessing a caller's identity attributes.IdentityStoreHandler
is a mechanism for validating a caller's
credentials, and accessing a caller's identity attributes, by consulting
a set of one or more IdentityStore
s.
Customize this MetaRuleset
instance to advise it to ignore the attribute named by the
attribute
argument, returning this
.
Customize this MetaRuleset
instance to advise it to ignore all attributes, returning this
.
MimeMultipart.initializeProperties()
method called from
constructors and the parse method.InterceptionFactory.createInterceptedInstance(Object)
.MimeMultipart.initializeProperties()
method called from
constructors and the parse method.MimeMultipart.initializeProperties()
method called from
constructors and the parse method.META-INF/validation.xml
file if this
method is called.Dependent
.IllegalStateException
with the specified reason, error code
and linked exception.IllegalStateException
with the specified reason and error code.IllegalStateException
with the specified reason.IllegalStateException
is thrown from a method if the callee (resource
adapter or application server for system contracts) is in an illegal or
inappropriate state for the method invocation.IllegalStateRuntimeException
to be thrown.IllegalStateRuntimeException
with the specified detail messageIllegalStateRuntimeException
with the specified detail message and error code.IllegalStateRuntimeException
with the specified detail message, error code and cause
The presence of an entry under this key in the Map
returned from ExceptionQueuedEventContext.getAttributes()
indicates the
event occurred during the “after phase” part of the current lifecycle phase.
The presence of an entry under this key in the Map
returned from ExceptionQueuedEventContext.getAttributes()
indicates the
event occurred during the “before phase” part of the current lifecycle phase.
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow.
include
is storedHttpServletMapping
of the target of an
include
is storedinclude
is storedinclude
is storedinclude
is storedinclude
is storedInclude another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in Jakarta Server Pages)
Include another Facelet defined at some path, absolute to this ClassLoader/OS
Indicates the current redirect should include view parameters.
List
, Map
or
Optional
.List
, Map
or
Optional
.java.util.List
interface.ClassInfo
corresponding to this transformed class.DeclarationInfo
corresponding to this transformed declaration.FieldInfo
corresponding to this transformed field.AnnotationTarget
(which is most likely
a DeclarationInfo
).BeanInfo
.ObserverInfo
.MethodInfo
corresponding to this transformed method.ParameterInfo
corresponding to this transformed method parameter.create<METHOD>
method of an
adapted home or local home interface (an interface that adapts an enterprise bean 2.1 or earlier EJBHome or
EJBLocalHome client view respectively).super.init(config)
.super.init(config)
.cause
field of this SOAPException
object with the given Throwable
object.ConstraintValidator.isValid(Object, ConstraintValidatorContext)
calls.Initialized
qualifier.A MethodExpression that will be invoked when the flow is entered.
A MethodExpression that will be invoked when the flow is entered.
Implementation of PartialStateHolder.initialStateMarked()
.
Return true
if delta state changes are being tracked, otherwise false
An implementation of PartialStateHolder.initialStateMarked()
, this method is called by the runtime to test if
the PartialStateHolder.markInitialState()
method was called.
The presence of this annotation (along with @Inject
) on a field of type Map<String,
String>
causes the map returned from ExternalContext.getInitParameterMap()
to
be injected as the value of that field.
Supports inline instantiation of the InitParameterMap
qualifier.
ViewHandler.initView(jakarta.faces.context.FacesContext)
on the wrapped ViewHandler
object.InjectionPoint
instance.InjectionTargetFactory
can create an InjectionTarget
for a given bean.Inject
annotation.Called by the flow system to cause the flow to be inspected for navigation rules.
ApplicationMap
qualifier.FacesConfig
qualifier.FlowMap
qualifier.HeaderMap
qualifier.HeaderValuesMap
qualifier.InitParameterMap
qualifier.ManagedProperty
qualifier.RequestCookieMap
qualifier.RequestMap
qualifier.RequestParameterMap
qualifier.RequestParameterValuesMap
qualifier.SessionMap
qualifier.View
qualifier.ViewMap
qualifier.FacesBehavior
qualifier.FacesConverter
qualifier.WebsocketEvent.Closed
qualifier.WebsocketEvent.Opened
qualifier.FlowBuilderParameter
qualifier.FlowDefinition
qualifier.FacesDataModel
qualifier.Push
qualifier.FacesValidator
qualifier.AutoApplySession
Interceptor Binding.LoginToContinue
Interceptor Binding.RememberMe
Interceptor Binding.FacesMessage
to be created if the conversion to
Integer
fails.Converter
implementation for java.lang.Integer
(and int primitive) values.jakarta.resource.cci.Interaction
enables a component to
execute EIS functions.InterceptionFactory
allows to create a wrapper instance whose method invocations are intercepted by method
interceptors and forwarded to a provided instance.MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream)
and MessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)
.@Interceptor
.interfaceName
as the
wsam:InterfaceName
element in the
wsa:Metadata
element.internal server
error
.int
.int
.FacesMessage
to be created if a value not matching
the available options is specified.FacesMessage
to be created if a value not matching
the available options is specified.Invalidates this session then unbinds any objects bound to it.
ExternalContext.invalidateSession()
on the wrapped
ExternalContext
object.InvalidClientIDException
with the specified reason, error code
and linked exception.InvalidClientIDException
with the specified reason and error code.InvalidClientIDException
with the specified reason.InvalidClientIDException
to be thrown.InvalidClientIDRuntimeException
with the specified detail messageInvalidClientIDRuntimeException
with the specified detail message and error code.InvalidClientIDRuntimeException
with the specified detail message, error code and causeInvalidDestinationException
with the specified reason, error code
and linked exception.InvalidDestinationException
with the specified reason and error code.InvalidDestinationException
with the specified reason.InvalidDestinationException
to be thrown.InvalidDestinationRuntimeException
with the specified detail messageInvalidDestinationRuntimeException
with the specified detail message and error code.InvalidDestinationRuntimeException
with the specified detail message, error code and causeInvalidSelectorException
with the specified reason, error code
and linked exception.InvalidSelectorException
with the specified reason and error code.InvalidSelectorException
with the specified reason.InvalidSelectorException
to be thrown.InvalidSelectorRuntimeException
with the specified detail messageInvalidSelectorRuntimeException
with the specified detail message and error code.InvalidSelectorRuntimeException
with the specified detail message, error code and causenull
, invoke the method, with the given parameters on this bean.method
on the given base
object by querying all
component resolvers.method
on the given base
object.UIComponent.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)
and must be passed the
component with the clientId
given as an argument to invokeOnComponent
.
This method will be called by an implementation of SearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String)
with the resolved component
for the keyword.
Resolves multiple UIComponent
s for the given expression.
Resolves multiple UIComponent
s for the given expression.
clientId
equal to the argument clientId
and, if found, call the
ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
method on the argument callback
, passing the current
FacesContext
and the found component as arguments.clientId
equal to the argument clientId
and, if found, call the
ContextCallback.invokeContextCallback(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent)
method on the argument callback
, passing the current
FacesContext
and the found component as arguments.UIComponentBase.invokeOnComponent(jakarta.faces.context.FacesContext, java.lang.String, jakarta.faces.component.ContextCallback)
to provide special care for positioning the data
properly before finding the component and invoking the callback on it.UIComponent.visitTree()
to visit a single component.
Marker within the FacesContext
attributes map to indicate we are marking initial state, so the
markInitialState()
method of iterating components such as UIData
could
recognize this fact and save the initial state of descendents.
Marker within the FacesContext
attributes map to indicate we are saving state.
Return true
if and only if the flow referenced by the argument definingDocument
and id
is
currently active.
Return true
if the request header Faces-Request
is present with the value
partial/ajax
.
PartialViewContext.isAjaxRequest()
on the wrapped
PartialViewContext
object.@Alternative
.Instance
was injected.
Return true
if this FacesListener
is an instance of a the appropriate listener class that this
event supports.
Return true
if the argument FacesListener
is an instance of the appropriate listener class that
this event supports.
true
if this FacesListener
is an instance of a listener class that this event supports.
Returns true
if and only if the argument listener
is an instance of
SystemEventListener
.
Returns true
if and only if the argument listener
is an instance of
SystemEventListener
.
true
if this FacesListener
is an instance of a
the appropriate listener class that this event supports.SecurityContext.authenticate(HttpServletRequest, HttpServletResponse, AuthenticationParameters)
autorun
property.true
if the bean involves validation:
a constraint is hosted on the bean itself
a constraint is hosted on one of the bean properties
or a bean property is marked for cascaded validation (Valid
)
boolean
.byte
.@Valid
.char
.Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so.
Text
object represents a comment.
Return true
if component
is a composite component, otherwise false
.
From
object has been obtained as a result of
correlation (use of a Subquery
correlate
method).isShutdown()
value of the current
thread if it is a ManageableThread
created from
ManagedThreadFactory.newThread()
.true
if this attribute is to be passed a MethodExpression
so that expression
evaluation can be deferred.true
if this attribute is to be passed a ValueExpression
so that expression
evaluation can be deferred.Class
returned by the
getBeanClass
method, will be transacted or not.
Return the value of the disable
directive for this component.
Return whether or not the client window should be encoded into the target url.
Return the disabled status of this behavior.
disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.disabled
property.true
.double
.object
represents a Jakarta XML Binding element.Is the value denoting an empty value.
The default behavior of this method is to call Map.isEmpty()
on the wrapped Flash
object.
feature
instance has been previously enabled in the runtime configuration
context.feature
instance of featureClass
class has been previously enabled in the runtime
configuration context.true
if this feature is enabled.escape
property.escape
property.escape
property.
If and only if this returns true
, the code that renders this select item must escape the label using
escaping syntax appropriate to the content type being rendered.
Return true
if PartialViewContext.isAjaxRequest()
returns true
and PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME
is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS
.
PartialViewContext.isExecuteAll()
on the wrapped
PartialViewContext
object.Determines whether a cached Facelet instance exists for this URL.
final
.final
.final
.float
.true
if getAsString
should include grouping separators if necessary.true
if this cookie contains the HttpOnly
attribute.true
if Configuration.ignoreXmlConfiguration()
has been
called.ActionListener
provided by the Jakarta Faces implementation
should be executed immediately (that is, during Apply Request Values phase of the request processing
lifecycle), rather than waiting until the Invoke Application phase.Return the immediate status of this behavior.
If the value of the component's immediate
attribute is true
, the action will be invoked
during the Apply Request Values Jakarta Faces lifecycle phase.
Return false
.
Tests whether the immediate attribute is specified.
Return the <redirect>
value for this <navigation-case>
.
Return whether or not the view parameters should be encoded into the target url.
int
.true
if only the integer portion of the given value should be returned from
getAsObject()
.
Return true
if this component is within the view hierarchy otherwise false
Override superclass method to always return true
because a UIViewRoot
is defined to always be in a
view.
ismap
property.Return the value of this JavaBeans property for the flash for this session.
The default behavior of this method is to call Flash.isKeepMessages()
on the wrapped Flash
object.
Returns if the keyword was resolved.
A leaf keyword is a keyword that does not allow to be combined with keywords or id chains to the right.
true
if and only if this listener instance is interested in receiving events
from the instance referenced by the source
parameter.ExceptionHandler.isListenerForSource(Object)
on the wrapped ExceptionHandler
object.true
if and only if this listener instance is interested in receiving events
from the instance referenced by the source
parameter.FetchType.EAGER
has been specified have been loaded, this
method returns LoadState.LOADED
.LoadState.LOADED
.LoadState.LOADED
.long
.primaryType
and
subType
.primaryType
and
subType
.primaryType
and
subType
.true
if the use of MTOM is enabled.
Return the value of the multiple
property.
@Named
.Predicate.not()
method
or the CriteriaBuilder.not()
method.Determine if the passed component is not null and if it's new to the tree.
true
if the client does not yet know about the session or if the client chooses not to join the
session.true
iff this element instance content model
is nil.
Return the value of the noSelectionOption
property.
Return the value of the noSelectionOption
property.
true
if the value at the specified location in this
array is JsonValue.NULL
.true
if the associated value for the specified name is
JsonValue.NULL
.
If true
this component will operate on postback.
opened
.
Return true
PartialViewContext.isAjaxRequest()
returns true
or if the request header
Faces-Request
is present with the value partial/process
.
PartialViewContext.isPartialRequest()
on the wrapped
PartialViewContext
object.A passthrough keyword is a keyword, that according to the context, does not require to be resolved on the server, and can be passed "unresolved" to the client.
Checks if the given expression is a "passtrough expression".
boolean
indicating whether the servlet is permanently unavailable.
This utility method simply returns the result of
ResponseStateManager.isPostback(FacesContext)
.
FacesContext.isPostback()
on the wrapped FacesContext
object.
Returns true
if the current request processing lifecycle is in the midst of processing the broadcast of
an event queued during a call to UIViewAction.decode(jakarta.faces.context.FacesContext)
.
Returns a flag indicating whether or not the runtime should publish events when asked to do so.
FacesContext.isProcessingEvents()
on the
wrapped FacesContext
object.
Return true
if the current ProjectStage
as returned by the Application
instance is equal
to stage
, otherwise return false
FacesContext.isProjectStage(jakarta.faces.application.ProjectStage)
on the wrapped
FacesContext
object.ELResolver
has successfully resolved a given (base, property) pair.RxInvoker
subclass.ArrayELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.null
, returns whether a call to BeanELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.base
and property
, attempts to determine whether a call to CompositeELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.base
and property
, attempts to determine whether a call to ELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.ListELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.MapELResolver.setValue(jakarta.el.ELContext, java.lang.Object, java.lang.Object, java.lang.Object)
will always fail.instanceof
ResourceBundle
, return true
.true
if a call to
ValueExpression.setValue(jakarta.el.ELContext, java.lang.Object)
will always fail.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.readonly
property.null
, and the property matches the name of a JSP implicit object, returns
true
to indicate that implicit objects cannot be overwritten.false
since in normal usage ScopedAttributeELResolver
will handle calls to
ELResolver.isReadOnly(ELContext, Object, Object)
.false
since in normal usage ScopedAttributeELResolver
will handle calls to
ELResolver.isReadOnly(ELContext, Object, Object)
.null
, returns false
to indicate that scoped attributes are never
read-only.
Return the <redirect>
value for this <navigation-case>
.
Return the value of this property for the flash for this session.
The default behavior of this method is to call Flash.isRedirect()
on the wrapped Flash
object.
redisplay
property.component
instance (such as providers or features
) has been
previously registered in the runtime configuration context.componentClass
class has been previously registered in the
runtime configuration context.
Return a flag indicating if the resources associated with this FacesContext
instance have been released.
The default behavior of this method is to call FacesContext.isReleased()
on the wrapped FacesContext
object.
Return true
if PartialViewContext.isAjaxRequest()
returns true
and PartialViewContext.PARTIAL_RENDER_PARAM_NAME
is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS
.
PartialViewContext.isRenderAll()
on the wrapped
PartialViewContext
object.true
if this component (and its children) should be rendered during the Render Response
phase of the request processing lifecycle.
Return true
if this component should take the actions specified in the UIViewAction.decode(jakarta.faces.context.FacesContext)
method.
Return the resetValues status of this behavior.
Return true
if the incoming request has a parameter named by the value of
PartialViewContext.RESET_VALUES_PARAM_NAME
and that value is true
.
PartialViewContext.isResetValues()
on the wrapped
PartialViewContext
object.Tests whether the resetValues attribute is specified.
Instance
was injected.
Checks if the current instance of the SearchKeywordResolver
is responsible for resolving the keyword.
Returns whether the resource as identified by given resource and library name has been rendered.
The default behavior of this method is to call
ResourceHandler.isResourceRendered(FacesContext, String, String)
on the wrapped ResourceHandler
object.
Return true
if the current request is a resource request.
The default behavior of this method is to call
ResourceHandler.isResourceRequest(jakarta.faces.context.FacesContext)
on the wrapped ResourceHandler
object.
Return true
if the argument url
contains the string given by the value of the constant
ResourceHandler.RESOURCE_IDENTIFIER
, false otherwise.
The default behavior of this method is to call ResourceHandler.isResourceURL(java.lang.String)
on the wrapped
ResourceHandler
object.
Check if the current response has been committed.
ExternalContext.isResponseCommitted()
on the wrapped
ExternalContext
object.rowData
available at the current rowIndex
.true
if there is wrappedData
available, and the current value of
rowIndex
is greater than or equal to zero, and less than the length of the array.true
if there is wrappedData
available, and the current value of
rowIndex
is greater than or equal to zero, and less than the size of the list.rowData
available at the current rowIndex
.rowData
available at the current rowIndex
.true
if there is wrappedData
available, and the current value of
rowIndex
is greater than or equal to zero, and less than the size of the list.true
if there is wrappedData
available, and the result of calling
absolute()
on the underlying ResultSet
, passing the current value of rowIndex
plus one (to account for the fact that ResultSet
uses one-relative indexing), returns true
.true
if there is wrappedData
available, and the current value of
rowIndex
is zero.rowHeader
property.
Return the value of the rowStatePreserved
JavaBeans property.
StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)
on the wrapped StateManager
object.Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
The default behavior of this method is to call ExternalContext.isSecure()
on the wrapped
ExternalContext
object.
flag
argument is set in this message.flag
argument is set in this message.short
.detail
property of the associated message(s) should be displayed.detail
property of the associated message(s) should be displayed.summary
property of the associated message(s) should be
displayed.summary
property of the associated message(s) should be
displayed.newThread
method of
ManagedThreadFactory
has been marked for shut down.
If the preceding call to ResponseStateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
was stateless,
return true
.
static
.static
.submitted
property.
Return true if the target for this metadata element is an instance of the argument type
.
tooltip
property.tooltip
property.HttpServletRequest.getTrailerFields()
.
Implementation of StateHolder.isTransient()
.
Instance
was injected.true
if the currently authenticated user is included in the specified role.ExternalContext.isUserInRole(String)
on the wrapped
ExternalContext
object.
Return true
if the validationFailed()
method has been called for the current request.
FacesContext.isValidationFailed()
on the
wrapped FacesContext
object.Checks if the given expression is a valid expression.
Determines whether a cached View Metadata Facelet instance exists for this URL.
Return true
if this component should be visited, false
otherwise.
EntityTag
.ServletRequest
instance.ServletRequest
of the given class type.ServletResponse
instance.ServletResponse
of the given class type.MapMessage
object.
IterableDataModel is an implementation of DataModel
that wraps an Iterable
.
IterableDataModel
with no specified wrapped data.IterableDataModel
wrapping the specified iterable.
Return a read-only Iterator
over the row data for this model.
JsonbBuilder
objects.XmlAdapter
and its spec-defined
sub-classes to allow arbitrary Java classes to be used with Jakarta XML Binding.jakarta.xml.bind
interfaces.JAXBContext
objects.JAXBContext
class provides the client's entry point to the
Jakarta XML Binding API.JAXBContext
instances.Result
implementation
that unmarshals a Jakarta XML Binding object.Source
implementation
that marshals a Jakarta XML Binding-generated object.Source
for the given content object.Source
for the given content object.ClientBuilder
implementation to be returned from
ClientBuilder.newBuilder()
.SseEventSource.Builder
implementation to be returned from
SseEventSource.Builder.newBuilder()
.RuntimeDelegate
implementation to be returned from
RuntimeDelegate.getInstance()
.jakarta.jms.ConnectionFactory
to be
used when injecting a jakarta.jms.JMSContext
object.ConnectionFactory
resource that it requires in its operational environment.JMSConnectionFactoryDefinition
annotations.JMSConsumer
object to receive messages
from a queue or topic.JMSContext
is the main interface in the simplified Jakarta Messaging API introduced for Jakarta Messaging 2.0.Destination
resource that it requires in its operational environment.JMSDestinationDefinition
annotations.JMSException
with the specified reason, error code
and linked exception.JMSException
with the specified reason and error code.JMSException
with the specified reason and with the error code defaulting to null.jakarta.jms.JMSContext
object.JMSProducer
is a simple object used to send messages on behalf of a JMSContext
.JMSRuntimeException
with the specified detail message and error code.JMSRuntimeException
with the specified detail messageJMSRuntimeException
with the specified detail message, error code and causeJMSSecurityException
with the specified reason, error code
and linked exception.JMSSecurityException
with the specified reason and error code.JMSSecurityException
with the specified reason.JMSSecurityException
to be thrown.JMSSecurityRuntimeException
with the specified detail messageJMSSecurityRuntimeException
with the specified detail message and error code.JMSSecurityRuntimeException
with the specified detail message, error code and causejakarta.jms.JMSContext
object.JobOperator.abandon(long)
is called on a job execution which is currently running (i.e.JobOperator.restart(long, java.util.Properties)
is called on a job instance which has already completed (i.e.JobOperator.stop(long)
is called on a job instance which is not currently running.ResourceHandler.FACES_SCRIPT_LIBRARY_NAME
instead.ResourceHandler.FACES_SCRIPT_RESOURCE_NAME
instead.JsonArray
represents an immutable JSON array
(an ordered sequence of zero or more values).JsonArray
models from scratch, and for
modifying a existing JsonArray
.Jsonb
provides an abstraction over the JSON Binding framework operations:JsonbTypeInfo
.JsonObjectBuilder
and JsonArrayBuilder
instances.java.util.stream.Collector
for accumulating
JsonValue
s into JsonArray
and JsonObject
.JsonConfig.KEY_STRATEGY
.JsonException
indicates that some exception happened during
JSON processing.JsonGenerationException
indicates an incorrect JSON is
being generated.JsonGenerator
instances.JsonObject
class represents an immutable JSON object value
(an unordered collection of zero or more name/value pairs).JsonObject
models from scratch.JsonParser
.JsonParser
instances.JsonParsingException
is used when an incorrect JSON is
being parsed.JsonReader
instances.JsonValue
represents an immutable JSON value.JsonValue
object.JsonWriter
instances.<jsp-config>
related configuration of a web application.JspContext
serves as the base class for the PageContext class and abstracts all information that is not
specific to servlets.JspException
with the specified detail message and cause.JspException
with the specified cause.<jsp-property-group>
related configuration of a web
application.
Causes a value stored with a previous call to Flash.putNow(java.lang.String, java.lang.Object)
, its Jakarta Expression Language equivalent, or to the
request Map
, to be promoted to the flash so that is available on the next traversal through the
lifecycle on this session.
The default behavior of this method is to call Flash.keep(String)
on the wrapped Flash
object.
The default behavior of this method is to call Map.keySet()
on the wrapped Flash
object.
The prefix to identify a keyword.
ValueExpression
.Variant.VariantListBuilder
initialized with a set of supported languages."Last-Event-ID"
HTTP request header name as defined by
SSE specification.end
parameter in getMessagesByUID(start, end)
, to denote the
UID of the last message in the folder.ConnectionManager
implementation.ConnectionManager
implementation.ManagedConnection
implementation.IdentityStore
that stores
caller credentials and identity attributes (together caller identities) in an
LDAP store, and make that implementation available as an enabled CDI bean.Validator
that checks the number of
characters in the String representation of the value of the associated component.Validator
with no preconfigured limits.Validator
with the specified preconfigured limit.Validator
with the specified preconfigured limits.
Return true
if the resource library named by the argument
libraryName
can be found.
The default behavior of this method is to call ResourceHandler.libraryExists(String)
on the wrapped
ResourceHandler
object.
LifecycleFactory
class name.Lifecycle
instance to be utilized.Lifecycle
instances.If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
If this lifecycle has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
ListAttribute
represent persistent
java.util.List
-valued attributes.DataModel
that wraps an List
of Java objects.ListDataModel
with no specified wrapped data.ListDataModel
wrapping the specified list.List
.ListELResolver
.ListELResolver
whose read-only status is determined by the given parameter.
Classes tagged with this annotation are installed as listeners using the method
Application.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Class<?>, jakarta.faces.event.SystemEventListener)
or
UIComponent.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, jakarta.faces.event.ComponentSystemEventListener)
(depending on the circumstances, described below).
Container annotation to specify multiple ListenerFor
annotations on a single class.
ListJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.List
.ProviderUtil
SPI methods.
The name of a key within the application message bundle named by the return from Application.getMessageBundle()
whose value is the locale prefix used to find a packaged resource to return from ResourceHandler.createResource(java.lang.String)
(or one of
its variants).
LocalTransactionException
represents various
error conditions related to the local transaction management contract.An object that represents the Location of a tag or attribute of a tag in a View Declaration Language file.
LockModeType
argument to one of the EntityManager
methods that take locks
(lock
, find
, or refresh
) or
to the Query.setLockMode()
or
TypedQuery.setLockMode()
method.LockTimeoutException
exception
with null
as its detail message.LockTimeoutException
exception
with the specified detail message.LockTimeoutException
exception
with the specified detail message and cause.LockTimeoutException
exception
with the specified cause.LockTimeoutException
exception
with the specified object.LockTimeoutException
exception
with the specified detail message, cause, and entity.ExternalContext.log(String)
on the wrapped
ExternalContext
object.ExternalContext.log(String, Throwable)
on the wrapped
ExternalContext
object.Throwable
exception to the servlet log file,
prepended by the servlet's name.Throwable
exception to the servlet log file.LogicalHandler
extends
Handler to provide typesafety for the message context parameter.LogicalMessage
interface represents a
protocol agnostic XML message and contains methods that
provide access to the payload of the message.LogicalMessageContext
interface extends
MessageContext
to
provide access to a the contained message as a protocol neutral
LogicalMessageServletContext
.LoginToContinue
annotation provides an application the ability to declaratively
add login to continue functionality to an authentication mechanism.null
as the value returned when getUserPrincipal
, getRemoteUser
, and
getAuthType
is called on the request.LogoutDefinition
annotation defines logout and RP session management
configuration in openid connect client.FacesMessage
to be created if the conversion to
Long
fails.Converter
implementation for java.lang.Long
(and long primitive) values.Validator
that checks the value
of the corresponding component against specified minimum and maximum values.Validator
with no preconfigured limits.Validator
with the specified preconfigured limit.Validator
with the specified preconfigured limits.ManagedTask.getExecutionProperties()
or
ContextService.createContextualProxy()
to provide hint about whether the task could take a long time to complete.long
.long
.java:
namespace.MailcapRegistry
.MailSession
to be registered with JNDI.MailSessionDefinition
annotations.ThreadFactory.newThread(java.lang.Runnable)
.ManagedExecutorService
to be registered in JNDI by the container
under the JNDI name that is specified in the
ManagedExecutorDefinition.name()
attribute.ManagedExecutorDefinition
annotations on the same type.ExecutorService
.
The presence of this annotation (along with @Inject
) on a field of any type causes the value returned from
evaluating an expression language expression to be injected as the value of that field.
Supports inline instantiation of the ManagedProperty
qualifier.
ManagedScheduledExecutorService
to be registered in JNDI by the container
under the JNDI name that is specified in the
ManagedScheduledExecutorDefinition.name()
attribute.ManagedScheduledExecutorDefinition
annotations on the same type.ScheduledExecutorService
.Runnable
object that also implements ManagedTask
interface so it can receive notification of lifecycle events with the
provided ManagedTaskListener
when the task is submitted
to a ManagedExecutorService
or a ManagedScheduledExecutorService
.Runnable
object that also implements ManagedTask
interface so it can receive notification of lifecycle events with the
provided ManagedTaskListener
and to provide additional execution
properties when the task is submitted to a ManagedExecutorService
or a
ManagedScheduledExecutorService
.Callable
object that also implements ManagedTask
interface so it can receive notification of lifecycle events with the
provided ManagedTaskListener
when the task is submitted
to a ManagedExecutorService
or a ManagedScheduledExecutorService
.Callable
object that also implements ManagedTask
interface so it can receive notification of lifecycle events with the
provided ManagedTaskListener
and to provide additional execution
properties when the task is submitted to a ManagedExecutorService
or a
ManagedScheduledExecutorService
.ManagedExecutorService
or
ManagedScheduledExecutorService
can optionally implement this
interface to provide identifying information about the task, to provide
a ManagedTaskListener
to get notification of lifecycle events of
the task, or to provide additional execution properties.ThreadFactory
.ManagedThreadFactory
to be registered in JNDI by the container
under the JNDI name that is specified in the
ManagedThreadFactoryDefinition.name()
attribute.ManagedThreadFactoryDefinition
annotations on the same type.ManagedType
represent entity, mapped
superclass, and embeddable types.MapAttribute
represent
persistent java.util.Map
-valued attributes.Map
.MapELResolver
.MapELResolver
whose read-only status is determined by the given parameter.MapJoin
interface is the type of the result of
joining to a collection over an association or element
collection that has been specified as a java.util.Map
.java.util.Map
when the map key is itself the primary
key or a persistent field or property of the entity that is
the value of the map.java.util.Map
.Date
and Calendar
.MapMessage
object is used to send a set of name-value pairs.jakarta.resource.cci.MappedRecord
is
used for key-value map based representation of record elements.MappedSuperclassType
represent mapped
superclass types.ManyToOne
or
OneToOne
relationship attribute that provides the
mapping for an EmbeddedId
primary key, an attribute within
an EmbeddedId
primary key, or a simple primary key of
the parent entity.mark
method of InputStream
.Mark this node as the start node in the flow.
Implementation of PartialStateHolder.markInitialState()
.
The runtime must ensure that the PartialStateHolder.markInitialState()
method is called on each instance of this interface in the
view at the appropriate time to indicate the component is in its initial state.
An implementation of PartialStateHolder.markInitialState()
, this method is called by the runtime to indicate
that the instance should start tracking changes to its state.
For each of the attached objects on this instance that implement PartialStateHolder
, call
PartialStateHolder.markInitialState()
on the attached object.
Override the base class method to take special action if the method is being invoked when
StateManager.IS_BUILDING_INITIAL_STATE
is true and the rowStatePreserved
JavaBeans property for this instance is true
.
UIOutput
when PartialStateHolder.markInitialState()
is called,
check if any of the installed Validator
s are PartialStateHolders and if so, call
PartialStateHolder.markInitialState()
as appropriate.UIComponentBase
when PartialStateHolder.markInitialState()
is
called, check if the installed Converter
is a PartialStateHolder and if it is, call
PartialStateHolder.markInitialState()
on it.Mark the resource as identified by given resource and library name as rendered.
The default behavior of this method is to call
ResourceHandler.markResourceRendered(FacesContext, String, String)
on the wrapped ResourceHandler
object.
mark
and reset
methods.Link
into a Link.JaxbLink
.jaxbElement
into the specified
javax.xml.transform.Result
.jaxbElement
into an output stream.jaxbElement
into a file.jaxbElement
into a Writer.jaxbElement
into SAX2 events.jaxbElement
into a DOM tree.jaxbElement
into a
XMLStreamWriter
.jaxbElement
into a
XMLEventWriter
.Marshaller
class is responsible for governing the process
of serializing Java content trees back into XML data.Marshaller
to externally listen
for marshal events.FacesMessage
to be created if the act of matching the
value against the pattern returned from RegexValidator.getPattern()
fails because of a PatternSyntaxException
.WebTarget
instance by appending a matrix parameter to the existing set of matrix parameters of
the current final segment of the URI of the current target instance.Max
annotations on the same element.FacesMessage
to be created if the maximum value check
fails.FacesMessage
to be created if the maximum length
check fails.FacesMessage
to be created if the maximum value check
fails.MediaType
with the supplied type, subtype and parameters.MediaType
with the supplied type and subtype.MediaType
with the supplied type, subtype and "charset"
parameter.MediaType
, both type and subtype are wildcards.media type
of the event data.Variant.VariantListBuilder
initialized with a set of supported media types.name
, whose value is given value
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.name
.Message
interface is the root interface of all Jakarta Messaging messages.FacesMessage
to be created if a constraint failure is
found.true
for
outbound messages, false
for inbound.DataSources
to
supply information to a DataContentHandler
about the
message context in which the data content object is operating.MessageConsumer
object to receive messages from a destination.MessageContext
abstracts the message
context that is processed by a handler in the handle
method.MessageCountAdapter
.StreamMessage
or
BytesMessage
is being read.MessageEOFException
with the specified reason, error code
and linked exception.MessageEOFException
with the specified reason and error code.MessageEOFException
with the specified reason.SOAPMessage
objects.MessageFormatException
with the specified reason, error code
and linked exception.MessageFormatException
with the specified reason and error code.MessageFormatException
with the specified reason.MessageFormatException
to be thrown.MessageFormatRuntimeException
with the specified detail messageMessageFormatRuntimeException
with the specified detail message and error code.MessageFormatRuntimeException
with the specified detail message, error code and causeValidator
.MessageListener
object is used to receive asynchronously delivered messages.MessageNotReadableException
with the specified reason, error code
and linked exception.MessageNotReadableException
with the specified reason and error code.MessageNotReadableException
with the specified reason.MessageNotWriteableException
with the specified reason, error code
and linked exception.MessageNotWriteableException
with the specified reason and error code.MessageNotWriteableException
with the specified reason.MessageNotWriteableRuntimeException
with the specified reason and error code.MessageNotWriteableRuntimeException
with the specified reason.MessageNotWriteableRuntimeException
with the specified detail message, error code and causeMessageProducer
object to send messages to a destination.There are concrete subclasses within the implementation that map concepts in the Facelet VDL page to Jakarta Server Faces Java API calls the appropriate instances.
metadataElement
to the
W3CEndpointReference
instance's
wsa:Metadata
element.The root class of the abstraction that dictates how attributes on a markup element in a Facelets VDL page are wired to the Jakarta Faces API object instance associated with that element.
A mutable set of rules to be used in auto-wiring state to a particular object instance.
Every kind of markup element in Facelets VDL that has attributes that need to take action on a Jakarta Faces Java API artifact is associated with an instance of this class.
Create a method call node in the current Flow
.
Define a method call node.
Represents a method call node in the flow graph.
Expression
that refers to a method on an object.ValueChangeListener
that
contains a MethodExpression
.Validator
that wraps a
MethodExpression
, and it performs validation by executing a method on an object identified by the
MethodExpression
.Validator
that contains a MethodExpression
.ValueChangeListener
that contains a
MethodExpression
.To accommodate method expression targets that take no
arguments instead of taking a ValueChangeEvent
argument, the implementation of this class must take
the argument methodExpressionOneArg
, extract its expression string, and create another
MethodExpression
whose expected param types match those of a zero argument method.ValueChangeListener
that contains a MethodExpression
.MethodExpression
evaluated to.MethodInfo
with the given information.MethodExpression
.MethodNotFoundException
with no detail message.MethodNotFoundException
with the provided detail message.MethodNotFoundException
with the given root cause.MethodNotFoundException
with the given detail message and root cause.MethodConfig
objects for each method of this class,
as defined by ClassInfo.methods
.java.lang.Object
,
as well as all direct and indirect superinterfaces.MimeHeader
object initialized with the given
name and value.MimeHeader
objects, which represent
the MIME headers present in a MIME part of a message.MimeHeaders
object initialized with
an empty Vector
object.source
MimeMessage.MimeTypeEntry
MimeTypeRegistry
.Min
annotations on the same element.FacesMessage
to be created if the minimum value check
fails.FacesMessage
to be created if the minimum length
check fails.FacesMessage
to be created if the minimum value check
fails.int
.int
.int
.MTOMFeature
.MTOMFeature
.MTOMFeature
.MTOMFeature
.String
constant representing "multipart/form-data" media type.MediaType
constant representing "multipart/form-data" media type.Servlet
class, indicating that instances of the
Servlet expect requests that conform to the multipart/form-data MIME type.MultipartConfig
annotation value.MultipartConfig
annotation value.DataSource
that contains body
parts.MultivaluedMap
interface.16
) and the default load factor
(0.75
).0.75
).MultivaluedMap
.Map
.Class.getName()
.Class.getName()
.Class.getName()
.Package.getName()
.void
pseudo-type, that is, the string void
.NamedAttributeNode
is a member element of a
NamedEntityGraph
.NamedEntityGraph
annotations.
The presence of this annotation on a class automatically registers the class with the runtime as a
ComponentSystemEvent
for use with the <f:event />
tag in a page.
Named
qualifier.NamedSubgraph
is a member element of a
NamedEntityGraph
.
Components that declare a createTag = true
attribute will be placed into this tag namespace if the
namespace attribute is omitted.
UIComponent
that wants to be a naming container.
NavigationCase represents a <navigation-case>
in
the navigation rule base, as well as the <from-view-id>
with
which this <navigation-case>
is a sibling.
Construct a new NavigationCase
based on the provided arguments.
Construct a new NavigationCase
based on the provided arguments.
Define a particular combination of conditions that must match for this case to be executed, and the view id of the component tree that should be selected next.
Create a navigation case in the current Flow
.
Allows populating the redirect with parameters and setting the includeViewParams option.
Provides a simple implementation of NavigationCase
that can be
subclassed by developers wishing to provide specialized behavior to an existing NavigationCase
instance.
If this navigation case has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
NavigationHandlerWrapper provides a simple implementation of
NavigationHandler
that can be subclassed by developers wishing to provide specialized behavior to an existing
NavigationHandler
instance.
If this navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Negative
constraints on the same element.NegativeOrZero
constraints on the same element.JsonbBuilder
instance as returned by the default
JsonbProvider.provider()
method.JsonbBuilder
instance as returned by
JsonbProvider.provider(String)
method.JsonbBuilder
instance as returned by
provider#create
call.ClientBuilder
instance using the default client builder implementation class provided by the
JAX-RS implementation provider.Client
instance using the default client builder implementation class provided by the JAX-RS
implementation provider.Client
instance using the default client builder implementation class provided
by the JAX-RS implementation provider.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.Builder
instead.NewCookie.AbstractNewCookieBuilder
instance.NewCookie
builder class.NewCookie
builder class.SameSite
cookie attribute.OutboundSseEvent
from provided data.OutboundSseEvent
from provided data and name.CompletableFuture
.ExpressionFactory
.ExpressionFactory
, with optional properties.SeContainerInitializer
Each call returns a new instanceCreate a Facelet or View Metadata Facelet (depending on the type of factory this is) for the argument URL.
JAXBContext
class.JAXBContext
class.JAXBContext
class.JAXBContext
class.JAXBContext
class.MessageFactory
object that is an instance
of the default implementation (SOAP 1.1).MessageFactory
object that is an instance
of the specified implementation.SOAPConnectionFactory
object.SOAPFactory
object that is an instance of
the default implementation (SOAP 1.1).SOAPFactory
object that is an instance of
the specified implementation, this method uses the SAAJMetaFactory to
locate the implementation class and create the SOAPFactory instance.MessageFactory
object for
the given String
protocol.PushBuilder
for issuing server push responses from the current request.SOAPFactory
object for
the given String
protocol.start
(inclusive)
up to end
(exclusive).start
(inclusive)
up to end
(exclusive).start
(inclusive)
up to end
(exclusive).
A reference to the FaceletHandler
that represents the first nested child of this TagHandler
instance.
XmlSchema.location()
attribute,
which indicates that the schema generator will generate
components in this namespace.MessageBodyReader
implementations when reading a zero-length
message content to indicate that the message body reader is not able to produce an instance representing an
zero-length message content.NoContentException
instance.NoContentException
instance.NoContentException
instance.Base interface for building all kinds of flow nodes.
The value of this constant is taken to be the name of a request parameter whose value is inspected to verify the
safety of an incoming non-postback request with respect to the currently configured Set
of protected
views for this application.
Nonbinding
annotation.Query.getSingleResult()
or TypedQuery.getSingleResult()
is executed on a
query and there is more than one result from the query.NonUniqueResultException
exception
with null
as its detail message.NonUniqueResultException
exception
with null
as its detail message.NonUniqueResultException
exception
with the specified detail message.NonUniqueResultException
exception
with the specified detail message.Query.getSingleResult()
or TypedQuery.getSingleResult()
is executed on a query
and there is no result to return.NoResultException
exception with
null
as its detail message.NoResultException
exception with the
specified detail message.XmlAdapter
to handle xs:normalizedString
.FacesMessage
to be created if the maximum or minimum
value check fails, and both the maximum and minimum values for this validator have been set.FacesMessage
to be created if the maximum or minimum
value check fails, and both the maximum and minimum values for this validator have been set.FacesMessage
to be created if the act of matching the
value against the pattern returned from RegexValidator.getPattern()
fails because the value does not match the pattern.not
acceptable
by the server.not allowed
.null
and must contain at least one
non-whitespace character.@NotBlank
constraints on the same element.null
nor empty.@NotEmpty
constraints on the same element.not found
on the server.SecurityContext.isCallerInRole(String)
etc.SecurityContext.isCallerInRole(String)
etc.CredentialValidationResult
result of an
identity store directly on to the container.null
.NotNull
annotations on the same element.NotSupportedException
is thrown to indicate that
callee (resource adapter
or application server for system contracts) cannot execute an operation
because the operation is not a supported feature.not supported
.null
.Null
annotations on the same element.
Components that are rendered by Renderers
of component-family jakarta.faces.OutcomeTarget
must use this constant as the value of the parameter named by FlowHandler.TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME
when
returning from a flow (without entering another flow) using such a component.
Because null
values are not allowed as the source for subclasses of EventObject
, such as
PostKeepFlashValueEvent
and PostPutFlashValueEvent
, this value is substituted for null
as the source in the case when a null
value is put to or kept in the flash.
FacesMessage
to be created if the conversion to
Number
fails.
Indicate the max number of ClientWindows, which is used by ClientWindowScoped
.
Converter
implementation for java.lang.Number
values.Number
object.ObjectMessage
object is used to send a message that contains a serializable object in the Java programming
language ("Java object").ObserverMethodConfigurator
can configure an ObserverMethod
.AnnotationBuilder
that builds an annotation of given type.AnnotationBuilder
that builds an annotation of given type.LoginToContinue
Interceptor Binding.RememberMe
Interceptor Binding.ArrayType
for the given element type and number of dimensions.ClassType
for the given binary name, as defined by The Java™ Language Specification;
in other words, the class name as returned by Class.getName()
.ClassType
for the given class declaration.PrimitiveType
for the given kind of primitive type.VoidType
, representing the void
pseudo-type.SseEventSink
or
tries to write to a given SseEventSink
that is already closed (either by client closing the connection
or by calling SseEventSink.close()
on the server side.exception mapper
has been found for a request processing failure.This method is guaranteed to be called after the component has been created but before it has been populated with children.
This method is guaranteed to be called after the component has been populated with children.
ReadListener
is registered with a ServletInputStream
, this method will
be invoked by the container the first time when it is possible to read data.SseEventSink
when this SseBroadcaster tries to write to it or close it.ServletRequest.startAsync()
methods.ServletOutputStream
, this method will be invoked
by the container the first time when it is possible to write data.web target
and start processing incoming
events
.OpenIdProviderMetadata
annotation overrides the openid connect
provider's endpoint value, discovered using providerUri.OptimisticLockException
exception with
null
as its detail message.OptimisticLockException
exception with the
specified detail message.OptimisticLockException
exception with the
specified detail message and cause.OptimisticLockException
exception with the
specified cause.OptimisticLockException
exception with the
specified entity.OptimisticLockException
exception with the
specified detail message, cause, and entity.ServletContext
attribute whose value (of type
java.util.List<java.lang.String>
) contains the list of names of JAR files in
WEB-INF/lib
ordered by their web fragment names (with possible exclusions if
<absolute-ordering>
without any <others/>
is being used), or null if no
absolute or relative ordering has been specifiedDefine an outbound parameter for the flow call.
Define an outbound parameter for the flow call.
OutboundSseEvent
instances.OverridesAttribute
annotations on the same elementpackage-info.java
.String
form of a message parameter
value and the corresponding custom Java type T
.default value
delegated to a parameter
converter
annotated with @Lazy
annotation SHOULD occur only once the value is actually required (e.g.ParamConverter
instances.Creates a Parameter instance.
Add a parameter to the redirect.
Represents a parameter in any of several places where parameters are needed when processing flows.
ParameterizedType
for the given generic type and type arguments.ParameterizedType
for the given generic type and type arguments.ParameterizedType
for the given generic type and type arguments.Validator
.ParameterConfig
objects for each parameter of this method.String
-keyed parameter map.Set the parameters of the method call node.
Multipart
object containing this BodyPart
,
if known.Part
containing this Multipart
,
if known.headers
and
content
fields appropriately.Part
interface is the common base interface for
Messages and BodyParts.multipart/form-data
POST request.The request parameter name whose request parameter value identifies the type of partial event.
The request parameter name whose request parameter value is a Collection
of client identifiers
identifying the components that must be processed during the Apply Request Values, Process
Validations, and Update Model Values phases of the request processing lifecycle.
The request parameter name whose request parameter value is a Collection
of client identifiers
identifying the components that must be processed during the Render Response phase of the request processing
lifecycle.
The ServletContext
init parameter consulted by the runtime to determine if the partial state saving
mechanism should be used.
The property name for the PartialViewContextFactory
class name.
PartialResponseWriter decorates an existing ResponseWriter
to support the generation of
a partial response suitable for Ajax operations.
Create a PartialResponseWriter
.
Components that want to leverage the partial state saving feature must implement this interface instead of
implementing StateHolder
, from which this interface inherits.
PartialViewContextFactory is a factory object that creates (if needed) and
returns new PartialViewContext
instances.
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
Provides a simple implementation of
PartialViewContext
that can be subclassed by developers wishing to provide specialized behavior to an
existing PartialViewContext
instance.
If this partial view context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
PartitionReducer.afterPartitionedStepCompletion(PartitionStatus)
.Bean
or
Contextual
is passivation capable.
The key in the component passthrough attributes Map
for the localName of the element corresponding to the
component.
PasswordCredential
object from the given
user name and password.PasswordHash
is an interface for objects that can generate and verify password hashes.Past
annotations on the same element.PastOrPresent
annotations on the same element.WebTarget
instance by appending path to the URI of the current target instance.Path
-annotated method to the existing path.Optional
,
List
or Map
.ServerEndpoint
annotation.CharSequence
must match the specified regular expression.Pattern
annotations on the same element.FacesMessage
to be created if the conversion to
Number
fails.FacesMessage
to be created if the value returned from
RegexValidator.getPattern()
is null
or the empty String.Pbkdf2PasswordHash
implementation.FacesMessage
to be created if the conversion to
Number
fails.A convenience method to signal the Jakarta Faces implementation to perform navigation with the provided outcome.
EntityManagerFactory
in Java SE environments.EntityManager
and its
associated persistence context.PersistenceContext
annotations.PersistenceContext
.PersistenceException
exception
with null
as its detail message.PersistenceException
exception
with the specified detail message.PersistenceException
exception
with the specified detail message and cause.PersistenceException
exception
with the specified cause.PersistenceProviderResolver
instance.EntityManagerFactory
and its
associated persistence unit.EntityManagerFactory
.PersistenceUnit
annotations.EntityManagerFactory
will be JTA or
resource-local entity managers.PessimisticLockException
exception
with null
as its detail message.PessimisticLockException
exception
with the specified detail message.PessimisticLockException
exception
with the specified detail message and cause.PessimisticLockException
exception
with the specified cause.PessimisticLockException
exception
with the specified entity.PessimisticLockException
exception
with the specified detail message, cause, and entity.jakarta.persistence.lock.scope
property for pessimistic locking.FacesContext
.getPhaseId()
method of the FacesEvent
interface.
Return a PhaseId
representation of the arcument phase
.
PluralAttribute
represent
persistent collection-valued attributes.PluralJoin
interface defines functionality
that is common to joins to all collection types.Policy
providers.PolicyConfiguration
Interface, the PolicyConfigurationFactory
abstract class, the
PolicyContext
utility class, and implementations of the
PolicyContextException
Interface.null
as its detail message.PolicyContext
class.
Pop the current UIComponent
from the FacesContext
attributes map so that the previous
UIComponent
, if any, becomes the current component.
Enable the correct handling of navigation when processing a return node.
Service providers that implement this service must be called by the Jakarta Faces runtime exactly once for each implementation, at startup, before any requests have been serviced.
port
to be used.port
.PortInfo
interface is used by a
HandlerResolver
to query information about
the port it is being asked to create a handler chain for.Positive
constraints on the same element.PositiveOrZero
constraints on the same element.
When an instance of this event is passed to
SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or ComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener
implementation may assume that the source
of this event instance is a UIComponent
instance and
that either that instance or an ancestor of that instance was just added to the view.
Instantiate a new PostAddToViewEvent
that indicates the argument component
was just added
to the view.
Instantiate a new PostAddToViewEvent
that indicates the argument component
was just added
to the view.
PostConstruct
annotation is used on a method that
needs to be executed after dependency injection is done to perform
any initialization.PostConstruct
callback, if it exists, according to the semantics required by the Java
EE platform specification.This event must be published by the runtime after all configuration resources have been parsed and processed.
Constructs a new PostConstructApplicationEvent
for this application.
Constructs a new PostConstructApplicationEvent
for this application.
This class is provided to allow custom scopes to publish a "post construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext
was
just created.
An instance of this event indicates that the custom scope enclosed within the argument scopeContext
was
just created.
This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is first created.
Instantiate a new PostConstructViewMapEvent
that indicates the argument root
was just
associated with its view map.
Instantiate a new PostConstructViewMapEvent
that indicates the argument root
was just
associated with its view map.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is
kept in the flash.
Instantiate a new PostKeepFlashValueEvent
that indicates the argument key
was just kept in
the flash.
Instantiate a new PostKeepFlashValueEvent
that indicates the argument key
was just kept in
the flash.
This event must be published by a call to Application.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is
stored in the flash.
Instantiate a new PostPutFlashValueEvent
that indicates the argument key
was just put to
the flash.
Instantiate a new PostPutFlashValueEvent
that indicates the argument key
was just put to
the flash.
When an instance of this event is passed to SystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
or