Hacks (OmniFaces 2.6 API)

java.lang.Object
- org.omnifaces.util.Hacks

```
public final class Hacks
extends Object
```
Collection of JSF implementation and/or JSF component library and/or server specific hacks.

Since:

1.3

Author:

Bauke Scholtz, Arjan Tijms

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static long`	`getDefaultResourceMaxAge()` Returns the default resource maximum age in milliseconds.
`static PartialViewContext`	`getRichFacesPartialViewContext()` RichFaces 4.0-4.3 ExtendedPartialViewContextImpl does not extend from PartialViewContextWrapper.
`static Collection<String>`	`getRichFacesRenderIds()` RichFaces PartialViewContext implementation does not have the getRenderIds() method properly implemented.
`static Set<ResourceIdentifier>`	`getRichFacesResourceLibraryResources(ResourceIdentifier id)` Returns an ordered set of all JSF resource identifiers for the given RichFaces resource library resources.
`static PartialViewContext`	`getRichFacesWrappedPartialViewContext()` RichFaces 4.0-4.3 ExtendedPartialViewContextImpl does not have any getWrapped() method to return the wrapped PartialViewContext.
`static StateHelper`	`getStateHelper(UIComponent component)` Expose protected state helper into public.
`static boolean`	`isMyFacesUsed()` Returns true if MyFaces is used.
`static boolean`	`isNestedInPrimeFacesDialog(UIComponent... components)` Returns true if the given components are nested in (same) PrimeFaces dialog.
`static boolean`	`isPrimeFacesDynamicResourceRequest(FacesContext context)` Returns true if the current request is a PrimeFaces dynamic resource request.
`static boolean`	`isRichFacesInstalled()` Returns true if RichFaces 4.x is installed.
`static boolean`	`isRichFacesResourceLibraryRenderer(String rendererType)` Returns true if the given renderer type is recognizeable as RichFaces resource library renderer.
`static boolean`	`isScriptResourceRendered(FacesContext context, ResourceIdentifier id)` Returns whether the given script resource is rendered.
`static boolean`	`isTomcatWebSocketBombed(Session session, IllegalStateException illegalStateException)` Returns true if the given WS session is from Tomcat and given illegal state exception is caused by a push bomb which Tomcat couldn't handle.
`static void`	`removeResourceDependencyState(FacesContext context)` Remove the resource dependency processing related attributes from the given faces context.
`static void`	`removeViewState(FacesContext context, ResponseStateManager manager, String viewId)` Remove server side JSF view state associated with current request.
`static void`	`setScriptResourceRendered(FacesContext context, ResourceIdentifier id)` Set the given script resource as rendered.
`static void`	`setStylesheetResourceRendered(FacesContext context, ResourceIdentifier id)` Set the given stylesheet resource as rendered.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isRichFacesInstalled
```
public static boolean isRichFacesInstalled()
```
    Returns true if RichFaces 4.x is installed. That is, when the RichFaces 4.0-4.3 specific ExtendedPartialViewContextImpl, or RichFaces 4.5+ specific ExtendedPartialViewContext is present in the runtime classpath. As this is usually auto-registered, we may safely assume that RichFaces 4.x is installed.
    Note that RichFaces 4.4 doesn't exist.
    
    Returns:
    
    Whether RichFaces 4.x is installed.
  - getRichFacesPartialViewContext
```
public static PartialViewContext getRichFacesPartialViewContext()
```
    RichFaces 4.0-4.3 ExtendedPartialViewContextImpl does not extend from PartialViewContextWrapper. So a hack wherin the exact fully qualified class name needs to be known has to be used to properly extract it from the FacesContext.getPartialViewContext().
    
    Returns:
    
    The RichFaces PartialViewContext implementation.
  - getRichFacesRenderIds
```
public static Collection<String> getRichFacesRenderIds()
```
    RichFaces PartialViewContext implementation does not have the getRenderIds() method properly implemented. So a hack wherin the exact name of the private field needs to be known has to be used to properly extract it from the RichFaces PartialViewContext implementation.
    
    Returns:
    
    The render IDs from the RichFaces PartialViewContext implementation.
  - getRichFacesWrappedPartialViewContext
```
public static PartialViewContext getRichFacesWrappedPartialViewContext()
```
    RichFaces 4.0-4.3 ExtendedPartialViewContextImpl does not have any getWrapped() method to return the wrapped PartialViewContext. So a reflection hack is necessary to return it from the private field.
    
    Returns:
    
    The wrapped PartialViewContext from the RichFaces 4.0-4.3 ExtendedPartialViewContextImpl.
  - isRichFacesResourceLibraryRenderer
```
public static boolean isRichFacesResourceLibraryRenderer(String rendererType)
```
    Returns true if the given renderer type is recognizeable as RichFaces resource library renderer.
    
    Parameters:
    
    rendererType - The renderer type to be checked.
    
    Returns:
    
    Whether the given renderer type is recognizeable as RichFaces resource library renderer.
  - getRichFacesResourceLibraryResources
```
public static Set<ResourceIdentifier> getRichFacesResourceLibraryResources(ResourceIdentifier id)
```
    Returns an ordered set of all JSF resource identifiers for the given RichFaces resource library resources.
    
    Parameters:
    
    id - The resource identifier of the RichFaces resource library (e.g. org.richfaces:ajax.reslib).
    
    Returns:
    
    An ordered set of all JSF resource identifiers for the given RichFaces resource library resources.
  - isMyFacesUsed
```
public static boolean isMyFacesUsed()
```
    Returns true if MyFaces is used. That is, when the FacesContext instance is from the MyFaces specific package.
    
    Returns:
    
    Whether MyFaces is used.
    
    Since:
    
    1.8
  - setScriptResourceRendered
```
public static void setScriptResourceRendered(FacesContext context,
                                             ResourceIdentifier id)
