ConsumerEndpointFactoryBean (spring-integration-core 5.1.4.RELEASE API)

java.lang.Object
- org.springframework.integration.config.ConsumerEndpointFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<AbstractEndpoint>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
```
public class ConsumerEndpointFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<AbstractEndpoint>, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.SmartLifecycle, org.springframework.beans.factory.DisposableBean
```
The FactoryBean implementation for AbstractEndpoint population. Controls all the necessary properties and lifecycle. According the provided MessageChannel implementation populates a PollingConsumer for the PollableChannel, an EventDrivenConsumer for the SubscribableChannel and ReactiveStreamsConsumer for all other channel implementations.

Field Summary
- Fields inherited from interface org.springframework.context.SmartLifecycle
  DEFAULT_PHASE

Constructor Summary

Constructors
Constructor and Description

ConsumerEndpointFactoryBean()

Constructors
Constructor and Description
`ConsumerEndpointFactoryBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`void`	`destroy()`
`AbstractEndpoint`	`getObject()`
`java.lang.Class<?>`	`getObjectType()`
`int`	`getPhase()`
`boolean`	`isAutoStartup()`
`boolean`	`isRunning()`
`boolean`	`isSingleton()`
`void`	`setAdviceChain(java.util.List<org.aopalliance.aop.Advice> adviceChain)`
`void`	`setAutoStartup(java.lang.Boolean autoStartup)`
`void`	`setBeanClassLoader(java.lang.ClassLoader classLoader)`
`void`	`setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)`
`void`	`setBeanName(java.lang.String beanName)`
`void`	`setChannelResolver(org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel> channelResolver)` Specify the `DestinationResolver` strategy to use.
`void`	`setHandler(org.springframework.messaging.MessageHandler handler)`
`void`	`setInputChannel(org.springframework.messaging.MessageChannel inputChannel)`
`void`	`setInputChannelName(java.lang.String inputChannelName)`
`void`	`setPhase(int phase)`
`void`	`setPollerMetadata(PollerMetadata pollerMetadata)`
`void`	`setRole(java.lang.String role)`
`void`	`setTaskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)`
`void`	`start()`
`void`	`stop()`
`void`	`stop(java.lang.Runnable callback)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConsumerEndpointFactoryBean
```
public ConsumerEndpointFactoryBean()
```
- Method Detail
  - setHandler
```
public void setHandler(org.springframework.messaging.MessageHandler handler)
```
  - setInputChannel
```
public void setInputChannel(org.springframework.messaging.MessageChannel inputChannel)
```
  - setInputChannelName
```
public void setInputChannelName(java.lang.String inputChannelName)
```
  - setPollerMetadata
```
public void setPollerMetadata(PollerMetadata pollerMetadata)
```
  - setChannelResolver
```
public void setChannelResolver(org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel> channelResolver)
```
    Specify the DestinationResolver strategy to use. The default is a BeanFactoryChannelResolver.
    
    Parameters:
    
    channelResolver - The channel resolver.
    
    Since:
    
    4.1.3
  - setBeanClassLoader
```
public void setBeanClassLoader(java.lang.ClassLoader classLoader)
```
    Specified by:
    
    setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware
  - setAutoStartup
```
public void setAutoStartup(java.lang.Boolean autoStartup)
```
  - setPhase
```
public void setPhase(int phase)
```
  - setRole
```
public void setRole(java.lang.String role)
```
  - setBeanName
```
public void setBeanName(java.lang.String beanName)
```
    Specified by:
    
    setBeanName in interface org.springframework.beans.factory.BeanNameAware
  - setBeanFactory
```
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
```
    Specified by:
    
    setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware
  - setAdviceChain
```
public void setAdviceChain(java.util.List<org.aopalliance.aop.Advice> adviceChain)
```
  - setTaskScheduler
```
public void setTaskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler)
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws java.lang.Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    java.lang.Exception
  - isSingleton
```
public boolean isSingleton()
```
    Specified by:
    
    isSingleton in interface org.springframework.beans.factory.FactoryBean<AbstractEndpoint>
  - getObject
```
public AbstractEndpoint getObject()
                           throws java.lang.Exception
```
    Specified by:
    
    getObject in interface org.springframework.beans.factory.FactoryBean<AbstractEndpoint>
    
    Throws:
    
    java.lang.Exception
  - getObjectType
```
public java.lang.Class<?> getObjectType()
```
    Specified by:
    
    getObjectType in interface org.springframework.beans.factory.FactoryBean<AbstractEndpoint>
  - isAutoStartup
```
public boolean isAutoStartup()
```
    Specified by:
    
    isAutoStartup in interface org.springframework.context.SmartLifecycle
  - getPhase
```
public int getPhase()
```
    Specified by:
    
    getPhase in interface org.springframework.context.Phased
    
    Specified by:
    
    getPhase in interface org.springframework.context.SmartLifecycle
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface org.springframework.context.Lifecycle
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.springframework.context.Lifecycle
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.springframework.context.Lifecycle
  - stop
```
public void stop(java.lang.Runnable callback)
```
    Specified by:
    
    stop in interface org.springframework.context.SmartLifecycle
  - destroy
```
public void destroy()
             throws java.lang.Exception
```
    Specified by:
    
    destroy in interface org.springframework.beans.factory.DisposableBean
    
    Throws:
    
    java.lang.Exception

Class ConsumerEndpointFactoryBean

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsumerEndpointFactoryBean

Method Detail

setHandler

setInputChannel

setInputChannelName

setPollerMetadata

setChannelResolver

setBeanClassLoader

setAutoStartup

setPhase

setRole

setBeanName

setBeanFactory

setAdviceChain

setTaskScheduler

afterPropertiesSet

isSingleton

getObject

getObjectType

isAutoStartup

getPhase

isRunning

start

stop

stop

destroy