Package com.foreach.across.test.support

Class AcrossTestWebContextBuilder

java.lang.Object

com.foreach.across.test.support.AcrossTestContextBuilder

com.foreach.across.test.support.AcrossTestWebContextBuilder

public class AcrossTestWebContextBuilder
extends AcrossTestContextBuilder

Builder for creating an AcrossTestWebContext. This builder allows easy configuration of properties and modules to add to an AcrossTestWebContext. Configures a parent WebApplicationContext and adds a MockAcrossServletContext. Note that AcrossWebModule is not automatically added to the created context.

Once build() has been called, the AcrossTestWebContext will be created and the internal AcrossContext bootstrapped.

Since:

1.1.2

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor	Description
AcrossTestWebContextBuilder()

Method Summary

Modifier and Type	Method	Description
AcrossTestWebContextBuilder	additionalModulePackageClasses(Class<?>... classes)	Type-safe alternative for AcrossTestContextBuilder.additionalModulePackages(String...) where the packages of the classes will be added for module scanning.
AcrossTestWebContextBuilder	additionalModulePackages(String... packageNames)	Additional packages that should be scanned for modules if no custom ModuleDependencyResolver is configured.
AcrossTestWebContext	build()	Creates the internal AcrossContext and bootstraps it.
AcrossTestWebContextBuilder	configurer(AcrossContextConfigurer... configurer)	Add one or more AcrossContextConfigurer instances that are to be called after the initial AcrossContext has been created.
protected AcrossConfigurableApplicationContext	createDefaultApplicationContext()
protected AcrossTestWebContext	createTestContext(AcrossConfigurableApplicationContext applicationContext, AcrossContext context)
AcrossTestWebContextBuilder	dataSource(DataSource dataSource)	Set the core across datasource.
AcrossTestWebContextBuilder	developmentMode(boolean developmentMode)
AcrossTestWebContextBuilder	dropFirst(boolean dropFirst)	Should the database be reset before bootstrapping the AcrossContext.
AcrossTestWebContextBuilder	dynamicServletContext(boolean dynamicServletContext)	Should the configured MockAcrossServletContext allow for dynamic registration of servlets and filters.
AcrossTestWebContextBuilder	expose(Class<?>... classesToExpose)	Add one or more types (classes, interfaces, annotations) that should be exposed in this test context.
AcrossTestWebContextBuilder	installerDataSource(DataSource installerDataSource)	Set the installer datasource.
AcrossTestWebContextBuilder	moduleConfigurationPackageClasses(Class<?>... classes)	Type-safe alternative for AcrossTestContextBuilder.moduleConfigurationPackages(String...).
AcrossTestWebContextBuilder	moduleConfigurationPackages(String... packageNames)	Add one or more custom packages that should be scanned for ModuleConfiguration classes.
AcrossTestWebContextBuilder	moduleDependencyResolver(ModuleDependencyResolver moduleDependencyResolver)	Set the ModuleDependencyResolver that should be used for looking up modules by name.
AcrossTestWebContextBuilder	modules(AcrossModule... modules)	Array of AcrossModule instances to add to the context.
AcrossTestWebContextBuilder	modules(String... moduleNames)	Array of AcrossModule names that should be configured.
AcrossTestWebContextBuilder	properties(Map<String,Object> properties)	Add a properties map to the environment of the parent ApplicationContext.
AcrossTestWebContextBuilder	properties(Properties properties)	Add a properties collection to the environment of the parent ApplicationContext.
AcrossTestWebContextBuilder	properties(org.springframework.core.env.PropertySource propertySource)	Add a PropertySource to the environment of the parent ApplicationContext.
AcrossTestWebContextBuilder	property(String key, Object value)	Set a property value on the environment of the parent ApplicationContext.
AcrossTestWebContextBuilder	register(Class<?>... annotatedClasses)	Add one or more annotated classes to the parent ApplicationContext that is attached to the AcrossContext.
AcrossTestWebContextBuilder	useTestDataSource(boolean useTestDataSource)	Should default test datasources be created.

Methods inherited from class com.foreach.across.test.support.AcrossTestContextBuilder

annotatedClasses, configureApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Details

AcrossTestWebContextBuilder

public AcrossTestWebContextBuilder()

Method Details

dynamicServletContext

public AcrossTestWebContextBuilder dynamicServletContext(boolean dynamicServletContext)

Should the configured MockAcrossServletContext allow for dynamic registration of servlets and filters. Default is true.

Parameters:

dynamicServletContext - true if dynamic registration should be allowed

