All Classes and Interfaces
Class
Description
A base implementation of
TreeModel.Helper class used for creating a FacesContext with a decorated FacesContext -> Application -> ViewHandler -> getActionURL.
Collection of utility methods for working with
PartialViewContext.
Collection of utility methods for the Faces API with respect to working with
PartialViewContext.
The
<sec:isAnonymous> tag conditionally renders its content only when the user is anonymous (not authenticated).
OmniFaces application initializer.
OmniFaces application listener.
OmniFaces application processor.
Collection of EL functions for array manipulation:
o:createArray(), o:createIntegerArray(), o:contains() and
o:reverseArray().
The
<sec:isAuthenticated> tag conditionally renders its content only when the user is authenticated (logged in).
The
<sec:authorize> tag conditionally renders its content based on role-based access control using SecurityContext.
Collection of utility methods for the CDI API that are mainly shortcuts for obtaining stuff from the
BeanManager.
Collection of utility methods for the CDI API that are mainly shortcuts for obtaining stuff from the
BeanManager.CDI bean storage.
Overrides
BeanValidator.setValidationGroups(String) for all components in the current view.This HTTP servlet response implementation buffers the entire response body.
The
<o:cache> component allows to cache a fragment of rendered markup.Interface that abstracts a simple get and put operation for a concrete cache implementation.
This filter will control the cache-related headers of the response.
Meta data for a value that's stored in a cache.
Factory used to obtain
Cache instance and to register the CacheProvider that is used to obtain that.Optional initializer for the
Cache used by the Omnifaces Cache component.Base class for Cache providers where for each scope a new instance of the cache is created if for that scope no instance is present yet.
A provider for a specific
Cache implementation.CacheValue is a replacement for
ui:param and c:set that only evaluates a value expression once and thereafter resolves it from the
cache.A value expression implementation that caches its main value at the moment it's evaluated and uses this cache value in future evaluations.
This phase listener picks up phase listener instances and phase event callbacks from the request scope subscribed via
subscribeToRequestXxxPhase() methods of the Events utility class and calls them back for each matching phase.This
Resource implementation can be used as a marker class to signal the custom ResourceHandler such as CombinedResourceHandler that
the given resource actually returns a CDN URL, and offers a method to return the local URL which can be used as fallback in case the CDN request errors out.
This
ResourceHandler implementation allows the developer to provide external (CDN) URLs instead of the default local URLs for Faces resources.
This filter will set the request body character encoding when not already set by the client.
Copier that copies an object using the
Cloneable facility.
This
Resource implementation holds all the necessary information about combined resources in order to properly serve combined resources on a single
HTTP request.
This
ResourceHandler implementation will remove all separate script and stylesheet resources which have the target attribute set to
"head" from the UIViewRoot and create a combined one for all scripts and another combined one for all stylesheets.
This class is a wrapper which collects all combined resources and stores it in the cache.
Use this builder to create an instance of combined resource info and put it in the cache if absent.
This
InputStream implementation takes care that all in the constructor given resources are been read in sequence.Handler that can be used by components which wish to receive various extra services.
The
<o:componentIdParam> component allows to render just one or more components on a view via a GET parameter.Collection of EL functions for working with components.
Collection of utility methods for the Faces API with respect to working with
UIComponent.Builder class used to collect a number of query parameters for a visit (for each) of components in the Faces component tree.
Collection of utility methods for the Faces API with respect to working with
UIComponent.
The
o:compositeConverter allows multiple converters to be chained together.This HTTP servlet response wrapper will compress the response with the given algorithm when the given threshold has exceeded and the response content type
matches one of the given mimetypes.
Available compression algorithms.
The
CompressedResponseFilter will apply compression on HTTP responses whenever applicable.
The
<o:conditionalComment> component renders a conditional comment.ResponseWriter intended to work in conjunction with the
ComponentIdParam component.PhaseListener intended to work in conjunction with the
ComponentIdParam component.
The CDI annotation
@ContextParam allows you to inject a web.xml context parameter from the current application in a CDI
managed bean.
Producer for injecting a
web.xml context parameter as defined by the ContextParam annotation.
The
<o:converter> is a taghandler that extends the standard <f:converter> tag family with support for deferred value
expressions in all attributes.So that we can have a serializable converter.
The
@FacesConverter is by default not eligible for dependency injection by @Inject nor @EJB.
Collection of EL functions for data conversion:
o:iterableToList() (with alternative o:iterableToModel),
o:setToList(), o:mapToList(), o:joinArray(), o:joinCollection(), o:joinMap(),
o:splitArray(), o:splitList(), and o:toJson().
The CDI annotation
@Cookie allows you to inject a HTTP request cookie value from the current Faces context in a CDI managed bean.Interface that is to be implement by classes that know how to copy an object.
Copier that copies an object using its copy constructor.
The
CorsAwareResourceRenderer is intended as an extension to the standard script and stylesheet resource renderer in order to add the
crossorigin and integrity attributes as a pass-through attribute.
The
<o:criticalStylesheet> is a component based on the standard <h:outputStylesheet> which renders a
<link rel="preload" as="style"> instead of <link rel="stylesheet"> and automatically changes the
rel="preload" to rel="stylesheet" during window load event.This renderer is the default renderer of
CriticalStylesheet.
Producer for
#{startup} and #{now}.ZonedDateTime is a final class, hence this proxy for CDI.
Collection of EL functions for date and time:
o:formatDate(), o:formatDateWithTimezone(), o:addXxx() like
o:addDays(), o:xxxBetween() like o:daysBetween(), o:getMonths(), o:getShortMonths(),
o:getDaysOfWeek(), o:getShortDaysOfWeek(), o:getMonth(), o:getShortMonth(), o:getDayOfWeek()
and o:getShortDayOfWeek().An in-memory cache implementation that's used if the user did not configure an explicit caching provider.
A default cache provider that will be used by the OmniFaces Cache component if no explicit provider has been configured.
Default implementation for the HttpSessionListener interface.
Default implementation for the PhaseListener interface.
A default
ResourceHandler implementation which hooks on all three DefaultResourceHandler.createResource(String), DefaultResourceHandler.createResource(String, String) and
DefaultResourceHandler.createResource(String, String, String) methods.Default implementation for the SystemEventListener interface.
A default implementation of abstract servlet output stream.
Default implementation for the ServletRequestListener interface.
Default implementation for the SystemEventListener interface.
Default implementation for the SystemEventListener interface that's used for the subset of system events that are registered as "view event" on the component
tree's view root.
The
<o:deferredScript> is a component based on the standard <h:outputScript> which defers the loading of the given
script resource to the window load event.This renderer is the default renderer of
DeferredScript.Dynamic CDI producer used to work around CDI's restriction to create true generic producers.
AnnotationLiteral for Param.This
Resource implementation represents a cacheable dynamic resource which doesn't necessarily exist as a regular classpath resource.
The CDI annotation
@Eager specifies that a scoped bean is to be eagerly instantiated.
A PhaseListener that instantiates eager request/view beans by Faces view ID.
Bean repository via which various types of eager beans can be instantiated on demand.
A web listener that instantiates eager session beans and request/view beans by request URI.
CDI extension that collects beans annotated with
@Eager.Helper class to save and restore state of an
EditableValueHolder.
Provides a simple implementation of
ELResolver that can be sub-classed by developers wishing to provide specialized behavior to an existing
ELResolver instance.
The
<o:enableRestorableView> taghandler instructs the view handler to recreate the entire view whenever the view has been expired, i.e.
Collection of utility methods for the Faces API with respect to working with system and phase events.
Collection of general utility methods with respect to working with exceptions.
The
ExceptionSuppressor will suppress all exceptions which are an instance of the types as listed in context parameter
"org.omnifaces.EXCEPTION_TYPES_TO_SUPPRESS" and refresh the current page by redirecting to the current
URL with query string.This exception handler factory needs to be registered as follows in
faces-config.xml to get the ExceptionSuppressor to run:
This class contains methods that inspect expressions to reveal information about them.
This class extends the default
SelectItem with several convenience methods.The action that is done when a Faces Views request with an extension is done.
Interface to be implemented by components that wish to receive the
FaceletContext for the Facelet in which they are declared.
Collection of utility methods for working with Facelets.
Collection of utility methods for the Faces API that are mainly shortcuts for obtaining stuff from the thread local
FacesContext.
This configuration interface parses the
/WEB-INF/faces-config.xml and all /META-INF/faces-config.xml files found in the classpath
and offers methods to obtain information from them which is not available by the standard Faces API.This EL resolver basically creates an implicit object
#{faces} in EL scope.Provides a simple implementation of
FacesEvent that can be sub-classed by developers wishing to provide specialized behavior to an existing
FacesEvent instance without the need to implement/override all the methods which do not necessarily need to be implemented.
The
FacesExceptionFilter will solve 2 problems with exceptions thrown in Faces methods.
Unlike native Faces validation error messages, in a bean validation message by default the label of the component where a validation constraint violation
originated from can not be displayed in the middle of a message.
Collection of utility methods for the Faces API that are mainly shortcuts for obtaining stuff from the provided
FacesContext argument.
The
FacesMessageExceptionHandler will add every exception as a global FATAL faces message.This exception handler factory needs to be registered as follows in
faces-config.xml to get the FacesMessageExceptionHandler to run:
FacesViews is a mechanism to use SEO-friendly extensionless URLs in a Faces application without the need to enlist individual Facelet source files in some
configuration file.
This filter makes sure extensionless requests arrive at the FacesServlet using an extension on which that Servlet is mapped, and that non-extensionless
requests are handled according to a set preference.
Facelets resource handler that resolves mapped resources (views) to the folders from which those views were scanned (like the the special auto-scanned
faces-views folder).
View handler that renders an action URL extensionless if a resource is a mapped one, and faces views has been set to always render extensionless or if the
current request is extensionless, otherwise as-is.
The well known "BalusC FileServlet", as an abstract template,
slightly refactored, rewritten and modernized with a.o. fast NIO stuff instead of legacy RandomAccessFile.
The
<o:form> is a component that extends the standard <h:form> and submits to exactly the request URI with query string
as seen in browser's address.
The
FullAjaxExceptionHandler will transparently handle exceptions during ajax requests exactly the same way as exceptions during synchronous
(non-ajax) requests.This exception handler factory needs to be registered as follows in
faces-config.xml to get the FullAjaxExceptionHandler to run:Collection of functional interfaces.
Use this if you need a serializable bi-consumer.
Use this if you need a serializable bi-function.
Use this if you need a serializable consumer.
Use this if you need a serializable function.
Use this if you need a serializable runnable.
Use this if you need a serializable supplier.
Use this if you need a throwing bi-consumer.
Use this if you need a throwing bi-function.
Use this if you need a throwing consumer.
Use this if you need a throwing function.
Use this if you need a throwing runnable.
Use this if you need a throwing supplier.
The
omnifaces.GenericEnumConverter is intended for use in UISelectMany components whose value is been bound to a
List<E> property where E is an enum.
The
<o:graphicImage> is a component that extends the standard <h:graphicImage> with support for referencing an
InputStream or byte[] property in the value attribute, optionally as a data URI.
Stereo type that designates a bean with one or more methods returning
byte[] or InputStream as a named application scoped bean
specifically for serving graphic images via <o:graphicImage> component or #{o:graphicImageURL()} EL functions.
This
Resource implementation is used by the GraphicImage component.
This
ResourceHandler implementation deals with GraphicResource requests.
Collection of Faces implementation and/or Faces component library and/or server specific hacks.
This event is fired by
<o:hashParam> when hash parameters have been changed in the client side.
The
<o:hashParam> is a component that extends the standard <f:viewParam> with support for setting hash query parameter
values in bean and automatically reflecting updated model values in hash query string.
The
<o:highlight> is a helper component which highlights all invalid UIInput components and the associated labels by adding an
error style class to them.
The
HttpFilter is abstract filter specifically for HTTP requests.Convenience class for extending
HttpServletResponseWrapper wherein the servlet response OutputStream has to be replaced by a custom
implementation.
The
<o:ignoreValidationFailed> taghandler allows the developer to ignore validation failures when executing an UICommand action.
This converter won't output the percent or currency symbols, that's up to the UI.
The
<o:importConstants> taghandler allows the developer to have a mapping of all constant field values of the given fully qualified name
of a type in the request scope.Specific map implementation which wraps the given map in
Collections.unmodifiableMap(Map) and throws an IllegalArgumentException in
ImportConstants.ConstantsMap.get(Object) method when the key doesn't exist at all.
The
<o:importFunctions> taghandler allows the developer to have access to all functions of the given fully qualified name of a type in the
Facelet scope using the usual EL functions syntax without the need to register them in .taglib.xml file.Dummy class used to take the injection point for "InjectionPoint" of, for usage in the implementation of
Beans.getCurrentInjectionPoint(jakarta.enterprise.context.spi.CreationalContext).
Provides a simple implementation of
InjectionTarget that can be sub-classed by developers wishing to provide specialized behavior to an existing
InjectionTarget instance.Base renderer which is to be shared between inline CSS and JS renderers.
This renderer enables rendering a JS resource inline.
This renderer enables rendering a CSS resource inline.
The
<o:inputFile> is a component that extends the standard <h:inputFile> and adds support for directory
and maxsize attributes, along with built-in server side validation on accept and maxsize attributes.
The
<o:inputHidden> is a component that extends the standard <h:inputHidden> and changes the behavior to immediately
convert, validate and update during apply request values phase, regardless of any conversion/validation errors on other UIInput components
within the same form.
The
InvokeActionEventListener will add support for new <f:event> types preInvokeAction and
postInvokeAction.IterableDataModel is an implementation of
DataModel that wraps an Iterable.
Utility class for simplifying some web related tasks that use JNDI under the hood, such as getting the
<env-entry> from
web.xml.JNDIObjectLocator is used to centralize JNDI lookups.
The builder of the
JNDIObjectLocator.A simple JSON encoder.
Implements lazy-initialized object primarily for final and transient fields.
The
<o:lazyPanel> is a component that defers rendering of its children until the panel has scrolled into view.
This event is passed as optional method argument of
<o:lazyPanel listener>.A handler for
LazyPanel component, which will take care of setting the listener attribute.
The
<o:link> is a component that extends the standard <h:link> and allows including the request query string parameters
of the current URL into the link's target URL.
The
omnifaces.ListConverter is intented for use in specialized selection components which doesn't use SelectItems as the source for
their selectable items, but work directly via a List of entities, and therefore the SelectItemsConverter isn't usable on them.
The
omnifaces.ListIndexConverter is a variant of the ListConverter which automatically converts based on the position (index) of the
selected item in the list instead of the Object.toString() of the selected item.
The
<o:loadBundle> taghandler basically extends the standard <f:loadBundle> with a new loader attribute
allowing you to explicitly set the desired ClassLoader where the resource bundle should be looked up.Minimal implementation of thread safe LRU cache with support for eviction listener.
Implementation of Map that wraps another map.
The <o:massAttribute> sets an attribute of the given name and value on all nested components, if they don't already have an attribute
set.
Collection of utility methods for the Faces API with respect to working with
FacesMessage.Faces message builder.
The message resolver allows the developers to change the way how messages are resolved.
The
@messages search keyword resolver will automatically resolve all UIMessage and UIMessages
components within the current UIForm.
Collection of utility methods for the Faces API with respect to working with
FacesMessage.This renderer is the default renderer of
OmniMessages.This MethodExpression wraps a ValueExpression.
The
<o:methodParam> is a tag handler that can be used to pass a method expression as attribute into a Facelets tag.This encapsulates information about an EL method expression.
The
<o:moveComponent> component is a utility component via which components, facets and behaviors can be moved at runtime to a target
component in various ways.Destination of component to be moved by
MoveComponent.Generic interface for multi field validator.
Copier that copies an object trying a variety of strategies until one succeeds.
The
MutableRequestFilter will wrap the incoming HttpServletRequest in a MutableRequestFilter.MutableRequest so that the developer can mutate the headers
and parameters in such way that the outcome of among others HttpServletRequest.getHeader(String) and ServletRequest.getParameter(String)
are influenced.Copier that doesn't actually copy an object fully, but just returns a new instance of the same type.
This
ViewHandler once installed will during development stage throw an IllegalStateException whenever an automatically generated Faces
component ID (j_id...) is encountered in the rendered output.This response writer throws an
IllegalStateException when an attribute with name "id" is written with a non-null value which starts with
UIViewRoot.UNIQUE_ID_PREFIX or contains an intermediate.
The
<o:notification> is a UIComponent which integrates the browser Web
Notifications API with SSE (Server-Sent Events) based push.Represents a notification message for use with
PushContext.send().
Collection of EL functions for number formatting:
o:formatBytes(), o:formatCurrency(), o:formatNumber(),
o:formatNumberDefault(), o:formatPercent(), o:formatThousands() and o:formatThousandsUnit().Collection of EL functions for objects.
This application factory takes care that the
OmniApplication is properly initialized.OmniFaces external context.
This external context factory takes care that the
OmniExternalContext is properly initialized.Collection of constants and utility methods for OmniFaces internals.
The
<o:messages> is a component that extends the standard <h:messages> with the following new features:
This OmniFaces partial view context extends and improves the standard partial view context as follows:
Support for executing callback scripts by
PartialResponseWriter.startEval().
Support for adding arguments to an ajax response.
Any XML tags which Mojarra and MyFaces has left open after an exception in rendering of an already committed ajax response, will now be properly closed.This partial view context factory takes care that the
OmniPartialViewContext is properly initialized.OmniFaces render kit.
This render kit factory takes care that the
OmniRenderKit is properly initialized.Appends OmniFaces version to resources with library name
omnifaces.OmniFaces view handler.
Filter that wraps the response with one capable of buffering on command.
Base class of
HashParam and ScriptParam.
The
<o:onloadScript is a component that extends the standard <h:outputScript> which will be executed in the end of the
HTML body (thus when all HTML elements are initialized in the HTML DOM tree) and will re-execute its script body on every ajax request.Base class which is to be shared between all components of the Output family.
The
<o:outputFormat> is a component that extends the standard <h:outputFormat> with support for capturing the output
and exposing it into the request scope by the variable name as specified by the var attribute.
The
<o:outputLabel> is a component that extends the standard <h:outputLabel> with support for automatically setting its
value as the label of the component identified by its for attribute (if any).
The CDI annotation
@Param allows you to inject, convert and validate a HTTP request or path parameter in a CDI managed bean.
The
<o:param> is a component that extends the standard UIParameter to implement ValueHolder and thus support a
Converter to convert the supplied value to string, if necessary.CDI extension that works around the fact that CDI insists on doing absolutely guaranteed type safe injections.
This interface represents a (request) parameter holder which extends
ValueHolder with ParamHolder.getName() method to obtain the parameter name
associated with the parameter value and changes the ParamHolder.getLocalValue() method to return the original, unconverted value and changes the
ParamHolder.getValue() method to return the value converted to String.Producer for a request or path parameter as defined by the
@Param annotation.The type that's injected via the
@Param qualifier.The action that is done when a request for a public path from which faces views where scanned is done.
The
<o:pathParam> is a component that extends the OmniFaces Param to support MultiViews feature of
FacesViews.This class provides access to Jakarta platform services from the view point of Faces.
Use this event to have a hook on a listener method during the afterphase of the
PhaseId.INVOKE_APPLICATION.
The annotation
@PostScriptParam allows you to invoke a managed bean method when all <o:scriptParam> values have
been set in the associated managed bean.Use this event to have a hook on a listener method during the beforephase of the
PhaseId.INVOKE_APPLICATION.
The CDI annotation
@Push allows you to inject a PushContext associated with a given channel in any container managed
artifact in WAR (not in EAR/EJB!).Represents the transport type for push messages.
CDI interface to send a message object to the push channel as identified by
@Push.
This CDI extension detects
@Inject @Push PushContext injection points during bean discovery.
This
ResourceHandler generates the manifest.json and also an offline-aware sw.js based on any WebAppManifest found
in the runtime classpath.
The CDI annotation
@RateLimit allows you to rate limit method invocations in CDI managed beans based on a configurable client
identifier, such as client IP address, user ID, API key, etc.
CDI managed bean for rate limiting requests per client identifier.
Thrown when rate limit has exceeded according to
RateLimiter.
CDI interceptor that enforces rate limiting on methods annotated with
RateLimit.Implementation of a read only value expression that can be used when the value is not yet available at construction time, or when the value would be too
expensive to create and it's not yet clear if the expression will actually be evaluated.
Collection of utility methods for working with reflection.
This class represents a property path.
This
Resource implementation remaps the given resource to the given request path.Collection of utility methods for the Faces API with respect to working with
Renderer.
Producer for injecting a Faces request cookie as defined by the
@Cookie annotation.
The
omnifaces.RequiredCheckboxValidator is intented to solve a peculiar problem with required="true" attribute of
UISelectBoolean components like <h:selectBooleanCheckbox>.
The
ResetInputAjaxActionListener will reset input fields which are not executed during ajax submit, but which are rendered/updated during ajax
response.Base interface for a resettable buffer.
This resettable buffered output stream will buffer everything until the given threshold buffer size, regardless of flush calls.
This resettable buffered writer will buffer everything until the given buffer size, regardless of flush calls.
The
<o:resolveComponent> component is a utility component via which a component can be looked up by its ID and a reference to it put in
either the "facelet scope" (default) or the request scope.Convenience class to represent a resource identifier.
The
<o:resourceInclude> component can be used to catch the output from a JSP or Servlet resource and render it as output to the Faces
writer.Utility class for working with (Servlet) resource paths, providing methods to handle their prefixes, slashes, extensions etc.
This class helps in letting code run within its own scope.
This CDI event will be fired by
ScriptErrorHandler when an uncaught JavaScript error or unhandled promise rejection is caught in the client.
The
<o:scriptErrorHandler> is a component that catches uncaught JavaScript errors and unhandled promise rejections on the client and sends
them to the server via navigator.sendBeacon(), where they are fired as ScriptError CDI events.
This servlet receives script error reports sent by
<o:scriptErrorHandler> via navigator.sendBeacon() and fires them as
ScriptError CDI events.Base class which is to be shared between all components of the Script family.
The
<o:scriptParam> is a component that extends the standard <f:viewParam> with support for setting results of
client-side evaluated JavaScript code in bean.
The
o:selectItemGroups is an extension of UISelectItems which allows you to iterate over a nested collection representing groups of
select items.Helper class to build an array of SelectItems using various means, like via the builder pattern or a given
Map.Collection of utility methods for collecting
SelectItem instances from various sources.
The
omnifaces.SelectItemsConverter allows you to populate a selection component with complex Java model objects (entities) as value of
<f:selectItems> and have Faces convert those automatically back without the need to provide a custom converter which may need to do the
job based on possibly expensive service/DAO operations.
The
omnifaces.SelectItemsIndexConverter is a variant of the SelectItemsConverter which automatically converts based on the position
(index) of the selected item in the list instead of the Object.toString() of the selected item.Collection of utility methods for working with
SelectItem or data represented by them.Copier that copies an object by serializing and subsequently deserializing it again.
Collection of utility methods for the Servlet API in general.
This class provides a basic and default implementation of the
ParamHolder interface.
The
<o:sitemapUrl> is a component which renders the given target URL or Faces view ID as a sitemap URL with support for adding additional
query string parameters to the URL via nested <f:param> and <o:param>.The available values of the "changefreq" element of the sitemap URL.
The
<o:skipValidators> taghandler allows the developer to entirely skip validation when executing an UICommand or
ClientBehaviorHolder action.
The
<o:socket> is an UIComponent whith opens an one-way (server to client) web socket based push connection in client side which
can be reached from server side via PushContext interface injected in any CDI/container managed artifact via @Push
annotation.
This web socket channel manager holds all application and session scoped web socket channel identifiers registered by
<o:socket>.This helps the web socket channel manager to hold view scoped web socket channel identifiers registered by
<o:socket>.
This web socket endpoint handles connections opened by
<o:socket>.
This web socket event will be fired by
SocketSessionManager when a web socket has been @SocketEvent.Opened,
@SocketEvent.Switched or @SocketEvent.Closed.
Indicates that a web socket has closed.
Indicates that a web socket has opened.
Indicates that a web socket user was switched.
This Faces listener for
UIViewRoot ensures that the necessary JavaScript code to open or close the WebSocket is properly rendered.
This is a concrete web socket implementation of
PushContext interface which is to be injected by @Push.Deprecated, for removal: This API element is subject to removal in a future version.
Since 5.2.
This web socket session manager holds all web socket sessions by their channel identifier.
This web socket user manager holds all web socket users registered by
<o:socket>.
This
ResourceHandler implementation will set the SourceMap response header with the correctly mapped request path to any discovered
source map of any CSS and JS resource.
The
<o:sse> is an UIComponent which opens an one-way (server to client) SSE (Server-Sent Events) based push connection in client
side which can be reached from server side via PushContext interface injected in any CDI/container managed artifact via
@Push(type=SSE) annotation.
This SSE channel manager holds all application and session scoped SSE channel identifiers registered by
<o:sse>.This helps the SSE channel manager to hold view scoped SSE channel identifiers registered by
<o:sse>.
This SSE endpoint handles connections opened by
<o:sse> and <o:notification>.
This SSE event will be fired by
SseSessionManager when an SSE connection has been @SseEvent.Opened,
@SseEvent.Switched or @SseEvent.Closed.
Indicates that a SSE channel has closed.
Indicates that a SSE channel has opened.
Indicates that a SSE user was switched.
This is a concrete SSE implementation of
PushContext interface which is to be injected by @Push(type=SSE) or
@Push(type=NOTIFICATION).
This SSE session manager holds all SSE connections by their channel identifier.
This SSE user manager holds all SSE users registered by
<o:sse>.
Stereo type that designates a bean as an eagerly instantiated bean with application scope.
Helper class for StateHelper that uses generic type-inference to make code that uses the StateHelper slightly less verbose.
Collection of EL functions for string manipulation:
o:abbreviate(), o:capitalize(), o:concat(),
o:prettyURL(), o:encodeURL(), o:encodeURI(), o:encodeBase64(), o:escapeJS(),
o:stripTags(), o:formatX(), and o:flagEmoji().Base class which is to be shared between all components of the Stylesheet family.
The
<o:tagAttribute> is a tag handler that can be used to explicitly declare a tag attribute on a Facelets tag file.Base class that can be used by Map based caches that don't support time to live semantics and arbitrary attributes natively.
The
omnifaces.ToCollectionConverter is intented to convert submitted String values to a Java collection based on a delimiter.
The
<o:tree> allows the developers to have full control over the markup of a tree hierarchy by declaring the appropriate Faces components
or HTML elements in the markup.Base class which is to be shared between all components of the Tree family.
The
<o:treeInsertChildren> is an UIComponent that represents the insertion point for the children of a parent tree node which is
represented by TreeNodeItem.A generic and simple tree data model which is to be used by
Tree component.
The
<o:treeNode> is an UIComponent that represents a single tree node within a parent Tree component.
The
<o:treeNodeItem> is an UIComponent that represents a single child tree node within a parent TreeNode component.
The
omnifaces.TrimConverter is intented to trim any whitespace from submitted String values.
This
ResourceHandler implementation allows the developer to map Faces resources on an URL pattern of /jakarta.faces.resource/*
(basically, the value of ResourceHandler.RESOURCE_IDENTIFIER) without the need for an additional FacesServlet prefix or suffix URL pattern in
the default produced resource URLs, such as /jakarta.faces.resource/faces/css/style.css or
/jakarta.faces.resource/css/style.css.xhtml.This wraps a request to an extensionless Faces view and provides an extension for all methods that reveal the servlet path.
The
<o:url> is a component which renders the given target URL or Faces view ID as a bookmarkable URL with support for adding additional
query string parameters to the URL via nested <f:param> and <o:param>, and for exposing it into the request scope by
the variable name as specified by the var attribute instead of rendering it.Base class which is to be shared between all components of the Util family.
Collection of general utility methods that do not fit in one of the more specific classes.
The
<o:validateAll> validates if ALL of the given UIInput components have been filled out.
The
<o:validateAllOrNone> validates if at least ALL of the given UIInput components have been filled out or that NONE of the given
UIInput components have been filled out.
The
<o:validateEqual> validates if ALL of the given UIInput components have the same value.
The
<o:validateMultiple> allows the developer to validate multiple fields by either a custom validator method:Base class which is to be shared between all multi field validators.
A handler for
ValidateMultiple component, which will take care of setting the validator attribute the right way as either
ValueExpression or MethodExpression.
The
<o:validateOne> validates if ONLY ONE of the given UIInput components have been filled out.
The
<o:validateOneOrMore> validates if at least ONE of the given UIInput components has been filled out.
The
<o:validateOrder> validates if the values of the given UIInput components as specified in the components
attribute are in the order as specified by the type attribute which accepts the following values:
lt (default): from least to greatest, without duplicates.
lte: from least to greatest, allowing duplicates (equal values next to each other).
gt: from greatest to least, without duplicates.
gte: from greatest to least, allowing duplicates (equal values next to each other).
The
<o:validateUnique> validates if ALL of the given UIInput components have an unique value.
The
<o:validator> is a taghandler that extends the standard <f:validator> tag family with support for deferred value
expressions in all attributes.So that we can have a serializable validator.
Base class which is to be shared between all components of the Validator family.
The
@FacesValidator is by default not eligible for dependency injection by @Inject nor @EJB.
Collection of utility methods for the Bean Validation API in general.
By default, Faces converters run on every request, regardless of whether the submitted value has changed or not.
By default, Faces validators run on every request, regardless of whether the submitted value has changed or not.
Provides a simple implementation of
ValueExpression that can be sub-classed by developers wishing to provide specialized behavior to an existing
ValueExpression instance.Automatically adds version parameter with query string name
v to all resource URLs so that the browser cache will be busted whenever the version
parameter changes.
The
<o:viewAction> is a component that extends the standard <f:viewAction> and changes the if attribute to
be evaluated during INVOKE_APPLICATION phase instead of the APPLY_REQUEST_VALUES phase.
The
ViewExpiredExceptionHandler will suppress any ViewExpiredException and refresh the current page by redirecting to the current URL with
query string.This exception handler factory needs to be registered as follows in
faces-config.xml to get the ViewExpiredExceptionHandler to run:
The
<o:viewParam> is a component that extends the standard <f:viewParam> and provides a stateless mode of operation and
fixes the issue wherein null model values are converted to empty string parameters in query string (e.g. when includeViewParams=true) and the
(bean) validation never being triggered when the parameter is completely absent in query string, causing e.g.<o:viewParamValidationFailed> allows the developer to handle a view parameter validation failure with either a redirect or an HTTP error
status, optionally with respectively a flash message or HTTP error message.This
ResourceHandler basically turns any concrete non-Facelets file into a Faces view, so that you can use EL expressions and even Faces components
in them.
The CDI view scope annotation, with more optimal handling of bean destroy as compared to standard Faces one.
Listener for Faces view scope destroy events so that view scope manager can be notified.
Register the CDI view scope context.
Manages view scoped bean creation and destroy.
Interface for view scope bean storage.
Stores view scoped bean instances in a LRU map in HTTP session.
Stores view scoped bean instances in Faces view state itself.
Please refer to
PWAResourceHandler for usage instructions.Enumeration of categories, to be used in
WebAppManifest.getCategories().Enumeration of text direction types, to be used in
WebAppManifest.getDir().Enumeration of display modes, to be used in
WebAppManifest.getDisplay().To be used in
WebAppManifest.getIcons().Enumeration of orientation modes, to be used in
WebAppManifest.getOrientation().Enumeration of related application platforms, to be used in
WebAppManifest.RelatedApplication.getPlatform().To be used in
WebAppManifest.getRelatedApplications()To be used in
WebAppManifest.getScreenshots()A
WebAppManifest.Screenshot form factorto be used
WebAppManifest.getShortcuts()To be used in
WebAppManifest.ImageResource.getSizes().
This configuration interface parses the
/WEB-INF/web.xml and all /META-INF/web-fragment files found in the classpath and offers
methods to obtain information from them which is not available by the standard Servlet API.
Collection of utility methods for the JAXP API in general.