oracle.adf.view.rich.automation.view

Class SwitchingViewDeclarationLanguageConfigurator

java.lang.Object

org.apache.myfaces.trinidad.config.Configurator

oracle.adf.view.rich.automation.view.SwitchingViewDeclarationLanguageConfigurator

public class SwitchingViewDeclarationLanguageConfigurator
extends org.apache.myfaces.trinidad.config.Configurator

This configurator is responsible for setting up the environment to enable switching of the faces VDL. For this to happen, automation must first be enabled. Once that's done the configurator will save the value of a forced 'viewId' on the request scope during the configurator's beginRequest. This viewId will be used by the SwitchingViewDeclarationLanguageFactory to retrieve the proper VDL. There are two ways to set this the forced view ID that will be used to retrieve the VDL. The first option is to set it programatically using the setForcedViewId() method. This will save the forced viewId value to the session and, provided automation is enabled, it will set that forcedViewId to be valid starting with the next faces request. The second way this can be enabled is via a request parameter. This is handy for automated testing where, say, a selenium server might need to set the forcedViewId on a given request. To do this, the application developer must add a context parameter "oracle.adf.view.rich.automation.view.FORCE_VIEW_ID_PARAM" to thier web.xml with a value of the parameter that will contain the forcedViewId. If this parameter is present on the request when beginRequest is called, the ForcedValue will automatically be set accordingly. For example, if you had the following setting in your web.xml: <contex-param> <param-name>oracle.adf.view.rich.automation.view.FORCE_VIEW_ID_PARAM</param-name> <param-value>fvdl</param-value> </contex-param> Then adding fvdl=index.xhtml to the url as a parameter would set the forcedViewId to be index.xhtml. Likewise, putting fvdl= on the URL would restore the normal faces behavior.

Constructor Summary

Constructors

Constructor and Description
SwitchingViewDeclarationLanguageConfigurator()

Method Summary

Methods

Modifier and Type	Method and Description
void	beginRequest(javax.faces.context.ExternalContext externalContext) Implements the beginRequest functionality.
static String	getForcedViewId(javax.faces.context.ExternalContext ec) Returns the forced viewId value off the current request.
void	init(javax.faces.context.ExternalContext externalContext) Performs init tasks.
static void	setForcedViewId(javax.faces.context.ExternalContext ec, String value) Sets the forced viewId.

Methods inherited from class org.apache.myfaces.trinidad.config.Configurator

destroy, disableConfiguratorServices, endRequest, getExternalContext, isConfiguratorServiceDisabled, reloadSkins

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchingViewDeclarationLanguageConfigurator

public SwitchingViewDeclarationLanguageConfigurator()

Method Detail

getForcedViewId

public static String getForcedViewId(javax.faces.context.ExternalContext ec)

Returns the forced viewId value off the current request. If the value was set durring the current request, the change in the forcedViewId will not be made available until the next request. Null indicates that no forced viewId has been set.

setForcedViewId

public static void setForcedViewId(javax.faces.context.ExternalContext ec,
                   String value)

Sets the forced viewId. It is important to note that the viewId will not be forced until the next request. This was done to prevent changing of the VDL mid-request. Once the forced viewId is set, it will remain set for the entire session unless changed. If the value passed in is null, then the VDL will be set as normal.

Parameters:

value -

beginRequest

public void beginRequest(javax.faces.context.ExternalContext externalContext)

Implements the beginRequest functionality.

Overrides:

beginRequest in class org.apache.myfaces.trinidad.config.Configurator

Parameters:

externalContext -

init

public void init(javax.faces.context.ExternalContext externalContext)

Performs init tasks. This includes reading the ContextParameter

Overrides:

init in class org.apache.myfaces.trinidad.config.Configurator

Parameters:

externalContext -