```
    Set the given script resource as rendered.
    
    Parameters:
    
    context - The involved faces context.
    
    id - The resource identifier.
    
    Since:
    
    1.8
  - isScriptResourceRendered
```
public static boolean isScriptResourceRendered(FacesContext context,
                                               ResourceIdentifier id)
```
    Returns whether the given script resource is rendered.
    
    Parameters:
    
    context - The involved faces context.
    
    id - The resource identifier.
    
    Returns:
    
    Whether the given script resource is rendered.
    
    Since:
    
    1.8
  - setStylesheetResourceRendered
```
public static void setStylesheetResourceRendered(FacesContext context,
                                                 ResourceIdentifier id)
```
    Set the given stylesheet resource as rendered.
    
    Parameters:
    
    context - The involved faces context.
    
    id - The resource identifier.
    
    Since:
    
    1.8
  - getDefaultResourceMaxAge
```
public static long getDefaultResourceMaxAge()
```
    Returns the default resource maximum age in milliseconds.
    
    Returns:
    
    The default resource maximum age in milliseconds.
  - removeResourceDependencyState
```
public static void removeResourceDependencyState(FacesContext context)
```
    Remove the resource dependency processing related attributes from the given faces context.
    
    Parameters:
    
    context - The involved faces context.
  - removeViewState
```
public static void removeViewState(FacesContext context,
                                   ResponseStateManager manager,
                                   String viewId)
```
    Remove server side JSF view state associated with current request.
    
    Parameters:
    
    context - The involved faces context.
    
    manager - The involved response state manager.
    
    viewId - The view ID of the involved view.
    
    Since:
    
    2.3
  - getStateHelper
```
public static StateHelper getStateHelper(UIComponent component)
```
    Expose protected state helper into public.
    
    Parameters:
    
    component - The component to obtain state helper for.
    
    Returns:
    
    The state helper of the given component.
    
    Since:
    
    2.3
  - isPrimeFacesDynamicResourceRequest
```
public static boolean isPrimeFacesDynamicResourceRequest(FacesContext context)
```
    Returns true if the current request is a PrimeFaces dynamic resource request.
    
    Parameters:
    
    context - The involved faces context.
    
    Returns:
    
    Whether the current request is a PrimeFaces dynamic resource request.
    
    Since:
    
    1.8
  - isNestedInPrimeFacesDialog
```
public static boolean isNestedInPrimeFacesDialog(UIComponent... components)
```
    Returns true if the given components are nested in (same) PrimeFaces dialog.
    
    Parameters:
    
    components - The components to be checked.
    
    Returns:
    
    Whether the given components are nested in (same) PrimeFaces dialog.
    
    Since:
    
    2.6
  - isTomcatWebSocketBombed
```
public static boolean isTomcatWebSocketBombed(Session session,
                                              IllegalStateException illegalStateException)
```
    Returns true if the given WS session is from Tomcat and given illegal state exception is caused by a push bomb which Tomcat couldn't handle. See also https://bz.apache.org/bugzilla/show_bug.cgi?id=56026 and https://github.com/omnifaces/omnifaces/issues/234
    
    Parameters:
    
    session - The WS session.
    
    illegalStateException - The illegal state exception.
    
    Returns:
    
    Whether it was Tomcat who couldn't handle the push bomb.
    
    Since:
    
    2.5

Class Hacks

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isRichFacesInstalled

getRichFacesPartialViewContext

getRichFacesRenderIds

getRichFacesWrappedPartialViewContext

isRichFacesResourceLibraryRenderer

getRichFacesResourceLibraryResources

isMyFacesUsed

setScriptResourceRendered

isScriptResourceRendered

setStylesheetResourceRendered

getDefaultResourceMaxAge

removeResourceDependencyState

removeViewState

getStateHelper

isPrimeFacesDynamicResourceRequest

isNestedInPrimeFacesDialog

isTomcatWebSocketBombed