Class AbstractHttpServiceRegistrar

java.lang.Object

org.springframework.web.service.registry.AbstractHttpServiceRegistrar

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, ImportBeanDefinitionRegistrar, EnvironmentAware, ResourceLoaderAware

public abstract class AbstractHttpServiceRegistrar
extends Object
implements ImportBeanDefinitionRegistrar, EnvironmentAware, ResourceLoaderAware, BeanFactoryAware, BeanClassLoaderAware

Abstract registrar class that imports:

• Bean definitions for HTTP Service interface client proxies organized by HttpServiceGroup.
• Bean definition for an HttpServiceProxyRegistryFactoryBean that initializes the infrastructure for each group, RestClient or WebClient and a proxy factory, necessary to create the proxies.

Subclasses determine the HTTP Service types (interfaces with @HttpExchange methods) to register by implementing registerHttpServices(AbstractHttpServiceRegistrar.GroupRegistry, AnnotationMetadata).

There is built-in support for declaring HTTP Services through ImportHttpServices annotations. It is also possible to perform registrations directly, sourced in another way, by extending this class.

It is possible to import multiple instances of this registrar type. Subsequent imports update the existing registry FactoryBean definition, and likewise merge HTTP Service group definitions.

An application can autowire HTTP Service proxy beans, or autowire the HttpServiceProxyRegistry from which to obtain proxies.

Since:

7.0

Author:

Rossen Stoyanchev, Phillip Webb, Olga Maciaszek-Sharma, Stephane Nicoll

See Also:

• ImportHttpServices
• HttpServiceProxyRegistryFactoryBean

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractHttpServiceRegistrar.GroupRegistry	Registry API to allow subclasses to register HTTP Services.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HTTP_SERVICE_PROXY_REGISTRY_BEAN_NAME	The bean name of the HttpServiceProxyRegistry.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpServiceRegistrar()

Method Summary

Modifier and Type	Method	Description
final void	registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry beanRegistry)	Register bean definitions as necessary based on the given annotation metadata of the importing @Configuration class.
final void	registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry, BeanNameGenerator generator)	Register bean definitions as necessary based on the given annotation metadata of the importing @Configuration class.
protected abstract void	registerHttpServices(AbstractHttpServiceRegistrar.GroupRegistry registry, AnnotationMetadata importingClassMetadata)	This method is called before any bean definition registrations are made.
void	setBeanClassLoader(ClassLoader beanClassLoader)	Callback that supplies the bean class loader to a bean instance.
void	setBeanFactory(BeanFactory beanFactory)	Callback that supplies the owning factory to a bean instance.
void	setDefaultClientType(HttpServiceGroup.ClientType defaultClientType)	Set the client type to use when an HTTP Service group's client type remains HttpServiceGroup.ClientType.UNSPECIFIED.
void	setEnvironment(Environment environment)	Set the Environment that this component runs in.
void	setResourceLoader(ResourceLoader resourceLoader)	Set the ResourceLoader that this object runs in.

Methods inherited from class Object

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

Field Details

HTTP_SERVICE_PROXY_REGISTRY_BEAN_NAME

public static final String HTTP_SERVICE_PROXY_REGISTRY_BEAN_NAME

The bean name of the HttpServiceProxyRegistry.

See Also:

• Constant Field Values

Constructor Details

AbstractHttpServiceRegistrar

public AbstractHttpServiceRegistrar()

Method Details

setDefaultClientType

public void setDefaultClientType(HttpServiceGroup.ClientType defaultClientType)

Set the client type to use when an HTTP Service group's client type remains HttpServiceGroup.ClientType.UNSPECIFIED.

By default, when this property is not set, then REST_CLIENT is used for any HTTP Service group whose client type remains unspecified.

setEnvironment

public void setEnvironment(Environment environment)

Description copied from interface: EnvironmentAware

Set the Environment that this component runs in.

Specified by:

setEnvironment in interface EnvironmentAware

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Description copied from interface: ResourceLoaderAware

Set the ResourceLoader that this object runs in.

This might be a ResourcePatternResolver, which can be checked through instanceof ResourcePatternResolver. See also the ResourcePatternUtils.getResourcePatternResolver method.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Specified by:

setResourceLoader in interface ResourceLoaderAware

Parameters:

resourceLoader - the ResourceLoader object to be used by this object

See Also:

• ResourcePatternResolver
• ResourcePatternUtils.getResourcePatternResolver(ResourceLoader)

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Description copied from interface: BeanFactoryAware

Callback that supplies the owning factory to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - owning BeanFactory (never null). The bean can immediately call methods on the factory.

Throws:

BeansException - in case of initialization errors

See Also:

• BeanInitializationException

setBeanClassLoader

public void setBeanClassLoader(ClassLoader beanClassLoader)

Description copied from interface: BeanClassLoaderAware

Callback that supplies the bean class loader to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean.afterPropertiesSet() method or a custom init-method.

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

Parameters:

beanClassLoader - the owning class loader

registerBeanDefinitions

public final void registerBeanDefinitions(AnnotationMetadata metadata,
 BeanDefinitionRegistry registry,
 BeanNameGenerator generator)

Description copied from interface: ImportBeanDefinitionRegistrar

Register bean definitions as necessary based on the given annotation metadata of the importing @Configuration class.

Note that BeanDefinitionRegistryPostProcessor types may not be registered here, due to lifecycle constraints related to @Configuration class processing.

The default implementation delegates to ImportBeanDefinitionRegistrar.registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry).

Specified by:

registerBeanDefinitions in interface ImportBeanDefinitionRegistrar

Parameters:

metadata - annotation metadata of the importing class

registry - current bean definition registry

generator - the bean name generator strategy for imported beans: ConfigurationClassPostProcessor.IMPORT_BEAN_NAME_GENERATOR by default, or a user-provided one if ConfigurationClassPostProcessor.setBeanNameGenerator(BeanNameGenerator) has been set. In the latter case, the passed-in strategy will be the same used for component scanning in the containing application context (otherwise, the default component-scan naming strategy is AnnotationBeanNameGenerator.INSTANCE).

See Also:

• ConfigurationClassPostProcessor.IMPORT_BEAN_NAME_GENERATOR
• ConfigurationClassPostProcessor.setBeanNameGenerator(BeanNameGenerator)

registerBeanDefinitions

public final void registerBeanDefinitions(AnnotationMetadata metadata,
 BeanDefinitionRegistry beanRegistry)

Description copied from interface: ImportBeanDefinitionRegistrar

Register bean definitions as necessary based on the given annotation metadata of the importing @Configuration class.

Note that BeanDefinitionRegistryPostProcessor types may not be registered here, due to lifecycle constraints related to @Configuration class processing.

The default implementation is empty.

Specified by:

registerBeanDefinitions in interface ImportBeanDefinitionRegistrar

Parameters:

metadata - annotation metadata of the importing class

beanRegistry - current bean definition registry

registerHttpServices

protected abstract void registerHttpServices(AbstractHttpServiceRegistrar.GroupRegistry registry,
 AnnotationMetadata importingClassMetadata)

This method is called before any bean definition registrations are made. Subclasses must implement it to register the HTTP Services for which bean definitions for which proxies need to be created.

Parameters:

registry - to perform HTTP Service registrations with

importingClassMetadata - annotation metadata of the importing class