Package org.springframework.integration.dsl

Class IntegrationComponentSpec<S extends IntegrationComponentSpec<S,T>,T>

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,T>

Type Parameters:

S - the target IntegrationComponentSpec implementation type.

T - the target type.

All Implemented Interfaces:

DisposableBean, FactoryBean<T>, InitializingBean, Lifecycle, Phased, SmartLifecycle

Direct Known Subclasses:

AbstractConnectionFactorySpec, BroadcastPublishSubscribeSpec, EndpointSpec, JmsDestinationAccessorSpec, JmsOutboundGatewaySpec.ReplyContainerSpec, KafkaMessageListenerContainerSpec, KafkaTemplateSpec, MessageChannelSpec, MessageHandlerSpec, MessageListenerContainerSpec, MessageProcessorSpec, MessageProducerSpec, MessageSourceSpec, MessagingGatewaySpec, PollerSpec, WireTapSpec

@IntegrationDsl
public abstract class IntegrationComponentSpec<S extends IntegrationComponentSpec<S,T>,T>
extends Object
implements FactoryBean<T>, InitializingBean, DisposableBean, SmartLifecycle

The common Builder abstraction. If used as a bean definition, must be treated as an FactoryBean, therefore its getObject() method must not be called in the target configuration.

Since:

5.0

Author:

Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
protected final Log	logger
protected static final SpelExpressionParser	PARSER
protected T	target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
IntegrationComponentSpec()

Method Summary

Modifier and Type	Method	Description
protected final S	_this()
void	afterPropertiesSet()
void	destroy()
protected T	doGet()
T	get()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1 with no-op for end-user: the getObject() is called by the framework at the appropriate phase.
final String	getId()
T	getObject()	!!! This method must not be called from the target configuration !!!
Class<?>	getObjectType()
int	getPhase()
protected S	id(String idToSet)	Configure the component identifier.
boolean	isAutoStartup()
boolean	isRunning()
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Field Details

PARSER

protected static final SpelExpressionParser PARSER

logger

protected final Log logger

target

protected volatile T target

Constructor Details

IntegrationComponentSpec

public IntegrationComponentSpec()

Method Details

id

protected S id(@Nullable
 String idToSet)

Configure the component identifier. Used as the beanName to register the bean in the application context for this component.

Parameters:

idToSet - the id.

Returns:

the spec.

getId

@Nullable
public final String getId()

get

@Deprecated(since="6.1",
            forRemoval=true)
public T get()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1 with no-op for end-user: the getObject() is called by the framework at the appropriate phase.

Returns:

the configured component.

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<S extends IntegrationComponentSpec<S,T>>

getObject

@NonNull
public T getObject()

!!! This method must not be called from the target configuration !!!

Specified by:

getObject in interface FactoryBean<S extends IntegrationComponentSpec<S,T>>

Returns:

the object backed by this factory bean.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface SmartLifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

_this

protected final S _this()

doGet

protected T doGet()