All Known Implementing Classes:: AbstractBeanTest, AbstractComponentRendererTest, AbstractComponentTest, AbstractConverterTest, AbstractPropertyAwareFacesTest, AbstractRendererTestBase, AbstractSanitizingConverterTest, AbstractUiComponentTest, AbstractValidatorTest, JsfEnabledTestEnvironment

public interface JsfEnvironmentConsumer

Simple interface to be used in context of JsfSetupExtension. It provides an interface for injecting the configured JsfEnvironmentHolder. It is needed, when the test needs to access either an JsfTestContextConfigurator like ComponentConfigDecorator or RequestConfigDecorator or a JSF-Object like FacesContext or Application programmatically. The typical usage:

 
    @Setter
    @Getter
    private JsfEnvironmentHolder environmentHolder;

The actual delegation is implemented using default implementations within this interface, see the unit-test:

 
@EnableJsfEnvironment
@JsfTestConfiguration(BasicApplicationConfiguration.class)
class JsfSetupExtensionTest implements JsfEnvironmentConsumer {

    @Setter
    @Getter
    private JsfEnvironmentHolder environmentHolder;

    @Test
    void shouldBootstrapJsf() {
        assertNotNull(environmentHolder);
        assertNotNull(getApplication());
        assertNotNull(getApplicationConfigDecorator());
        assertNotNull(getBeanConfigDecorator());
        assertNotNull(getComponentConfigDecorator());
        assertNotNull(getExternalContext());
        assertNotNull(getFacesContext());
        assertNotNull(getRequestConfigDecorator());
        assertNotNull(getResponse());
    }

    @Test
    void shouldApplyBasicConfiguration() {
        assertEquals(BasicApplicationConfiguration.FIREFOX,
                getExternalContext().getRequestHeaderMap().get(BasicApplicationConfiguration.USER_AGENT));
    }

Author:: Oliver Wolff

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`assertNavigatedWithOutcome(String outcome)`	Asserts whether a navigation was handled by calling `NavigationHandler.handleNavigation(javax.faces.context.FacesContext, String, String)`
`default void`	`assertRedirect(String redirectUrl)`	Asserts whether a navigation was initialized by calling `ExternalContext.redirect(String)`
`default Application`	`getApplication()`
`default ApplicationConfigDecorator`	`getApplicationConfigDecorator()`
`default BeanConfigDecorator`	`getBeanConfigDecorator()`
`default ComponentConfigDecorator`	`getComponentConfigDecorator()`
`JsfEnvironmentHolder`	`getEnvironmentHolder()`
`default ExternalContext`	`getExternalContext()`
`default FacesContext`	`getFacesContext()`
`default RequestConfigDecorator`	`getRequestConfigDecorator()`
`default org.apache.myfaces.test.mock.MockHttpServletResponse`	`getResponse()`
`void`	`setEnvironmentHolder(JsfEnvironmentHolder holder)`

- Method Detail
  - setEnvironmentHolder
```
void setEnvironmentHolder(JsfEnvironmentHolder holder)
```
    Parameters:
    
    holder - to be set, is never null. Will be called from TestInstancePostProcessor.postProcessTestInstance(Object, org.junit.jupiter.api.extension.ExtensionContext)
  - getEnvironmentHolder
```
JsfEnvironmentHolder getEnvironmentHolder()
```
    Returns:
    
    holder set by setEnvironmentHolder(JsfEnvironmentHolder)
  - getComponentConfigDecorator
```
default ComponentConfigDecorator getComponentConfigDecorator()
```
    Returns:
    
    an ComponentConfigDecorator for the contained JsfEnvironmentHolder
  - getBeanConfigDecorator
```
default BeanConfigDecorator getBeanConfigDecorator()
```
    Returns:
    
    an BeanConfigDecorator for the contained JsfEnvironmentHolder
  - getApplicationConfigDecorator
```
default ApplicationConfigDecorator getApplicationConfigDecorator()
```
    Returns:
    
    an ApplicationConfigDecorator for the contained JsfEnvironmentHolder
  - getRequestConfigDecorator
```
default RequestConfigDecorator getRequestConfigDecorator()
```
    Returns:
    
    an ApplicationConfigDecorator for the contained JsfEnvironmentHolder
  - getFacesContext
```
default FacesContext getFacesContext()
```
    Returns:
    
    an FacesContext for the contained JsfEnvironmentHolder
  - getApplication
```
default Application getApplication()
```
    Returns:
    
    an Application for the contained JsfEnvironmentHolder
  - getExternalContext
```
default ExternalContext getExternalContext()
```
    Returns:
    
    an ExternalContext for the contained JsfEnvironmentHolder
  - getResponse
```
default org.apache.myfaces.test.mock.MockHttpServletResponse getResponse()
```
    Returns:
    
    an MockHttpServletResponse for the contained JsfEnvironmentHolder
  - assertNavigatedWithOutcome
```
default void assertNavigatedWithOutcome(String outcome)
```
    Asserts whether a navigation was handled by calling NavigationHandler.handleNavigation(javax.faces.context.FacesContext, String, String)
    
    Parameters:
    
    outcome - must not be null
  - assertRedirect
```
default void assertRedirect(String redirectUrl)
```
    Asserts whether a navigation was initialized by calling ExternalContext.redirect(String)
    
    Parameters:
    
    redirectUrl - must not be null

Interface JsfEnvironmentConsumer

Method Summary

Method Detail

setEnvironmentHolder

getEnvironmentHolder

getComponentConfigDecorator

getBeanConfigDecorator

getApplicationConfigDecorator

getRequestConfigDecorator

getFacesContext

getApplication

getExternalContext

getResponse

assertNavigatedWithOutcome

assertRedirect