Returns:

self

configurer

public AcrossTestWebContextBuilder configurer(AcrossContextConfigurer... configurer)

Description copied from class: AcrossTestContextBuilder

Add one or more AcrossContextConfigurer instances that are to be called after the initial AcrossContext has been created. Subsequent calls will add additional configurers.

Overrides:

configurer in class AcrossTestContextBuilder

Parameters:

configurer - one or more instances

Returns:

self

property

public AcrossTestWebContextBuilder property(String key,
 Object value)

Description copied from class: AcrossTestContextBuilder

Set a property value on the environment of the parent ApplicationContext.

Overrides:

property in class AcrossTestContextBuilder

Parameters:

key - property key

value - property value

Returns:

self

properties

public AcrossTestWebContextBuilder properties(Properties properties)

Description copied from class: AcrossTestContextBuilder

Add a properties collection to the environment of the parent ApplicationContext.

Overrides:

properties in class AcrossTestContextBuilder

Parameters:

properties - instance

Returns:

self

properties

public AcrossTestWebContextBuilder properties(Map<String,Object> properties)

Description copied from class: AcrossTestContextBuilder

Add a properties map to the environment of the parent ApplicationContext.

Overrides:

properties in class AcrossTestContextBuilder

Parameters:

properties - map

Returns:

self

properties

public AcrossTestWebContextBuilder properties(org.springframework.core.env.PropertySource propertySource)

Description copied from class: AcrossTestContextBuilder

Add a PropertySource to the environment of the parent ApplicationContext.

Overrides:

properties in class AcrossTestContextBuilder

Parameters:

propertySource - instance

Returns:

self

dropFirst

public AcrossTestWebContextBuilder dropFirst(boolean dropFirst)

Description copied from class: AcrossTestContextBuilder

Should the database be reset before bootstrapping the AcrossContext. When true, this adds the ResetDatabaseConfigurer to the parent ApplicationContext. This is the default case.

Overrides:

dropFirst in class AcrossTestContextBuilder

Parameters:

dropFirst - true if datasource tables should be dropped before starting the context

Returns:

self

See Also:

• ResetDatabaseConfigurer

useTestDataSource

public AcrossTestWebContextBuilder useTestDataSource(boolean useTestDataSource)

Description copied from class: AcrossTestContextBuilder

Should default test datasources be created. This will use the datasource specified by the property acrossTest.datasource or create a memory HSQLDB if none is specified.

Using test datasource is the default. This is the equivalent to adding TestDataSourceConfigurer the the parent ApplicationContext.

Overrides:

useTestDataSource in class AcrossTestContextBuilder

Parameters:

useTestDataSource - true if test datasource should be created automatically

Returns:

self

See Also:

• TestDataSourceConfigurer

expose

public AcrossTestWebContextBuilder expose(Class<?>... classesToExpose)

Description copied from class: AcrossTestContextBuilder

Add one or more types (classes, interfaces, annotations) that should be exposed in this test context.

Overrides:

expose in class AcrossTestContextBuilder

Parameters:

classesToExpose - list

Returns:

self

register

public AcrossTestWebContextBuilder register(Class<?>... annotatedClasses)

Description copied from class: AcrossTestContextBuilder

Add one or more annotated classes to the parent ApplicationContext that is attached to the AcrossContext.

Overrides:

register in class AcrossTestContextBuilder

Parameters:

annotatedClasses - list

Returns:

self

dataSource

public AcrossTestWebContextBuilder dataSource(DataSource dataSource)

Description copied from class: AcrossTestContextBuilder

Set the core across datasource. If no separate AcrossTestContextBuilder.installerDataSource(DataSource) is configured, this datasource will also be used for installers. If neither datasource is configured, installers will be disabled.

Overrides:

dataSource in class AcrossTestContextBuilder

Parameters:

dataSource - instance

Returns:

self

installerDataSource

public AcrossTestWebContextBuilder installerDataSource(DataSource installerDataSource)

Description copied from class: AcrossTestContextBuilder

Set the installer datasource.

Overrides:

installerDataSource in class AcrossTestContextBuilder

Parameters:

installerDataSource - instance

Returns:

self

modules

public AcrossTestWebContextBuilder modules(String... moduleNames)

Description copied from class: AcrossTestContextBuilder

Array of AcrossModule names that should be configured. These will be resolved using the configured AcrossTestContextBuilder.moduleDependencyResolver(ModuleDependencyResolver), before any configured module instances and before the AcrossContextConfigurer instances are called. If no ModuleDependencyResolver was set explicitly, the default will be used.

