org.springframework.cloud.servicebroker.autoconfigure.web.servlet

Class ApiVersionWebMvcAutoConfiguration

java.lang.Object

org.springframework.cloud.servicebroker.autoconfigure.web.servlet.ApiVersionWebMvcAutoConfiguration

@Configuration
 @ConditionalOnWebApplication(type=SERVLET)
 @ConditionalOnBean(value=ServiceInstanceService.class)
 @ConditionalOnProperty(prefix="spring.cloud.openservicebroker",
                       name="api-version-check-enabled",
                       havingValue="true",
                       matchIfMissing=true)
 @AutoConfigureAfter(value=org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration.class)
 @EnableConfigurationProperties(value=ServiceBrokerProperties.class)
public class ApiVersionWebMvcAutoConfiguration
extends Object

Auto-configuration for the service broker API validation. Configures support for any service broker API version if a version is not specifically configured.

API validation may be disabled completely by setting the following configuration property:

 spring.cloud.openservicebroker.api-version-check-enabled = false
 

Author:

Benjamin Ihrig, Scott Frederick, Roy Clarkson

Constructor Summary

Constructors

Constructor and Description
ApiVersionWebMvcAutoConfiguration(ServiceBrokerProperties serviceBrokerProperties) Construct a new ApiVersionWebMvcAutoConfiguration

Method Summary

Modifier and Type	Method and Description
BrokerApiVersion	serviceBrokerApiVersion() Conditionally provides a BrokerApiVersion bean
ApiVersionInterceptor	serviceBrokerApiVersionInterceptor(BrokerApiVersion brokerApiVersion) Provide an ApiVersionInterceptor bean
BrokerApiVersion	serviceBrokerApiVersionProperty() Provides a BrokerApiVersion bean if the 'api-version' property is available in external configuration
ApiVersionWebMvcConfigurerAdapter	serviceBrokerWebMvcConfigurerAdapter(ApiVersionInterceptor apiVersionInterceptor) Provide an ApiVersionWebMvcConfigurerAdapter bean

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiVersionWebMvcAutoConfiguration

public ApiVersionWebMvcAutoConfiguration(ServiceBrokerProperties serviceBrokerProperties)

Construct a new ApiVersionWebMvcAutoConfiguration

Parameters:

serviceBrokerProperties - the service broker properties

Method Detail

serviceBrokerApiVersionProperty

@Bean
 @ConditionalOnMissingBean(value=BrokerApiVersion.class)
 @ConditionalOnProperty(prefix="spring.cloud.openservicebroker",
                       name="api-version")
public BrokerApiVersion serviceBrokerApiVersionProperty()

Provides a BrokerApiVersion bean if the 'api-version' property is available in external configuration

Returns:

the bean

serviceBrokerApiVersion

@Bean
 @ConditionalOnMissingBean(value=BrokerApiVersion.class)
public BrokerApiVersion serviceBrokerApiVersion()

Conditionally provides a BrokerApiVersion bean

Returns:

the bean

serviceBrokerApiVersionInterceptor

@Bean
public ApiVersionInterceptor serviceBrokerApiVersionInterceptor(BrokerApiVersion brokerApiVersion)

Provide an ApiVersionInterceptor bean

Parameters:

brokerApiVersion - the api version

Returns:

the bean

serviceBrokerWebMvcConfigurerAdapter

@Bean
public ApiVersionWebMvcConfigurerAdapter serviceBrokerWebMvcConfigurerAdapter(ApiVersionInterceptor apiVersionInterceptor)

Provide an ApiVersionWebMvcConfigurerAdapter bean

Parameters:

apiVersionInterceptor - the api version interceptor

Returns:

the bean