Annotation Interface WebServiceServerTest
@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Inherited
@BootstrapWith(org.springframework.boot.test.autoconfigure.webservices.server.WebServiceServerTestContextBootstrapper.class)
@ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class)
@OverrideAutoConfiguration(enabled=false)
@TypeExcludeFilters(WebServiceServerTypeExcludeFilter.class)
@AutoConfigureWebServiceServer
@AutoConfigureMockWebServiceClient
@ImportAutoConfiguration
public @interface WebServiceServerTest
Annotation that can be used for a typical Spring web service server test. Can be used
when a test focuses only on Spring WS endpoints.
Using this annotation will disable full auto-configuration and instead apply only
configuration relevant to Web Service server tests (i.e. Endpoint
and
EndpointInterceptor
beans but not @Component
, @Service
or
@Repository
beans).
Typically WebServiceServerTest
is used in combination with
@MockBean
or
@Import
to create any
collaborators required by your Endpoint
beans.
If you are looking to load your full application configuration and use
MockWebServiceClient, you should consider
@SpringBootTest
combined
with @AutoConfigureMockWebServiceClient
rather than this annotation.
- Since:
- 2.6.0
- Author:
- Daniil Razorenov
- See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionClass<?>[]
Specifies the endpoints to test.Class<?>[]
Auto-configuration exclusions that should be applied for this test.A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.A set of include filters which can be used to add otherwise filtered beans to the application context.String[]
Properties in form key=value that should be added to the SpringEnvironment
before the test runs.boolean
Determines if default filtering should be used with@SpringBootApplication
.Class<?>[]
Specifies the endpoints to test.
-
Element Details
-
properties
String[] propertiesProperties in form key=value that should be added to the SpringEnvironment
before the test runs.- Returns:
- the properties to add
- Default:
- {}
-
value
Specifies the endpoints to test. This is an alias ofendpoints()
which can be used for brevity if no other attributes are defined. Seeendpoints()
for details.- Returns:
- the endpoints to test
- See Also:
- Default:
- {}
-
endpoints
Specifies the endpoints to test. May be left blank if all@Endpoint
beans should be added to the application context.- Returns:
- the endpoints to test
- See Also:
- Default:
- {}
-
useDefaultFilters
boolean useDefaultFiltersDetermines if default filtering should be used with@SpringBootApplication
. By default only@Endpoint
(when no explicitcontrollers
are defined) are included.- Returns:
- if default filters should be used
- See Also:
- Default:
- true
-
includeFilters
ComponentScan.Filter[] includeFiltersA set of include filters which can be used to add otherwise filtered beans to the application context.- Returns:
- include filters to apply
- Default:
- {}
-
excludeFilters
ComponentScan.Filter[] excludeFiltersA set of exclude filters which can be used to filter beans that would otherwise be added to the application context.- Returns:
- exclude filters to apply
- Default:
- {}
-
excludeAutoConfiguration
@AliasFor(annotation=ImportAutoConfiguration.class, attribute="exclude") Class<?>[] excludeAutoConfigurationAuto-configuration exclusions that should be applied for this test.- Returns:
- auto-configuration exclusions to apply
- Default:
- {}
-