Subsequent calls will add modules.

Overrides:

modules in class AcrossTestContextBuilder

Parameters:

moduleNames - names

Returns:

self

modules

public AcrossTestWebContextBuilder modules(AcrossModule... modules)

Description copied from class: AcrossTestContextBuilder

Array of AcrossModule instances to add to the context. These will be added after the modules added using AcrossTestContextBuilder.modules(String...) have been resolved. Subsequent calls will add modules.

Overrides:

modules in class AcrossTestContextBuilder

Parameters:

modules - collection

Returns:

self

moduleDependencyResolver

public AcrossTestWebContextBuilder moduleDependencyResolver(ModuleDependencyResolver moduleDependencyResolver)

Description copied from class: AcrossTestContextBuilder

Set the ModuleDependencyResolver that should be used for looking up modules by name. If none is set, a default ClassPathScanningModuleDependencyResolver will be used.

Overrides:

moduleDependencyResolver in class AcrossTestContextBuilder

Parameters:

moduleDependencyResolver - instance

Returns:

self

See Also:

• ClassPathScanningModuleDependencyResolver

additionalModulePackages

public AcrossTestWebContextBuilder additionalModulePackages(String... packageNames)

Description copied from class: AcrossTestContextBuilder

Additional packages that should be scanned for modules if no custom ModuleDependencyResolver is configured. In case of a custom resolver, this setting will be ignored.

The default AcrossContextBuilder.STANDARD_MODULES_PACKAGE will always be added as the first one. If you do not want this, you should set a custom ModuleDependencyResolver using AcrossTestContextBuilder.moduleDependencyResolver(ModuleDependencyResolver).

Subsequent calls will add additional packages.

Overrides:

additionalModulePackages in class AcrossTestContextBuilder

Parameters:

packageNames - list

Returns:

self

See Also:

• AcrossTestContextBuilder.moduleDependencyResolver(ModuleDependencyResolver)

additionalModulePackageClasses

public AcrossTestWebContextBuilder additionalModulePackageClasses(Class<?>... classes)

Description copied from class: AcrossTestContextBuilder

Type-safe alternative for AcrossTestContextBuilder.additionalModulePackages(String...) where the packages of the classes will be added for module scanning. In case of a custom resolver, this setting will be ignored.

The default AcrossContextBuilder.STANDARD_MODULES_PACKAGE will always be added as the first one. If you do not want this, you should set a custom ModuleDependencyResolver using AcrossTestContextBuilder.moduleDependencyResolver(ModuleDependencyResolver).

Subsequent calls will add additional packages.

Overrides:

additionalModulePackageClasses in class AcrossTestContextBuilder

Parameters:

classes - list

Returns:

self

moduleConfigurationPackages

public AcrossTestWebContextBuilder moduleConfigurationPackages(String... packageNames)

Description copied from class: AcrossTestContextBuilder

Add one or more custom packages that should be scanned for ModuleConfiguration classes. Subsequent calls will add additional packages.

Overrides:

moduleConfigurationPackages in class AcrossTestContextBuilder

Parameters:

packageNames - list

Returns:

self

moduleConfigurationPackageClasses

public AcrossTestWebContextBuilder moduleConfigurationPackageClasses(Class<?>... classes)

Description copied from class: AcrossTestContextBuilder

Type-safe alternative for AcrossTestContextBuilder.moduleConfigurationPackages(String...).

Overrides:

moduleConfigurationPackageClasses in class AcrossTestContextBuilder

Parameters:

classes - list

Returns:

self

developmentMode

public AcrossTestWebContextBuilder developmentMode(boolean developmentMode)

Overrides:

developmentMode in class AcrossTestContextBuilder

Parameters:

developmentMode - true if development mode should be active on the created context

Returns:

self

createDefaultApplicationContext

protected AcrossConfigurableApplicationContext createDefaultApplicationContext()

Overrides:

createDefaultApplicationContext in class AcrossTestContextBuilder

build

public AcrossTestWebContext build()

Description copied from class: AcrossTestContextBuilder

Creates the internal AcrossContext and bootstraps it. Then wraps it in a AcrossTestContext instance that gives easy access to querying functionality.

Overrides:

build in class AcrossTestContextBuilder

Returns:

queryable context containing the bootstrapped AcrossContext

createTestContext

protected AcrossTestWebContext createTestContext(AcrossConfigurableApplicationContext applicationContext,
 AcrossContext context)

Overrides:

createTestContext in class AcrossTestContextBuilder