Class WebMergedContextConfiguration

java.lang.Object

org.springframework.test.context.MergedContextConfiguration

org.springframework.test.context.web.WebMergedContextConfiguration

All Implemented Interfaces:

Serializable

public class WebMergedContextConfiguration
extends MergedContextConfiguration

WebMergedContextConfiguration encapsulates the merged context configuration declared on a test class and all of its superclasses and enclosing classes via @ContextConfiguration, @WebAppConfiguration, @ActiveProfiles, and @TestPropertySource.

WebMergedContextConfiguration extends the contract of MergedContextConfiguration by adding support for the resource base path configured via @WebAppConfiguration. This allows the ContextCache to properly cache the corresponding WebApplicationContext that was loaded using properties of this WebMergedContextConfiguration.

Since:

3.2

Author:

Sam Brannen

See Also:

• WebAppConfiguration
• MergedContextConfiguration
• ContextConfiguration
• ActiveProfiles
• ContextConfigurationAttributes
• SmartContextLoader.loadContext(MergedContextConfiguration)
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
WebMergedContextConfiguration(Class<?> testClass, String @Nullable [] locations, Class<?> @Nullable [] classes, @Nullable Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String @Nullable [] activeProfiles, String @Nullable [] propertySourceLocations, String @Nullable [] propertySourceProperties, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, @Nullable MergedContextConfiguration parent)	Deprecated. since 6.1 in favor of WebMergedContextConfiguration(Class, String[], Class[], Set, String[], List, String[], Set, String, ContextLoader, CacheAwareContextLoaderDelegate, MergedContextConfiguration)
WebMergedContextConfiguration(Class<?> testClass, String @Nullable [] locations, Class<?> @Nullable [] classes, @Nullable Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String @Nullable [] activeProfiles, String @Nullable [] propertySourceLocations, String @Nullable [] propertySourceProperties, @Nullable Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, @Nullable MergedContextConfiguration parent)	Deprecated. since 6.1 in favor of WebMergedContextConfiguration(Class, String[], Class[], Set, String[], List, String[], Set, String, ContextLoader, CacheAwareContextLoaderDelegate, MergedContextConfiguration)
WebMergedContextConfiguration(Class<?> testClass, String @Nullable [] locations, Class<?> @Nullable [] classes, @Nullable Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses, String @Nullable [] activeProfiles, List<PropertySourceDescriptor> propertySourceDescriptors, String @Nullable [] propertySourceProperties, @Nullable Set<ContextCustomizer> contextCustomizers, String resourceBasePath, ContextLoader contextLoader, CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate, @Nullable MergedContextConfiguration parent)	Create a new WebMergedContextConfiguration instance for the supplied parameters.
WebMergedContextConfiguration(MergedContextConfiguration mergedConfig, String resourceBasePath)	Create a new WebMergedContextConfiguration instance by copying all properties from the supplied MergedContextConfiguration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)	Determine if the supplied object is equal to this WebMergedContextConfiguration instance by comparing both objects' locations, annotated classes, context initializer classes, active profiles, resource base paths, property source descriptors, property source properties, context customizers, parents, and the fully qualified names of their ContextLoaders.
String	getResourceBasePath()	Get the resource path to the root directory of the web application for the test class, configured via @WebAppConfiguration.
int	hashCode()	Generate a unique hash code for all properties of this WebMergedContextConfiguration excluding the test class.
String	toString()	Provide a String representation of the test class, locations, annotated classes, context initializer classes, active profiles, property source descriptors, property source properties, context customizers, resource base path, the name of the ContextLoader, and the parent configuration.

Methods inherited from class MergedContextConfiguration

getActiveProfiles, getClasses, getContextCustomizers, getContextInitializerClasses, getContextLoader, getLocations, getParent, getParentApplicationContext, getPropertySourceDescriptors, getPropertySourceLocations, getPropertySourceProperties, getTestClass, hasClasses, hasLocations, hasResources, nullSafeClassName, processStrings

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WebMergedContextConfiguration

public WebMergedContextConfiguration(MergedContextConfiguration mergedConfig,
 String resourceBasePath)

Create a new WebMergedContextConfiguration instance by copying all properties from the supplied MergedContextConfiguration.

If an empty value is supplied for the resourceBasePath an empty string will be used.

Parameters:

resourceBasePath - the resource path to the root directory of the web application

Since:

4.1

WebMergedContextConfiguration

@Deprecated(since="6.1")
public WebMergedContextConfiguration(Class<?> testClass,
 String @Nullable [] locations,
 Class<?> @Nullable [] classes,
 @Nullable Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
 String @Nullable [] activeProfiles,
 String @Nullable [] propertySourceLocations,
 String @Nullable [] propertySourceProperties,
 String resourceBasePath,
 ContextLoader contextLoader,
 CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
 @Nullable MergedContextConfiguration parent)

Deprecated.

since 6.1 in favor of WebMergedContextConfiguration(Class, String[], Class[], Set, String[], List, String[], Set, String, ContextLoader, CacheAwareContextLoaderDelegate, MergedContextConfiguration)

