org.apache.deltaspike.jsf.api.config

Class JsfModuleConfig

java.lang.Object

org.apache.deltaspike.jsf.api.config.JsfModuleConfig

All Implemented Interfaces:

Serializable, DeltaSpikeConfig

@ApplicationScoped
public class JsfModuleConfig
extends Object
implements DeltaSpikeConfig

Config for all JSF specific configurations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_WINDOW_CLASS_NAME
static String	CLIENT_WINDOW_CONFIG_KEY
protected Boolean	delegatedWindowHandlingEnabled

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsfModuleConfig()

Method Summary

Modifier and Type	Method and Description
ClientWindowConfig.ClientWindowRenderMode	getDefaultWindowMode() If the window-handling of JSF 2.2+ is enabled, ClientWindowConfig.ClientWindowRenderMode.DELEGATED will be returned.
Class<? extends java.lang.annotation.Annotation>	getExceptionQualifier() Defines the javax.enterprise.Qualifier which will be used to fire the ExceptionToCatchEvent for unhandled JSF exceptions.
boolean	isAllowPostRequestWithoutDoubleSubmitPrevention()
boolean	isAlwaysKeepMessages() Per default all faces-messages are preserved for the next rendering process
boolean	isAlwaysUseNavigationHandlerOnSecurityViolation() Per default the current view gets replaced with the error-view (in case of a security-violation).
boolean	isContainerManagedConvertersEnabled() Per default converters get wrapped to restore them properly during a postback (significant without overhead).
boolean	isContainerManagedValidatorsEnabled() Per default validators get wrapped to restore them properly during a postback (significant without overhead).
protected boolean	isDelegatedWindowHandlingEnabled()
boolean	isFullStateSavingFallbackEnabled() If #initialStateMarked (of the component) returns false, a fallback to full state-saving is possible.
boolean	isInitialRedirectEnabled() If the initial redirect is enabled, a redirect will be performed for adding the current window-id to the url.
protected void	lazyInitDelegatedWindowHandlingEnabled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLIENT_WINDOW_CONFIG_KEY

public static final String CLIENT_WINDOW_CONFIG_KEY

See Also:

Constant Field Values

CLIENT_WINDOW_CLASS_NAME

public static final String CLIENT_WINDOW_CLASS_NAME

See Also:

Constant Field Values

delegatedWindowHandlingEnabled

protected Boolean delegatedWindowHandlingEnabled

Constructor Detail

JsfModuleConfig

protected JsfModuleConfig()

Method Detail

isInitialRedirectEnabled

public boolean isInitialRedirectEnabled()

If the initial redirect is enabled, a redirect will be performed for adding the current window-id to the url.

Returns:

true for activating it, false otherwise

isAlwaysKeepMessages

public boolean isAlwaysKeepMessages()

Per default all faces-messages are preserved for the next rendering process

Returns:

true if the messages should be preserved automatically, false otherwise

isAlwaysUseNavigationHandlerOnSecurityViolation

public boolean isAlwaysUseNavigationHandlerOnSecurityViolation()

Per default the current view gets replaced with the error-view (in case of a security-violation). For using a redirect it's needed to return true and using Page.NavigationMode.REDIRECT for @View of the error-view-config.

Returns:

true if the navigation-handler should be used in case of a security-violation, false otherwise

isContainerManagedConvertersEnabled

public boolean isContainerManagedConvertersEnabled()

Per default converters get wrapped to restore them properly during a postback (significant without overhead).

Returns:

true if converters should be handled as std. CDI beans, false otherwise

isContainerManagedValidatorsEnabled

public boolean isContainerManagedValidatorsEnabled()

Per default validators get wrapped to restore them properly during a postback (significant without overhead).

Returns:

true if validators should be handled as std. CDI beans, false otherwise

isFullStateSavingFallbackEnabled

public boolean isFullStateSavingFallbackEnabled()

If #initialStateMarked (of the component) returns false, a fallback to full state-saving is possible. Therefore it's required to save additional meta-data even with partial state-saving.

Returns:

false to restrict additional meta-data required for a possible fallback, true otherwise

getDefaultWindowMode

public ClientWindowConfig.ClientWindowRenderMode getDefaultWindowMode()

If the window-handling of JSF 2.2+ is enabled, ClientWindowConfig.ClientWindowRenderMode.DELEGATED will be returned. In all other cases null gets returned as application wide default value. That leads to a default-handling per session (which includes logic for handling bots,...)

Returns:

application-default for the window-mode

lazyInitDelegatedWindowHandlingEnabled

protected void lazyInitDelegatedWindowHandlingEnabled()

getExceptionQualifier

public Class<? extends java.lang.annotation.Annotation> getExceptionQualifier()

Defines the javax.enterprise.Qualifier which will be used to fire the ExceptionToCatchEvent for unhandled JSF exceptions.

Returns:

the javax.enterprise.Qualifier.

isAllowPostRequestWithoutDoubleSubmitPrevention

public boolean isAllowPostRequestWithoutDoubleSubmitPrevention()

isDelegatedWindowHandlingEnabled

protected boolean isDelegatedWindowHandlingEnabled()