Create a new WebMergedContextConfiguration instance for the supplied parameters.

If a null value is supplied for locations, classes, activeProfiles, propertySourceLocations, or propertySourceProperties an empty array will be stored instead. If a null value is supplied for the contextInitializerClasses an empty set will be stored instead. If an empty value is supplied for the resourceBasePath an empty string will be used. Furthermore, active profiles will be sorted, and duplicate profiles will be removed.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

propertySourceLocations - the merged PropertySource locations

propertySourceProperties - the merged PropertySource properties

resourceBasePath - the resource path to the root directory of the web application

contextLoader - the resolved ContextLoader

cacheAwareContextLoaderDelegate - a cache-aware context loader delegate with which to retrieve the parent context

parent - the parent configuration or null if there is no parent

Since:

4.1

WebMergedContextConfiguration

@Deprecated(since="6.1")
public WebMergedContextConfiguration(Class<?> testClass,
 String @Nullable [] locations,
 Class<?> @Nullable [] classes,
 @Nullable Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
 String @Nullable [] activeProfiles,
 String @Nullable [] propertySourceLocations,
 String @Nullable [] propertySourceProperties,
 @Nullable Set<ContextCustomizer> contextCustomizers,
 String resourceBasePath,
 ContextLoader contextLoader,
 CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
 @Nullable MergedContextConfiguration parent)

Deprecated.

since 6.1 in favor of WebMergedContextConfiguration(Class, String[], Class[], Set, String[], List, String[], Set, String, ContextLoader, CacheAwareContextLoaderDelegate, MergedContextConfiguration)

Create a new WebMergedContextConfiguration instance for the supplied parameters.

If a null value is supplied for locations, classes, activeProfiles, propertySourceLocations, or propertySourceProperties an empty array will be stored instead. If a null value is supplied for contextInitializerClasses or contextCustomizers, an empty set will be stored instead. If an empty value is supplied for the resourceBasePath an empty string will be used. Furthermore, active profiles will be sorted, and duplicate profiles will be removed.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged context resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

propertySourceLocations - the merged PropertySource locations

propertySourceProperties - the merged PropertySource properties

contextCustomizers - the context customizers

resourceBasePath - the resource path to the root directory of the web application

contextLoader - the resolved ContextLoader

cacheAwareContextLoaderDelegate - a cache-aware context loader delegate with which to retrieve the parent context

parent - the parent configuration or null if there is no parent

Since:

4.3

WebMergedContextConfiguration

public WebMergedContextConfiguration(Class<?> testClass,
 String @Nullable [] locations,
 Class<?> @Nullable [] classes,
 @Nullable Set<Class<? extends ApplicationContextInitializer<?>>> contextInitializerClasses,
 String @Nullable [] activeProfiles,
 List<PropertySourceDescriptor> propertySourceDescriptors,
 String @Nullable [] propertySourceProperties,
 @Nullable Set<ContextCustomizer> contextCustomizers,
 String resourceBasePath,
 ContextLoader contextLoader,
 CacheAwareContextLoaderDelegate cacheAwareContextLoaderDelegate,
 @Nullable MergedContextConfiguration parent)

Create a new WebMergedContextConfiguration instance for the supplied parameters.

If a null value is supplied for locations, classes, activeProfiles, or propertySourceProperties an empty array will be stored instead. If a null value is supplied for contextInitializerClasses or contextCustomizers, an empty set will be stored instead. Furthermore, active profiles will be sorted, and duplicate profiles will be removed.

Parameters:

testClass - the test class for which the configuration was merged

locations - the merged context resource locations

classes - the merged annotated classes

contextInitializerClasses - the merged context initializer classes

activeProfiles - the merged active bean definition profiles

propertySourceDescriptors - the merged property source descriptors

propertySourceProperties - the merged inlined properties

contextCustomizers - the context customizers

resourceBasePath - the resource path to the root directory of the web application

contextLoader - the resolved ContextLoader

cacheAwareContextLoaderDelegate - a cache-aware context loader delegate with which to retrieve the parent ApplicationContext

parent - the parent configuration or null if there is no parent

Since:

6.1

Method Details

getResourceBasePath

public String getResourceBasePath()

Get the resource path to the root directory of the web application for the test class, configured via @WebAppConfiguration.

See Also:

• WebAppConfiguration

equals

public boolean equals(@Nullable Object other)

Determine if the supplied object is equal to this WebMergedContextConfiguration instance by comparing both objects' locations, annotated classes, context initializer classes, active profiles, resource base paths, property source descriptors, property source properties, context customizers, parents, and the fully qualified names of their ContextLoaders.

Overrides:

equals in class MergedContextConfiguration

hashCode

public int hashCode()

Generate a unique hash code for all properties of this WebMergedContextConfiguration excluding the test class.

Overrides:

hashCode in class MergedContextConfiguration

toString

public String toString()

Provide a String representation of the test class, locations, annotated classes, context initializer classes, active profiles, property source descriptors, property source properties, context customizers, resource base path, the name of the ContextLoader, and the parent configuration.

Overrides:

toString in class MergedContextConfiguration